Name | neosctl JSON |
Version |
0.13.2
JSON |
| download |
home_page | None |
Summary | NEOS Core CLI |
upload_time | 2024-12-06 16:12:48 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Core CLI v0.13.2
## Setup
### Install CLI
Install the CLI using [pip](https://pypi.org/project/neosctl/):
```bash
pip install neosctl
```
See [Local Development](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DEVELOP.md) for details on installing from source.
### Setup environment
To setup an environment, run the following command:
```bash
neosctl env init <env-name> -h <hub-host> -u <username> -a <account>
```
More information about this command you can find in the [DOCS.md](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DOCS.md) file.
### Activate an environment
To activate an environment (for use in subsequent requests):
```bash
neosctl env activate <env-name>
```
### Login to the system
To login to the system, run the following command:
```bash
neosctl env login
```
You will need username and password for that.
### Activate a core
To activate a core (for use in subsequent requests):
```bash
neoctl env list-cores
neosctl env activate-core <core-name>
```
### Setup service user (optional)
For some operations, you will need to provide a service user `access_key_id`
and `secret_access_key`. To create service user and get it's access and secret
key, use:
```bash
neosctl env whoami
{
"user_id": "<user-id>"
}
```
```bash
neosctl iam user create-access-key <user-id>
```
To configure the environment to use the key pair:
```bash
neosctl env credential <env-name> <access-key> <secret-key>
```
### Review settings
All setting are stored by default in the folder `~/.neosctl/`.
You can also review all settings by running the following commands:
```bash
neosctl env list
neosctl env view <env-name>
neosctl env active
```
## Usage
To see all available commands, run the following command:
```bash
neosctl --help
```
or go to the [DOCS.md](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DOCS.md) file.
Raw data
{
"_id": null,
"home_page": null,
"name": "neosctl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9a/6d/f2fe50252ae3ceb7a8d5c2f0d66cde0642c219e46cbd79406f66271b29db/neosctl-0.13.2.tar.gz",
"platform": null,
"description": "# Core CLI v0.13.2\n\n## Setup\n\n### Install CLI\n\nInstall the CLI using [pip](https://pypi.org/project/neosctl/):\n\n```bash\npip install neosctl\n```\n\nSee [Local Development](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DEVELOP.md) for details on installing from source.\n\n### Setup environment\n\nTo setup an environment, run the following command:\n\n```bash\nneosctl env init <env-name> -h <hub-host> -u <username> -a <account>\n```\nMore information about this command you can find in the [DOCS.md](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DOCS.md) file.\n\n### Activate an environment\nTo activate an environment (for use in subsequent requests):\n\n```bash\nneosctl env activate <env-name>\n```\n\n### Login to the system\n\nTo login to the system, run the following command:\n\n```bash\nneosctl env login\n```\n\nYou will need username and password for that.\n\n### Activate a core\nTo activate a core (for use in subsequent requests):\n\n```bash\nneoctl env list-cores\nneosctl env activate-core <core-name>\n```\n\n### Setup service user (optional)\n\nFor some operations, you will need to provide a service user `access_key_id`\nand `secret_access_key`. To create service user and get it's access and secret\nkey, use:\n\n```bash\nneosctl env whoami\n\n{\n \"user_id\": \"<user-id>\"\n}\n```\n\n```bash\nneosctl iam user create-access-key <user-id>\n```\n\nTo configure the environment to use the key pair:\n\n```bash\nneosctl env credential <env-name> <access-key> <secret-key>\n```\n\n### Review settings\n\nAll setting are stored by default in the folder `~/.neosctl/`.\n\nYou can also review all settings by running the following commands:\n\n```bash\nneosctl env list\nneosctl env view <env-name>\nneosctl env active\n```\n\n## Usage\n\nTo see all available commands, run the following command:\n\n```bash\nneosctl --help\n```\n\nor go to the [DOCS.md](https://github.com/NEOS-Critical/neos-platform-cli/tree/main/DOCS.md) file.\n",
"bugtrack_url": null,
"license": null,
"summary": "NEOS Core CLI",
"version": "0.13.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "245db3c854c6ffad83bb21047c313f793102de35c15dc84940af2fb626802dae",
"md5": "89e6edcf244154fa3dad6616af07daa1",
"sha256": "85cd4837c130c2e8f7f51ddced041b4744b150f0741b25bed56938da71027045"
},
"downloads": -1,
"filename": "neosctl-0.13.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89e6edcf244154fa3dad6616af07daa1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 39189,
"upload_time": "2024-12-06T16:12:45",
"upload_time_iso_8601": "2024-12-06T16:12:45.564837Z",
"url": "https://files.pythonhosted.org/packages/24/5d/b3c854c6ffad83bb21047c313f793102de35c15dc84940af2fb626802dae/neosctl-0.13.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a6df2fe50252ae3ceb7a8d5c2f0d66cde0642c219e46cbd79406f66271b29db",
"md5": "9c1283db25e9c6923ded5b6bf5504807",
"sha256": "af826a69d117bcd7f2a715cce7859ac77d6b152e7d975eff9cc4794087c9d2b9"
},
"downloads": -1,
"filename": "neosctl-0.13.2.tar.gz",
"has_sig": false,
"md5_digest": "9c1283db25e9c6923ded5b6bf5504807",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 127065,
"upload_time": "2024-12-06T16:12:48",
"upload_time_iso_8601": "2024-12-06T16:12:48.371528Z",
"url": "https://files.pythonhosted.org/packages/9a/6d/f2fe50252ae3ceb7a8d5c2f0d66cde0642c219e46cbd79406f66271b29db/neosctl-0.13.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 16:12:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "neosctl"
}