CLI Reference Manual
Note
This documentation was generated using eai
version 1.11.0.
eai account
Manage accounts
Usage:
eai account [command]
Available Commands:
get Show information about account(s)
ls List accounts
new Create new account
role Manage roles
set Update information about an account
size Get size of account(s)
Flags:
-h, --help help for account
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai account [command] --help" for more information about a command.
eai completion
Generate shell completion scripts for your specific shell ([command])
Usage:
eai completion [command]
Available Commands:
bash
fish
powershell
zsh
Flags:
-h, --help help for completion
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai completion [command] --help" for more information about a command.
eai data
Manage data
Usage:
eai data [command]
Available Commands:
branch List, create branches of a data
chown Change data ownership from an account to another account in the same organization
content List, remove content of a data content
get Get data info
ls List all data for an account
new Create new a new data to EAI toolkit
pull Pull data from EAI toolkit
push Push data to EAI toolkit (new command should be called before)
run Launch job from data commands
set Set name of a data
size Get data size
Flags:
-h, --help help for data
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai data [command] --help" for more information about a command.
eai data branch
List, create branches of a data
Usage:
eai data branch [command]
Available Commands:
add Add new branch to a data
ls List branches of a data
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for branch
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai data branch [command] --help" for more information about a command.
eai data chown
Change data ownership from an account to another account in the same organization
Usage:
eai data chown <id> <account> [flags]
Examples:
# Change data ownership to a destination account
eai data chown 337ad5c2-4425-4912-9fbf-79814de676fe 9982ea8-4425-4912-9fbf-79814de676fe
eai data chown OrgName.AccountName.DataName OrgName.DestAccountName
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for chown
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data content
List, remove content of a data content
Usage:
eai data content [command]
Available Commands:
ls List all files for a data version
rm Remove content of a data to EAI toolkit. Version is optional, default latest.
tree Describe data ID directory as a tree. Version is optional, default latest.
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for content
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai data content [command] --help" for more information about a command.
eai data get
Get data info
Usage:
eai data get <id>... [flags]
Examples:
# Get data info by id
eai data get 337ad5c2-4425-4912-9fbf-79814de676fe
# Get data info by name
eai data get OrgName.AccountName.DataName
Note :
1. when using name, all subitems must be named (Account must have a name...)
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for get
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data ls
List all data for an account
Usage:
eai data ls [<account>] [flags]
Examples:
# List data in your default account
eai data ls
# List data in a specific account (by ID)
eai data ls 337ad5c2-4425-4912-9fbf-79814de676fe
# List data in a specific account (by name)
eai data ls OrgName.AccountName
Note :
1. when using name, all subitems must be named (Account must have name...)
Flags:
--all List all data in the cluster
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for ls
--no-header Don't output header line
--recursive List data in all sub-accounts
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data new
Create new a new data to EAI toolkit
Usage:
eai data new [<account uuid>|[<account>.][<name>]] [<./directory>] [flags]
Examples:
# Create new empty data in default account
eai data new
eai data new DataName
# Create new empty data in specific account
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe
eai data new OrgName.AccountName.
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe.DataName
eai data new OrgName.AccountName.DataName
# Create new data with push local directory
eai data new ./dir
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe ./dir
eai data new OrgName.AccountName.DataName ./dir
# Create new data and create a branch
eai data new --branch V1
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe --branch V1
eai data new OrgName.AccountName.DataName --branch V1
eai data new ./dir --branch V1
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe ./dir --branch V1
eai data new OrgName.AccountName.DataName ./dir --branch V1
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Note, during push of local directory, set the flag --verbose to see upload progression.
Flags:
--arg stringArray Template argument e.g. Name=Value
--branch string branch to create (e.g. v1) of data
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
--from string Use data as template
-h, --help help for new
--no-header Don't output header line
--owner string Owner: user email, fullName or ID
--storage string Data storage type
--tag string[=string] Tags in format: (--tag <key>[=<value>])... (default [])
--verbose Verbose mode
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data pull
Pull data from EAI toolkit
Usage:
eai data pull <id>[@<version>] [[<./remote/directory>[/<file_name>[:<new_file_name>]]] <./directory>] [flags]
Examples:
# Pull latest version of data from eai-toolkit to local directory
eai data pull 337ad5c2-4425-4912-9fbf-79814de676fe ./directory/
eai data pull OrgName.AccountName.DataName ./directory/
eai data pull DataName ./directory/ (if DataName is being part of your default account)
eai data pull AccountName.DataName ./directory/ (if AccountName is being part of your personal Organization)
# Pull specific version or branch of data from eai-toolkit to local directory (version or branch must exist)
eai data pull 337ad5c2-4425-4912-9fbf-79814de676fe@7e8e22412cb5c8e17bdcdc5b09e55b91 ./directory/
eai data pull 337ad5c2-4425-4912-9fbf-79814de676fe@v0.0.1 ./directory/
eai data pull OrgName.AccountName.DataName@7e8e22412cb5c8e17bdcdc5b09e55b91 ./directory/
eai data pull OrgName.AccountName.DataName@v0.0.1 ./directory/
# Pull specific files or directories
# Pattern :
# eai data pull DataID RemoteFilename LocalDirectory
# eai data pull DataID RemoteFilename:LocalFilename LocalDirectory
# Pull entire content of data locally while preserving structure
eai data pull OrgName.AccountName.DataName
# Pull 'file1_remote' to local directory '.'
eai data pull OrgName.AccountName.DataName ./file1_remote .
# Pull 'file1_remote" and rename it to 'NewFileName' to local directory '.'
eai data pull OrgName.AccountName.DataName ./file1_remote:NewFileName .
# Pull 'Dir_remote' to local directory '.'
eai data pull OrgName.AccountName.DataName ./Dir_remote .
# Pull 'Dir_remote" and rename it to 'Dir_local' to local directory '.'
eai data pull OrgName.AccountName.DataName ./Dir_remote:Dir_local .
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Note, during pull of local directory, set the flag --verbose to see upload progression.
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for pull
--no-header Don't output header line
--verbose Verbose mode
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data push
Push data to EAI toolkit (new command should be called before)
Usage:
eai data push <id>[@<version>] <./directory/or/file>[:/remote/directory/or/file] [flags]
Examples:
# Push local directory to data ID on latest version
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe ./directory/
eai data push OrgName.AccountName.DataName ./directory/
eai data push DataName ./directory/ (if DataName is being part of your default account)
eai data push AccountName.DataName ./directory/ (if AccountName is being part of your personal Organization)
# Push local directory to data ID on specific version or branch (version or branch must exist)
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe@7e8e22412cb5c8e17bdcdc5b09e55b91 ./directory/
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe@v0.0.1 ./directory/
eai data push OrgName.AccountName.DataName@7e8e22412cb5c8e17bdcdc5b09e55b91 ./directory/
eai data push OrgName.AccountName.DataName@v0.0.1 ./directory/
# Push specific file or directory to an existing data (partial update)
# In this example, 'file1' will be push to the root directory of OrgName.AccountName.DataName :
eai data push OrgName.AccountName.DataName ./file1
# In this example, 'file1' will be push to the directory dir1 of OrgName.AccountName.DataName
# and will be renamed as 'file1_rename' :
eai data push OrgName.AccountName.DataName ./file1:/dir1/file1_rename
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Note, during push of local directory, set the flag --verbose to see upload progression.
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for push
--no-header Don't output header line
--verbose Verbose mode
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data run
Launch job from data commands
Usage:
eai data run <id> [<command>] [flags]
Flags:
--arg stringArray Template argument e.g. Name=Value
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for run
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data set
Set name of a data
Usage:
eai data set <id> [flags]
Examples:
# Update data name
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --name "my_dataset"
eai data set OrgName.AccountName.DataName --name "my_dataset"
Note : the last command will overwrite "DataName" by "my_dataset"
# Update owner
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --owner snow.user
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --owner user@servicenow.com
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --owner 30e962a4-127b-4f69-95cf-203a4f13acf5
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed (default [id,name,fullName,creator,created,ownerInherited,owner])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for set
--name string Data name (alphanumeric lowercase string, with underscores allowed) (Required)
--no-header Don't output header line
--owner string Owner: user email, fullName or ID
--storage string Data storage type
--tag string[=string] Tags in format: (--tag <key>[=<value>])... or to delete all: --tag ""
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai data size
Get data size
Usage:
eai data size <id>... [flags]
Examples:
# Get data size by id(s)
eai data size 337ad5c2-4425-4912-9fbf-79814de676fe
eai data size a712b914-6783-452b-9df0-5ded5adde6f4 337ad5c2-4425-4912-9fbf-79814de676fe
# Get data size by name(s)
eai data size OrgName.AccountName.DataName
eai data size OrgName.AccountName.DataName OrgName.AccountName.DataName
# Get size(s) of data
eai data size
Note :
1. when using name, all subitems must be named (Account must have a name...)
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,name,fullName,creator,created,ownerInherited,owner,size,calculated_on])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, owner, ownerInherited, tags, tags.key, tags.value, storage, metadata, version, state, branch, last_accessed, size, calculated_on, branches (default [id,name,fullName,creator,created,ownerInherited,owner,size,calculated_on])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for size
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai docker
Docker registry commands
Usage:
eai docker [command]
Available Commands:
get-login Get docker login command
get-registry Get Tookit Registry url
Flags:
-h, --help help for docker
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai docker [command] --help" for more information about a command.
eai docker get-login
Get docker login command
Usage:
eai docker get-login [flags]
Examples:
# Get the command to login with docker client
Flags:
-h, --help help for get-login
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai docker get-registry
Get Tookit Registry url
Usage:
eai docker get-registry [flags]
Examples:
docker pull $(eai docker get-registry)/eai.myaccount/myimage:latest
Flags:
-h, --help help for get-registry
--volatile Use the volatile registry instead (default false)
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai help
Help provides help for any command in the application.
Simply type eai help [path to command] for full details.
Usage:
eai help [command] [flags]
Flags:
-h, --help help for help
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job
Manage jobs
Usage:
eai job [command]
Available Commands:
consent Consent to job scopes
exec Execute a command in a running job
get Show information about job(s)
info Show full YAML information about job
kill Kill one or more jobs
log Get job logs
ls List jobs
new Submit a new job to the cluster
port-forward Forward one or more local ports to a job.
retry Retry a cancelled, failed or interrupted job
role Manage roles
set Update information about job
Flags:
-h, --help help for job
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai job [command] --help" for more information about a command.
eai job consent
Consent to job scopes
Usage:
eai job consent --last|<id>
Examples:
# Consent to a job
eai job consent 337ad5c2-4425-4912-9fbf-79814de676fe
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for consent
--last Consent to the last job created
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job exec
Execute a command in a running job
Usage:
eai job exec (--last|<id>) [flags] -- <cmd> [args...]
Examples:
# Run terminal in a job
eai job exec 337ad5c2-4425-4912-9fbf-79814de676fe /bin/bash
Note:
If a job is not running yet, exec will wait until it does and
then execute the command.
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for exec
--last Execute the command in the last job created
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job get
Show information about job(s)
Usage:
eai job get [<id>...] [--last] [flags]
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for get
--last Get the most recently submitted job
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job info
Show full YAML information about job
Usage:
eai job info (--last|<id>) [flags]
Examples:
# Get job info of the most recently submitted job
eai job info --last
# Get job info of a specific job
eai job info 337ad5c2-4425-4912-9fbf-79814de676fe
Flags:
--account string Account ID/Name to use (if empty use default account)
-h, --help help for info
--job-spec Output as yaml job spec which can then be used with
'eai job new -f job.spec.yaml'.
--last Display info for the last job created
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job kill
Kill one or more jobs
Usage:
eai job kill (--last|<id>) [<id>...]
Examples:
# Kill one job
eai job kill 337ad5c2-4425-4912-9fbf-79814de676fe
# Kill the last job created
eai job kill --last
# Kill multiple jobs
eai job kill 337ad5c2-4425-4912-9fbf-79814de676fe 337ad5c2-4425-4912-9fbf-79814de676ff
# Kill the last job created and other multiple jobs
eai job kill --last 337ad5c2-4425-4912-9fbf-79814de676fe 337ad5c2-4425-4912-9fbf-79814de676ff
# Kill your first 4000 currently active jobs (i.e. QUEUING, QUEUED,
# RUNNING or CANCELLING)
eai job kill $(eai job ls --state alive --field id -n 4000)
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for kill
--last Kill the last job created
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job log
Get job logs
If the job is not running yet (i.e. QUEUING or QUEUED), the
command will wait for it to progress to another state.
If the state is RUNNING, the command will display the logs up
until now and wait to display future logs if -f/--follow has
been specified.
In all other states it will show the available logs.
Note that the command with the -f/--follow option will not
reattach to a restarted job.
Usage:
eai job log (--last|<id>) [flags]
Aliases:
log, logs
Examples:
# Get logs of the last submitted job
eai job log --last
# Get logs of a job
eai job log 337ad5c2-4425-4912-9fbf-79814de676fe
# Get and follow logs of a running job
eai job log --follow 337ad5c2-4425-4912-9fbf-79814de676fe
Flags:
--account string Account ID/Name to use (if empty use default account)
-f, --follow Display logs as they are generated, until the job finishes
-h, --help help for log
--last Display logs of the last job created
-r, --run string Display logs for the specified run. (Both run index and id are supported)
--tail int Display the N last lines of the logs.
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job ls
List jobs
Usage:
eai job ls [flags]
Examples:
# List your live jobs or jobs that have finished in the last 24h in your account.
eai job ls
# List all your jobs
eai job ls --me
# List jobs of an user
eai job ls --user [org.user_name|user_id]
# List jobs of a service
eai job ls --service [org.account.service_name|service_id]
# List jobs of an account
eai job ls --account [org.account|account_id]
# List jobs of an organization
eai job ls --organization [org|organization_id]
# List all jobs
eai job ls --all
# List jobs in all state
eai job ls --state all
# List live jobs
eai job ls --state alive
# List all queued and queuing jobs
eai job ls --state queued,queuing
eai job ls --state queued --state queuing
# Show id, state and creator fields for all jobs
eai job ls --state all --fields id,state,creator
eai job ls --state all --fields id,state --fields creator
# List your live jobs in reverse order
eai job ls --state alive --reverse
eai job ls --state alive -r
Flags:
--account string Account ID/Name to use (if empty use default account)
--all List all jobs
-c, --command strings Command filter. Display jobs with an item in the command array containing the specified string.
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for ls
-i, --image strings Image filter. Display jobs whose image contains the specified string.
-n, --limit int Maximum number of jobs to return. Maximum 8192. (default 256)
--me List all your jobs
-N, --name strings Name filter. Display jobs whose name contains the specified string.
--no-header Don't output header line
-o, --offset int Number of jobs to skip (default 0)
--organization string List jobs of an organization
-g, --replica-group-id strings replicaGroupID filter. Display jobs belonging to the following replicas group IDs.
-R, --replica-jobs List Replica jobs
-r, --reverse Display in ascending order instead of descending
--service string List jobs of a service
-s, --state strings Display jobs in the specified states: cancelled, cancelling, failed, interrupted, queued, queuing, running, succeeded, alive, all. (default jobs that were alive in the last 24h)
-t, --tag strings Tag filter. Display jobs with at least one tag containing the specified string.
--user string List jobs of a user
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job new
Submit a new job to the cluster
Usage:
eai job new (--interactive|--non-preemptable|--preemptable|--restartable) [flags] [-- <cmd> [args...]]
Aliases:
new, submit
Examples:
# Submit a new preemptable job requiring 1 GPU and displaying the result of nvidia-smi
eai job new -i ubuntu:18.04 --gpu 1 --preemptable -- nvidia-smi
# Submit a new job requesting 1 GPU, mounting data
eai job new -i ubuntu:18.04 \
--gpu 1 --data eai.projects.foo_work:/foo_work \
-- /bin/bash -c 'python stuff.py 2>/foo_work/err.txt 1>/foo_work/out.txt'
# Submit a new job exactly like another
eai job new -f <(eai job get --job-spec 337ad5c2-4425-4912-9fbf-79814de676fe)
# Submit a new job that can run anywhere except on nodes with P100 GPUs
eai job new --gpu 1 --gpu-model-filter '!P100' --preemptable --name notp100 -- nvidia-smi
# Submit a new interactive job
eai job new -I --gpu 1 --name interactive_job -- [CMD]
# Submit a new job with infiniband devices
eai job new --infiniband
# Submit a new job with network isolation to block incoming network
eai job new --network-isolation=in
Flags:
--account string Account ID/Name to use (if empty use default account)
-a, --alphabit stringArray Alpha bits (default [])
-b, --bid int Bid for the job (used in computing priority). (default nil)
--cpu float Number of requested CPUs.
--cpu-model-filter string CPU model filter. A leading '!' reverses the filter.
--cuda-version float Required CUDA version.
-d, --data stringArray Data to mount in the container. Syntax: <data>[</path/in/data>]:</path/in/container>[:ro|:rw] where <data> is a toolkit data UUID or full name.
-n, --dry-run Do not submit job, display YAML job spec to stdout and exit.
--enforce-name Auto Renames the Job if another job exists with the same name
-e, --env stringArray Set environment variables
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
-f, --file string Load job spec from specified YAML file.
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
--from-id string Job ID to use as default job spec.
--gpu int Number of requested GPUs.
--gpu-mem int Requested amount of memory per GPU in gigabytes (used as a minimum to filter the GPU models).
--gpu-model-filter string GPU model filter. A leading '!' reverses the filter.
--gpu-tensor-cores Request GPU tensor-cores.
-h, --help help for new
-i, --image string Docker image
--inference Request inference node.
--infiniband Give access to infiniband devices to the job
-I, --interactive Interactive job. To be scheduled as soon as possible, regardless of the user's cluster occupancy. Limit of 1 per user.
--max-run-time int Maximum job execution time in seconds. (default 172800 (48h) for non-preemptable jobs, 0 (unlimited) for preemptable and interactive jobs)
--mem int Requested amount of memory in gigabytes.
--name string Job name (alphanumeric lowercase string, with underscores allowed)
--network-isolation string Limit incoming or/and outgoing network. Use "out" to block outgoing network from the job, "in" to block incoming network to the job or "all" for both
--no-header Don't output header line
--non-preemptable Forbid to interrupt job. (will run for a maximum of 48h)
--preemptable Allow job to be interrupted.
--replica-master-port int Master port number for replicas jobs
--replicas int Number of requested Nodes.
--reset-data Remove data inherited from --file or --from-id.
--reset-envs Remove environment variables inherited from --file or --from-id.
--reset-tags Remove tags inherited from --file or --from-id.
--restartable Allow job to be interrupted and restarted.
--role string Role
--scopes string JSON scopes containing a list of actions and expression to use user permission. Syntax: --scopes @scopes.json or --scopes '{"console.elementai.com": [{"action":"job:get", "expression":"*"}, {"action":"user:get", "expression":"491e3474-8382-4437-a68b-18414701dec2:*"}]}'
--tag stringArray Tags (default [])
--tunnel Start a sidecar tunnel to allow port-forwarding.
--url Show job's URL
-w, --workdir string Working directory inside the container. (default "")
--x11-cpu Start an X11 server accessible from the job on DISPLAY :0.
--x11-gpu Start an X11 server with GPU acceleration. (requires --gpu > 0)
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job port-forward
Forward one or more local ports to a job.
Usage:
eai job port-forward (--last|<id>) <remote> [flags]
Examples:
<remote>s are remote connections tunneled through the server, each of
which come in the form:
<local-host>:<local-port>:<remote-host>:<remote-port>
■ local-host defaults to 0.0.0.0 (all interfaces).
■ local-port defaults to remote-port.
■ remote-port is required*.
■ remote-host defaults to 0.0.0.0 (server localhost).
which shares <remote-host>:<remote-port> from the server to the client
as <local-host>:<local-port>, or:
R:<local-interface>:<local-port>:<remote-host>:<remote-port>
which does reverse port forwarding, sharing <remote-host>:<remote-port>
from the client to the server's <local-interface>:<local-port>.
example remotes
3000
localhost:3000
3000:localhost:3000
example.com:3000
3000:google.com:80
192.168.0.5:3000:google.com:80
socks
5000:socks
R:2222:localhost:22
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for port-forward
--last Execute the command in the last job created
--max-retry-count int Maximum number of times to retry before exiting. (-1 for unlimited) (default -1)
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job retry
Retry a cancelled, failed or interrupted job
Usage:
eai job retry (--last|<id>) [<id>...]
Examples:
# Retry one job
eai job retry 337ad5c2-4425-4912-9fbf-79814de676fe
# Retry last submitted job
eai job retry --last
# Retry set of jobs
eai job retry 337ad5c2-4425-4912-9fbf-79814de676fe 337ad5c2-4425-4912-9fbf-79814de676ff 337ad5c2-4425-4912-9fbf-79814de676f0
# Retry the last job created and a few other jobs
eai job retry --last 337ad5c2-4425-4912-9fbf-79814de676ff 337ad5c2-4425-4912-9fbf-79814de676f0
Flags:
--account string Account ID/Name to use (if empty use default account)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for retry
--last Retry the last job created
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai job role
Manage roles
Usage:
eai job role [command]
Available Commands:
get Show information about roles(s)
key Manage long live access key
member Manage members
policy Manage policies
set Update information about role
Flags:
-h, --help help for role
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai job role [command] --help" for more information about a command.
eai job set
Update information about job
Usage:
eai job set (--last|<id>) [flags]
Examples:
# Set name to job
eai job set 337ad5c2-4425-4912-9fbf-79814de676fe --name "test"
# Remove name from last job
eai job set --last --name ""
# Set bid of one job to 10
eai job set --bid 10 337ad5c2-4425-4912-9fbf-79814de676fe
# Set bid of the last submitted job to 10
eai job set --bid 10 --last
Flags:
--account string Account ID/Name to use (if empty use default account)
-b, --bid int Bid for the job (used in computing priority)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, environmentVars, image, isProcessAgent, role, scopes, workdir, resources.cpu, resources.cpuModel, resources.mem, resources.gpu, resources.gpuMem, resources.gpuModel, resources.gpuTensorCores, resources.gpuCudaVersion, resources.inference, resources.replicas, bid, interactive, maxRunTime, preemptable, restartable, name, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, owner, ownerInherited, id, organization, runs, runs.id, runs.jobId, runs.createdOn, runs.queuedOn, runs.waitTime, runs.startedOn, runs.startupTime, runs.cancelRequestedOn, runs.endedOn, runs.runTime, runs.totalTime, runs.ip, runs.info, runs.state, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, children, processAgent, replicaGroupId, replicaRank (default [id,state,name,replicaGroupId,account,creator,created,resources.replicas,command,runs.exitCode,accessUrl])
--format string Desired output format e.g. table, csv, json, text (default "table")
--format-template string Template string used when format is text (default "{{ . }}\n")
-h, --help help for set
--last Update information about the last job created
--name string Job name (alphanumeric lowercase string, with underscores allowed)
--no-header Don't output header line
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai login
Login to access the API
Usage:
eai login [flags]
eai login [command]
Available Commands:
token Print your personal token to access toolkit API
validate Validate login credentials to the toolkit
Flags:
-c, --docker-config string Docker configuration file to use
-n, --docker-dry-run Do not write the new docker configuration. Print it on stdout.
-h, --help help for login
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai login [command] --help" for more information about a command.
eai organization
Manage organizations
Usage:
eai organization [command]
Aliases:
organization, org
Available Commands:
get Show information about organization
ls List organizations
new Create new organization
role Manage roles
set Update information about an organization
size Get size of organization(s)
Flags:
-h, --help help for organization
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai organization [command] --help" for more information about a command.
eai privateregistry
Manage private registries
Usage:
eai privateregistry [command]
Available Commands:
get Show information about private registry(ies)
ls List private registries
new Create new private registry
set Update information about a private registry
Flags:
-h, --help help for privateregistry
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai privateregistry [command] --help" for more information about a command.
eai profile
Manage profile
Usage:
eai profile [command]
Available Commands:
add Add a new profile
current Display information on current profile
ls List profiles
rm Remove a profile from config
set Set a profile as default
Flags:
-h, --help help for profile
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai profile [command] --help" for more information about a command.
eai proxy
Run a proxy to the toolkit API
Usage:
eai proxy [flags]
Flags:
--bind string Local proxy server address (default "127.0.0.1:8080")
-h, --help help for proxy
-v, --verbose Print request forwarded
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai replica-jobs
Manage Replica jobs
Usage:
eai replica-jobs [command]
Available Commands:
get Show information about Replica job(s)
kill Kill one or more Replica jobs
ls List Replica Jobs
Flags:
-h, --help help for replica-jobs
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai replica-jobs [command] --help" for more information about a command.
eai resource
Manage resources
Usage:
eai resource [command]
Available Commands:
get Show information about resource(s)
Flags:
-h, --help help for resource
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai resource [command] --help" for more information about a command.
eai role
Manage roles
Usage:
eai role [command]
Available Commands:
get Show information about roles(s)
key Manage long live access key
ls List roles
member Manage members
new Create new role for organization or account
policy Manage policies
set Update information about role
Flags:
-h, --help help for role
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai role [command] --help" for more information about a command.
eai rule
Inspect access rules
Usage:
eai rule [command]
Available Commands:
allowed Check if an action is allowed
who-is-allowed List who is allowed the given rule
Flags:
-h, --help help for rule
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai rule [command] --help" for more information about a command.
eai service
Manage services
Usage:
eai service [command]
Available Commands:
get Show information about service
ls List services
new Create new service
role Manage roles
start Enable service
stop Disable service
Flags:
-h, --help help for service
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai service [command] --help" for more information about a command.
eai team
Manage teams
Usage:
eai team [command]
Available Commands:
get Show information about a team
ls List teams
member Manage members
new Create new team
policy Manage policies
role Manage roles
set Update information about team
Flags:
-h, --help help for team
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai team [command] --help" for more information about a command.
eai terms
Get & agree with terms & conditions
Usage:
eai terms [--agree] [<user>] [flags]
Flags:
--agree Agree with terms & conditions
-h, --help help for terms
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai upgrade
Upgrade CLI to the latest version
Usage:
eai upgrade [flags]
Flags:
--check Only check for upgrade
--force Upgrade to latest version regardless of current
-h, --help help for upgrade
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
eai user
Manage users
Usage:
eai user [command]
Available Commands:
get Show information about user(s)
invite Send an invitation and create the associated organization user
ls List users
policy Manage policies
set Update information about user
Flags:
-h, --help help for user
Global Flags:
--no-human-readable Show UUIDs instead of human readable full names
--profile string configuration profile. Overridden by EAI_PROFILE environment variable.
Use "eai user [command] --help" for more information about a command.