# Neon CLI Client
This is a lightly modified client from [mycroft-core](https://github.com/MycroftAI/mycroft-core/tree/dev/mycroft/client/text).
The CLI can be accessed from a terminal via `neon-cli`.
## CLI Usage
By default, the CLI will use default parameters to connect to a Neon/Mycroft/OVOS
Core instance running on the local host. The following arguments may be passed to
override defaults. This information is also accessible via `neon-cli --help`.
### `--host 0.0.0.0`
The default `0.0.0.0` may be replaced with a different IP address if connecting
to a remote core instance. Note that the messagebus carries unencrypted data, so
enabling remote access is not generally recommended
### `--port 8181`
The default `8181` may be replaced with a different port if the messagebus service
was configured to use a non-default port.
### `--lang en-us`
The language of CLI inputs and expected responses can be set by passing a BCP-47
language code here.
### `--logs-dir ~/.local/state/neon/`
The default log directory is read from configuration, but it may be overridden
here. This is commonly set for Docker connections, where the log path on the host
is not configured for the CLI client.
### `--simple`
This flag will enable a simple text-based CLI showing only inputs and responses.
This can be useful if the default CLI doesn't display properly in a terminal.
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon_cli",
"name": "neon-cli-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/46/e8/e8bbdce6adf1c13800d8e4bc087869f26246c16bc856aa7c584962c220d1/neon_cli_client-0.3.0.tar.gz",
"platform": null,
"description": "# Neon CLI Client\nThis is a lightly modified client from [mycroft-core](https://github.com/MycroftAI/mycroft-core/tree/dev/mycroft/client/text).\nThe CLI can be accessed from a terminal via `neon-cli`.\n\n## CLI Usage\nBy default, the CLI will use default parameters to connect to a Neon/Mycroft/OVOS\nCore instance running on the local host. The following arguments may be passed to\noverride defaults. This information is also accessible via `neon-cli --help`.\n\n### `--host 0.0.0.0`\nThe default `0.0.0.0` may be replaced with a different IP address if connecting\nto a remote core instance. Note that the messagebus carries unencrypted data, so\nenabling remote access is not generally recommended\n\n### `--port 8181`\nThe default `8181` may be replaced with a different port if the messagebus service\nwas configured to use a non-default port.\n\n### `--lang en-us`\nThe language of CLI inputs and expected responses can be set by passing a BCP-47\nlanguage code here.\n\n### `--logs-dir ~/.local/state/neon/`\nThe default log directory is read from configuration, but it may be overridden\nhere. This is commonly set for Docker connections, where the log path on the host\nis not configured for the CLI client.\n\n### `--simple`\nThis flag will enable a simple text-based CLI showing only inputs and responses.\nThis can be useful if the default CLI doesn't display properly in a terminal.\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "Packaged CLI Client from Neon, Mycroft, and OVOS cores",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon_cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d4110f18395d74126168f040bcf86278a64ec0455eca1415b95d26a2d0cbc2d",
"md5": "8b1d6500a7d7e14df0fec9ed85afc1f4",
"sha256": "175511caa296ffb1b98701808f8002d1b08fafcf12d598d8c7573e9bc1bd7a83"
},
"downloads": -1,
"filename": "neon_cli_client-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b1d6500a7d7e14df0fec9ed85afc1f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27142,
"upload_time": "2023-06-27T17:55:39",
"upload_time_iso_8601": "2023-06-27T17:55:39.089457Z",
"url": "https://files.pythonhosted.org/packages/8d/41/10f18395d74126168f040bcf86278a64ec0455eca1415b95d26a2d0cbc2d/neon_cli_client-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46e8e8bbdce6adf1c13800d8e4bc087869f26246c16bc856aa7c584962c220d1",
"md5": "c47fdfaa4bf5f89288f5b3238bf82197",
"sha256": "0c45741934bf25cd476f7a8b30b140316f053c3662290fcb25f55081e4190376"
},
"downloads": -1,
"filename": "neon_cli_client-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "c47fdfaa4bf5f89288f5b3238bf82197",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23795,
"upload_time": "2023-06-27T17:55:41",
"upload_time_iso_8601": "2023-06-27T17:55:41.698226Z",
"url": "https://files.pythonhosted.org/packages/46/e8/e8bbdce6adf1c13800d8e4bc087869f26246c16bc856aa7c584962c220d1/neon_cli_client-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 17:55:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-cli-client"
}
JSON
