Metadata-Version: 2.3
Name: neosctl
Version: 0.12.30
Summary: NEOS Core CLI
Requires-Python: >=3.9
Requires-Dist: auth-aws4>=0.1.2
Requires-Dist: httpx>=0.27
Requires-Dist: minio>=7.1.14
Requires-Dist: multidict>=6.0.5
Requires-Dist: orjson>=3.10.1
Requires-Dist: pydantic>=2.0.0
Requires-Dist: rich>=13.7.1
Requires-Dist: rtoml>=0.10.0
Requires-Dist: ryaml>=0.4.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: typer>=0.12
Requires-Dist: typing-extensions>=4.7.0; python_version <= '3.10'
Provides-Extra: dev
Requires-Dist: changelog-gen<0.14,>=0.13.1; extra == 'dev'
Requires-Dist: freezegun>=1.2.1; extra == 'dev'
Requires-Dist: pdoc>=14.1.0; extra == 'dev'
Requires-Dist: pre-commit>=3.7.1; extra == 'dev'
Requires-Dist: pyright>=1.1.293; extra == 'dev'
Requires-Dist: pytest-cov>=3.0.0; extra == 'dev'
Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
Requires-Dist: pytest-random-order>=1.0.4; extra == 'dev'
Requires-Dist: pytest<7.2,>=7.1.2; extra == 'dev'
Requires-Dist: ruff>=0.6.4; extra == 'dev'
Description-Content-Type: text/markdown

# Core CLI v0.12.30

## 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.
