extremum-cli/README.md

Extremum CLI

# extremum-cli

Command line utility for Extremum Client Library

## Installation
```
$ npm install -g extremum-cli
```

## Getting started 
Before you can use the CLI, pass your Keycloak realm and app URL in .env:
```
EXTR_REALM="your_realm"
EXTR_CLIENT="your_client"
```
***
To create your project call the following command:
```
$ extremum add <YOUR_APP_NAME>
```
Add an environment to the configuration file, 
getting its parameters using the platform API; 
pre-authentication in the platform is performed 
(directly as part of the execution of this command)
```shell
$ <YOUR_APP_NAME> env add <env_name> --url <auth_service_url>
```
Set current environment for this application:
```shell
$ <YOUR_APP_NAME> env set <env_name>
```
### Usage:
```shell
Usage: <YOUR_APP_NAME> [options] [command]

Extremum command-line interface

Options:
  -v, --version   output the version number
  -h, --help      display help for command

Commands:
  app             manage your apps
  env             manage your environments
  api-scope       manage your scopes
  client          client configuration and login
  iam             identity and access management
  signals         send and receive signals
  storage         manage persistent data
  functions       manage serverless functions and packages
  help [command]  display help for command
```
### Example:
```
$ <YOUR_APP_NAME> storage buckets create top-secret-bucket
$ <YOUR_APP_NAME> storage buckets ls
$ [{
    '@id': '',
    '@type': '',
    '@created': '2022-06-02T11:51:18.622Z',
    '@updated': '0001-01-01T00:00:00Z',
    '@version': 1,
    name: 'top-secret-bucket'
  }]
$ <YOUR_APP_NAME> storage buckets remove top-secret-bucket
```

Check available commands using:
```shell
$ extremum -h # help with commands
$ extremum -v # installed version
```