¶ extremum CLI
extremum CLI — is a command-line tool that automates routine tasks, such as configuring your application after deployment to a new environment.
With extremum CLI, you can:
- manage application settings
- create and delete serverless functions and feature packages
- operate triggers
- operate users, roles and access rules
- configure data models
- manipulate data
extremum CLI is the main platform administration interface.
¶ installation
install required software if you have not done so before
$ npm install -g extremum-cli
$ extremum
Usage: extremum [options] [command]
Extremum command-line interface
Options:
-v, --version output the version number
-h, --help display help for command
Commands:
add <app_name> add application
help [command] display help for command
¶ cut-in
First of all, you need to authenticate in the platform
$ mycoolapp client login --url https://auth.app-0.<your-domain-extremum>/
You will be redirected to your browser to enter your credentials
After successful login, the browser will open a page with the text "Now you may close this page"
To avoid specifying a URL each time in the parameters, create the following environment variable:
EXTREMUM_AUTH_URL=https://auth.app-0.<your-domain-extremum>/
After authentication, you have access to CLI commands designed to manage the platform and work with data
By default, use the mycoolapp command to work with extremum.cli. You can change the command to match the name of your app:
$ mycoolapp rename app guitarshop
Now you can access the CLI by the new name:
$ guitarshop
Usage: guitarshop [options] [command]
Extremum command-line interface
Options:
-v, --version output the version number
-h, --help display help for command
Commands:
app manage your apps
rename rename this command
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
¶ how to get a command prompt
Use commands mycoolapp help and mycoolapp <section> [<subsection>] help [<command>] for CLI usage tips:
Section Assistance iam:
$ mycoolapp iam help
Usage: mycoolapp iam [options] [command]
identity and access management
Options:
-h, --help display help for command
Commands:
user manage users
roles manage user roles
rules manage access control rules
help [command] display help for command
Subsection Assistance roles undressed iam:
$ mycoolapp iam roles help
Usage: mycoolapp iam roles [options] [command]
manage user roles
Options:
-h, --help display help for command
Commands:
create <role-name> <role-description> create a role
ls list roles
get <role-name> get role metadata
remove <role-name> remove a role
help [command] display help for command
Command Assistance create subsection roles undressed iam:
$ mycoolapp iam roles help create
Usage: mycoolapp iam roles create [options] <role-name> <role-description>
create a role
Options:
-h, --help display help for command
¶ common commands
¶ rename app
Create Alias for CLI
syntax
$ mycoolapp rename app <new-name>
parameters
- new-name - new command name to start CLI
description
Creates an alternate name for the CLI call command, which can be used in the future along withmycoolapp. Multiple alternate names can be created
¶ client login
Platform Authentication
syntax
$ mycoolapp client login [options]
parameters
are absent
options
- --url <auth-url> - URL authentication service (default value of environment variable is used
EXTREMUM_AUTH_URL) - --client-id <client-id> - Authentication Service Client ID
- --app-id <app-id> - App ID extremum (by default "0")
description
Opens the authentication page in the browser. After checking the credentials entered by the user, writes the authentication service URL, application ID, and access token to the configuration file. When the user works with the CLI, this data is used to access the platform API
¶ working with applications
¶ app init
Application initialization
syntax
$ mycoolapp app init <app-id>
parameters
- app-id - extremum Application ID
description
Creates a subdirectory in the current directory with a name that matches the name of the command used to run the CLI (for example, when executing the command guitarshop app init 0 a directory named will be created guitarshop. The source code of the web frontend example is placed in the created directory, which can serve as a starting point for the further implementation of the application functionality
¶ app deploy
application deployment
This command is not implemented in platform version 3.0
¶ access control
¶ iam roles create
Create Role
syntax
$ mycoolapp iam roles create <role-name> <role-description>
parameters
- role-name - role name
- role-description - role description
description
Creates a user role with the specified name and description
¶ iam roles remove
Delete Role
syntax
$ mycoolapp iam roles remove <role-name>
parameters
- role-name - role name
description
Deletes the user role with the specified name
¶ iam roles get
Get Role Information
syntax
$ mycoolapp iam roles get <role-name>
parameters
- role-name - role name
description
Displays information about the role of users with the specified name to the terminal
¶ iam roles ls
Get Role List
syntax
$ mycoolapp iam roles ls
parameters
are absent
description
Displays the list of user roles to the terminal
¶ iam rules create
Add Access Control Rules
syntax
$ mycoolapp iam rules create <new-rules>
parameters
- new-rules - new rules as source code on Access Rule Description Language
description
Adds new access control rules to the bottom of the rules list
¶ iam rules replace
Download access control rules and replace existing rules with new rules
syntax
$ mycoolapp iam rules replace <filename>
parameters
- filename - a file with rules as source code on access rule description language
description
Replaces existing access control rules with rules from the transferred file
¶ iam rules get
Get valid access control rules
syntax
$ mycoolapp iam rules get
parameters
are absent
description
Displays the current access control rules in the form of source code to the terminal access rule description language
¶ iam users create
Add User
syntax
$ mycoolapp iam users create [options] <username>
parameters
- username - user name
options
- --email <user-email> - user email
- --roles <user-roles> - comma-separated role list, no spaces
description
Registers a new platform user
¶ iam users update
Update User Data
syntax
$ mycoolapp iam users update [options] <username>
parameters
- username - user name
options
- --data <json-patch> - update in format JSON patch
description
Updates user data according to the transmitted patch
¶ iam users remove
Update User Data
syntax
$ mycoolapp iam users remove <username>
parameters
- username - user name
description
Removes a user from the platform user database
¶ iam users get
Get User Data
syntax
$ mycoolapp iam users get <username>
parameters
- username - user name
description
Displays user information to the terminal
¶ iam users ls
Get User List
syntax
$ mycoolapp iam users ls
parameters
are absent
description
Displays platform user information to the terminal
¶ iam users password
Change User Password
syntax
$ mycoolapp iam users password [options] <username>
parameters
- username - user name
options
- --new <new-password> - new password
description
Sets a new password for the platform user
¶ iam clients create
Add Authentication Settings for Client Application
syntax
$ mycoolapp iam clients create <filename>
parameters
- filename - file name with client application configuration
description
Registers a new client application and configures its user authentication settings
¶ iam clients update
Update Client Authentication Settings
syntax
$ mycoolapp iam clients update [options] <client-id>
parameters
- client-id - client application ID
options
- --data <json-patch> - update in format JSON patch
description
Updates authentication settings in the client application according to the patch passed
¶ iam clients remove
Delete Client Authentication Settings
syntax
$ mycoolapp iam clients remove <client-id>
parameters
- client-id - client application ID
description
Removes authentication settings for the client application from the authentication service database
¶ iam clients get
Get Authentication Settings for Client Application
syntax
$ mycoolapp iam clients get <client-id>
parameters
- client-id - client application ID
description
Displays authentication settings for the client application to the terminal
¶ iam clients ls
Get a list of client applications
syntax
$ mycoolapp iam clients ls
description
Displays authentication settings for each client application to the terminal
¶ Working with signals
¶ signals send
Sends a signal
syntax
$ mycoolapp signals send <exchange-id>
parameters
- exchange-id - Exchange Point ID
options
- --source <source-actor> Sender ID (optional parameter)
- --kind <kind> signal type (by default regular)
- --destination <destination-actor> Recipient ID (optional parameter)
- --xid <xid> transaction ID (optional parameter)
- --timestamp <timestamp> send timestamp (optional parameter)
- --frame <frame> Send Frame Number (optional parameter)
- --data <data> signal data
- --peer-uuid <uuid> request signal ID (for a response in a request-response pair)
- --peer-xid <peer-xid> transaction ID from the request signal (for response in the request-response pair)
description
Sends a signal
¶ signals poll
Get Subscription Signals
syntax
$ mycoolapp signals poll <subscription-id>
parameters
- subscription-id - subscription ID
description
Outputs signals to the terminal for the specified subscription without removing them from the receiver queue
¶ signals subscribe
Create Subscription
syntax
$ mycoolapp signals subscribe [options] <exchange-id>
parameters
- exchange-id - Signal Exchange Point ID
options
- --function <function> function name (optional parameter)
- --destination <destination> Recipient ID (optional parameter)
description
Creates a subscription and displays its ID to the terminal
¶ signals unsubscribe
Unsubscribe
syntax
$ mycoolapp signals unsubscribe [options] <subscription-id>
parameters
- subscription-id - subscription ID
description
Cancels subscription
¶ signals ls-exchanges
Get a list of signal exchange points
syntax
$ mycoolapp signals ls-exchanges
parameters
are absent
description
Displays the list of signal exchange points to the terminal
¶ signals ls-subscriptions
Get Subscription List
syntax
$ mycoolapp signals ls-subscriptions [options]
parameters
are absent
options
- --exchange <exchange-id> Exchange Point ID (optional)
description
Displays a list of subscriptions to the terminal. If exchange is specified, subscriptions for the specified exchange point will be displayed, otherwise all subscriptions will be displayed
¶ data handling
¶ storage entities create
Create Entity Instance
syntax
$ mycoolapp storage entities create <collection>
parameters
- collection - collection name or ID
options
- data <instance-data> - instance data in JSON format
description
Creates an instance of an entity and outputs its identifier to the terminal
¶ storage entities update
Update Entity Instance
syntax
$ mycoolapp storage entities update [options] <instance-uuid>
parameters
- instance-uuid - instance ID
options
- data <patch> - update in format JSON patch
description
Updates the entity instance with the specified identifier according to the patch and displays the updated state to the terminal
¶ storage entities remove
Delete Entity Instance
syntax
$ mycoolapp storage entities remove <instance-uuid>
parameters
- instance-uuid - instance ID
description
Deletes an entity instance
¶ storage entities get
Get Entity Instance Data
syntax
$ mycoolapp storage entities get <instance-uuid>
parameters
- instance-uuid - instance ID
description
Outputs entity instance data with the specified identifier to the terminal
¶ storage entities ls
Get Entity Instance Collection Contents
syntax
$ mycoolapp storage entities ls [options] <collection>
parameters
- collection - name or instance ID
options
- --expand - advanced output format
- --offset <offset> - number of the first output element (default 0)
- --limit <limit> - maximum number of items in the output (default 20)
description
Displays collection item data to the terminal
¶ storage entities link
Link Two Objects
syntax
$ mycoolapp storage entities link [options] <subject> <object>
parameters
- subject - Subject Instance ID or IRI
- object - object ID, IRI or value
options
- -p, --predicate <predicate> - link predicate
description
Creates an RDF relationship with the specified predicate between entity instances or other objects
¶ storage entities unlink
Remove Link Between Objects
syntax
$ mycoolapp storage entities unlink [options] <subject> <object>
parameters
- subject - Subject Instance ID or IRI
- object - object ID, IRI or value
options
- -p, --predicate <predicate> - link predicate
description
Deletes the RDF link to the specified predicate between entity instances or other objects
¶ storage entities ls-links
Get List of Links for Communication Entity
syntax
$ mycoolapp storage entities ls-links [options] <subject>
parameters
- subject - Subject Instance ID or IRI
options
- -p, --predicate <predicate> - link predicate (optional)
description
Outputs to the terminal a list of RDF links for a given subject. If a predicate is specified, only associations with that predicate are output
¶ storage entities graphql
Run GraphQL Query
syntax
$ mycoolapp storage entities graphql [options] <subject>
parameters
are absent
options
- -f, --file <filename> - file name with query text
- -q, --query <query> - query text
Only one of the options must be specified --file or --query when using this command
description
Executes a GraphQL request (query or mutation) and outputs the result to the terminal
¶ storage models update
Update Entity Model Configuration
syntax
$ mycoolapp storage models update [options] <model-name>
parameters
- model-name - model name
options
- --data <patch> - update in format JSON patch
description
Updates entity model configuration
Only model settings can be modified in platform version 3.0 (property
settings), but not a data scheme
¶ storage models get
Get Entity Model Information
syntax
$ mycoolapp storage models get <model-name>
parameters
- model-name - model name
description
Displays entity model information, including JSON schema and settings, to the terminal
¶ storage models ls
Get List of Entity Models
syntax
$ mycoolapp storage models ls [options]
parameters
are absent
options
- --expand - advanced output format (optional parameter)
- --offset <offset> - number of the first list item in the output (optional parameter)
- --limit <limit> - maximum number of items in the output (optional parameter)
- --prefix <prefix> - model name prefix (optional parameter)
description
Displays information about entity models, including JSON schema and settings, to the terminal. If the * prefix * option is passed, the models whose names begin with the corresponding prefix are selected.
¶ storage binary put
Place Data in Binary Data Store
syntax
$ mycoolapp storage binary put [options] <object-key> <file-path>
parameters
- object-key - object key
- file-path - data file path
options
- -r, --recursive - Load the contents of the directory and its subdirectories (optional). The object-key parameter is then used as the key prefix
description
Loads the file or contents of the directory (if the recursive option is passed) into the binary store
¶ storage binary get
Get Data from Binary Data Store
syntax
$ mycoolapp storage binary get <object-key>
parameters
- object-key - object-key
description
Displays the data stored at the specified key in the standard output stream
¶ storage binary remove
Delete Data from Resource Store
syntax
$ mycoolapp storage binary remove <object-key>
parameters
- object-key - object key
description
Deletes the key and its associated data from the vault
¶ storage binary describe
Get Key Metadata in Binary Store
syntax
$ mycoolapp storage binary describe <object-key>
parameters
- object-key - object key
description
Outputs metadata corresponding to the specified key to the terminal
¶ storage binary ls
Get List of Binary Storage Keys
syntax
$ mycoolapp storage binary ls <prefix>
parameters
- prefix - key prefix
options
- --expand - advanced output format (optional parameter)
- --offset <offset> - number of the first list item in the output (optional parameter)
- --limit <limit> - maximum number of items in the output (optional parameter)
description
Lists the binary storage keys for the specified prefix to the terminal
¶ storage binary post-form
Create a pre-signed form to load data into the binary data store
syntax
$ mycoolapp storage binary post-form <object-key>
parameters
- object-key - object key
description
Outputs to the terminal data for the object load-once form to S3-compatible binary storage at the specified key
¶ storage binary presign-url
Generate URL for temporary access to binary storage
syntax
$ mycoolapp storage binary presign-url [options] <object-key>
parameters
- object-key - object key
options
- --prefix - treat the transmitted key as a prefix of the keys to which access is granted (optional parameter)
- --access <access-mode> - data access mode (read, write or read+write; by default read)
- --expiration <expiration-time> - link validity time (for example, 1h30m, 50s; by default 24h)
description
Generates and outputs to the terminal a temporary link, with which it is possible to perform specified operations on a limited set of keys for a limited period of time
¶ storage buckets create
Create a bucket (for binary storages that support the bucket concept)
syntax
$ mycoolapp storage buckets create <bucket-name>
parameters
- bucket-name - baketa name
description
Creates a bucket in binary storage. Not supported for vaults that do not have a bucket concept
¶ storage buckets remove
Remove the bucket (for binary storage that supports the bucket concept)
syntax
$ mycoolapp storage buckets remove <bucket-name>
parameters
- bucket-name - basket name
description
Deletes the bucket in the binary store. Not supported for vaults that do not have a bucket concept
¶ storage buckets describe
Get bucket metadata (for binary stores that support the bucket concept)
syntax
$ mycoolapp storage buckets describe <bucket-name>
parameters
- bucket-name - bucket name
description
Outputs the metadata of the bucket in the binary store to the terminal. Not supported for vaults that do not have a bucket concept
¶ storage buckets ls
Get a list of buckets (for binary storages that support the concept of bucket)
syntax
$ mycoolapp storage buckets ls
parameters
are absent
description
Displays a list of binary storage buckets to the terminal. Not supported for vaults that do not have a bucket concept
¶ storage buckets create-trigger
Create a binary store trigger (for binary stores that support the bucket concept)
syntax
$ mycoolapp storage buckets create-trigger [options] <bucket-name>
parameters
- bucket-name - bucket name
options
- -f, --function <function-name> - serverless function name
- -e, --event <event-name> - event (create, delete)
- --prefix <key-prefix> - key prefix (by default "")
description
Creates a binary store trigger for the specified event and key prefix and assigns it as a handler to the specified function
¶ storage buckets remove-trigger
Delete binary storage trigger (for binary storage that supports the concept of bucket)
syntax
$ mycoolapp storage buckets remove-trigger [options] <bucket-name>
parameters
- bucket-name - bucket name
options
- -f, --function <function-name> - serverless function name
description
Deletes the binary store trigger for the specified key prefix and handler function
¶ storage buckets mount
Mount the bucket to a binary storage key perfix (for binary storage that supports the bucket concept)
syntax
$ mycoolapp storage buckets mount <prefix> <bucket>
parameters
- prefix - key prefix
- bucket - bucket name
description
Creates a mount point that displays binary storage keys with a prefix prefix per bucket bucket. Not supported for vaults that do not have a bucket concept
¶ storage buckets unmount
Remove mount point for bucket (for binary stores supporting bucket concept)
syntax
$ mycoolapp storage buckets unmount <bucket>
parameters
- bucket - bucket name
description
Deletes the mount point that maps the binary storage keys to the bucket bucket. Not supported for vaults that do not have a bucket concept
¶ storage buckets ls-mount
Get a list of mount points (for binary storages that support the bucket concept)
syntax
$ mycoolapp storage buckets ls-mount
parameters
are absent
description
Displays a list of mount points that map binary storage keys to physical binary bins. Not supported for vaults that do not have a bucket concept
¶ storage jobs create
Create Batch Data Job in Binary Store
syntax
$ mycoolapp storage jobs create
parameters
are absent
options
- --action <value> - action (delete or invoke_function)
- --keys <keys> - comma-separated list of keys or key prefixes
- --function <function-name> - function name for the action invoke_function
description
Creates and queues a bulk processing job in a binary store. Displays the ID of the created job to the terminal
¶ storage jobs describe
Get information about the job for mass processing of data in binary storage
syntax
$ mycoolapp storage jobs describe <job-id>
parameters
- job-id - Job ID
description
Outputs job information to the terminal
¶ storage jobs ls
Get a list of bulk processing jobs in binary storage
syntax
$ mycoolapp storage jobs ls
parameters
are absent
description
Lists scheduled, active and completed bulk processing jobs in the binary store to the terminal
¶ storage jobs cancel
Cancel Bulk Data Job in Binary Store
syntax
$ mycoolapp storage jobs cancel <job-id>
parameters
- job-id - Job ID
description
Cancels a scheduled or active bulk job in a binary store
¶ Working with serverless functions
¶ functions create
Create Function or Feature Package
syntax
$ mycoolapp functions create [options] <function-name>
parameters
- function-name - name of the function or package
options
- --kind <function|package> - component type (function or package)
- --image <binary|docker> - image type (binary - archive with the assembled component, docker - image Docker)
- -f, --file <archive-filename> - archive file name (for image type binary)
- -V, --fn-version <version> - version of the function (by default latest)
- --trigger - indication that the function is a trigger (only for a component type function)
description
Creates and deploys a function or package of functions in a runtime environment, making it available for call and/or handler assignment of a trigger or signals
¶ functions new-version
Create a new version of a function or feature package
syntax
$ mycoolapp functions create [options] <function-name>
parameters
- function-name - name of the function or package
options
- --kind <function|package> - component type (function or package)
- --image <binary|docker> - image type (binary - archive with the assembled component, docker - image Docker)
- -f, --file <archive-filename> - archive file name (for image type binary)
- -V, --fn-version <version> - version of the function
- --trigger - indication that the function is a trigger (only for the function component type)
description
Creates and deploys in the runtime a new version of an existing function or feature package, making it available for invocation and/or designation by a trigger or signal handler
¶ functions remove
Remove Function or Feature Package
syntax
$ mycoolapp functions remove [options] <function-name>
parameters
- function-name - name of the function or package
options
- -V, --fn-version <version> - in version of the function (if no version is specified, the function or package will be removed along with all versions they have)
description
Deletes a function or function package or a specific version of a function/package. After removal, the function becomes unavailable for a call and/or a trigger or signal handler to assign
¶ functions describe
Get Feature or Feature Package Information
syntax
$ mycoolapp functions describe <function-name>
parameters
- function-name - name of the function or package
description
Displays function or feature package information to the terminal
¶ functions ls
Get a list of functions and feature packages
syntax
$ mycoolapp functions ls
parameters
are absent
description
Lists the functions or feature packages deployed in the platform to the terminal
¶ functions call
Call function
syntax
$ mycoolapp functions call [options] <function-name>
parameters
- function-name - function name (for a package function, the name is formed in the format package_name.function_name)
options
- --data <params> - function parameters in JSON format
- -V, --fn-version <version> - feature version (default *latest^)
description
Calls the function and outputs its return value to the terminal
¶ functions get-code
Get Archive with Function Code or Feature Package
This command is not implemented in platform version 3.0
syntax
$ mycoolapp functions get-code [options] <function-name>
parameters
- function-name - name of the function or package
options
- -V, --fn-version <version> - feature version (default *latest^)
description
Displays the contents of the zip archive with the function code or function package in the stream of standard output in the form in which it was transmitted when the function was created. Returns an error if a Docker image was used to create a function/package