CLI Reference Manual
Note
This documentation was generated using eai version 2.1.1.
eai accessrequest
Manage resource access requests
Usage:
eai accessrequest [command]
Available Commands:
approve Approve an access request
cancel Cancel pending access request(s)
get Show information about access request(s)
ls List resource access requests
reject Reject an access request
set Update a pending access request
Flags:
-h, --help help for accessrequest
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
Use "eai accessrequest [command] --help" for more information about a command.
eai account
Manage accounts
Usage:
eai account [command]
Available Commands:
deactivate Soft-delete the account(s)
get Show information about account(s)
ls List accounts
new Create a new account
reactivate Restore the account(s)
role Manage roles
set Update account information
size Show 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 the EAI_PROFILE environment variable.
Use "eai account [command] --help" for more information about a command.
eai agent
Interactive session with the AI agent
Usage:
eai agent [flags]
Flags:
-h, --help help for agent
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
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 the 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 or create branches of a data resource
chown Change data ownership from an account to another account in the same organization
content List or remove content from a data resource
deactivate Soft-delete the data resource(s)
get Show information about data resource(s)
ls List all data for an account
new Create a new data resource in Toolkit
pull Pull content from a Toolkit data resource
push Push content to a Toolkit data resource
reactivate Restore the data resource(s)
run Launch job from data commands
set Update data resource information
size Show size of data resource(s)
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 the EAI_PROFILE environment variable.
Use "eai data [command] --help" for more information about a command.
eai data branch
Manage branches (tags) of a data resource: list existing branches or create new ones.
Usage:
eai data branch [command]
Available Commands:
add Add a new branch to a data resource
ls List branches of a data resource
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the 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,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
eai data content
Manage the file content of a data resource: list files, display directory trees, or remove files.
Usage:
eai data content [command]
Available Commands:
ls List files for a data resource version
rm Remove content from a data resource
tree Print a data resource directory tree
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
Use "eai data content [command] --help" for more information about a command.
eai data deactivate
Soft-delete one or more data resources. Deactivated data resources cannot be used until reactivated. Accepts ID or fullName.
Usage:
eai data deactivate <id|fullName>... [flags]
Examples:
# Deactivate data(s)
eai data deactivate 577ad5c2-4425-4912-9fbf-79814ge676fd
eai data deactivate OrgName.AccountName1.AccountName2...AccountNameN.DataName
eai data deactivate 577ad5c2-4425-4912-9fbf-79814ge676fd 737ad5c5-4425-4912-9fbf-79814de676dh OrgName.AccountName1.AccountName2...AccountNameN.DataName
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 deactivate
--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 the EAI_PROFILE environment variable.
eai data get
Show detailed information about one or more data resources by ID or fullName.
Usage:
eai data get <id>... [flags]
Examples:
# Show data resource information by ID
eai data get 337ad5c2-4425-4912-9fbf-79814de676fe
# Show data resource information by name
eai data get OrgName.AccountName.DataName
Note :
1. when using a name, all referenced entities must be named (for example, the 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,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the 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|fullName)
eai data ls <337ad5c2-4425-4912-9fbf-79814de676fe|OrgName.AccountName1.AccountName2...AccountNameN>
# List deactivated data too
eai data ls [<parent>] --include-deactivated
# Filter and order data (single/multiple filters/order)
eai data ls [<account>] --field <op>:<value> --order field1,-field2
eai data ls [<account>] --field <value> --order field1
eai data ls [<account>] --field1 <value1> --field2 <op>:<value2> --order field3
# Valid Filter Fields
name, fullName, creator, owner, ownerInherited, created, classification, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation
# Valid Order Fields
id, name, fullName, created, nameAtDeactivation
# Filtering options for each field
eai data ls [<account>] --name <value>
* value formats(dataName) => abc / eq:abc / ne:abc / abc,def / in:abc,def / notin:abc,def / like:%abc% / ilike:%abc% / notlike:%abc% / notilike:%abc% / is:null / isnot:null
* allowed operators => eq, ne, in, notin, like, ilike, notlike, notilike, is, isnot
eai data ls [<account>] --fullName <value>
* value formats(OrgName.AccountName1.AccountName2...AccountNameN.dataName) => snow.abc.data / eq:snow.abc.data / ne:snow.abc.data / snow.abc.sub.data,snow.def.data / in:snow.abc.data,snow.def.data / notin:snow.abc.data,snow.def.data / like:%snow.abc.d% / ilike:%snow.abc.d% / notlike:%snow.abc.b% / notilike:%snow.abc.b% / is:null / isnot:null
* allowed operators => eq, ne, in, notin, like, ilike, notlike, notilike, is, isnot
eai data ls [<account>] --creator <value>
* value formats(type1:value1.type2:value2....|UserID|RoleID) => snow.user:abc / 337ad5c2-4425-4912-9fbf-79814de676fe / eq:snow.role:abc / ne:organization:mila.user:abc / snow.user:gin,mila.fin / in:snow.gin,mila.fin / notin:snow.gin,mila.fin / is:null / isnot:null
* type can be optional if no value conflict
* allowed operators => eq, ne, in, notin, is, isnot
eai data ls [<account>] --owner <value>
eai data ls [<account>] --ownerInherited <value>
* value formats(type1:value1.type2:value2....|UserID) => snow.user:abc / 337ad5c2-4425-4912-9fbf-79814de676fe / eq:snow.user:abc / ne:organization:mila.user:abc / snow.user:gin,mila.fin / in:snow.gin,mila.fin / notin:snow.gin,mila.fin / is:null / isnot:null
* type can be optional if no value conflict
* allowed operators => eq, ne, in, notin, is, isnot
eai data ls [<account>] --created <value>
* value formats(date-time) => gt:2021-01-01T12:00:00Z / lt:2021-01-01 / ge: 2021-01-01T12:00:00Z / le:2021-01-01T12:00:00Z / between:2021-01-01T12:00:00Z,2023-01-01T12:00:00Z / notbetween:2021-01-01T12:00:00Z,2023-01-01
* allowed operators => gt, lt, ge, le, between, notbetween, is, isnot
eai data ls [<account>] --include-deactivated --deactivated <value>
* value formats(true/false) => true / eq:false / ne:true / is:null / isnot:null
* allowed operators => eq, ne, is, isnot
eai data ls [<account>] --include-deactivated --deactivatedInherited <value>
* value formats(true/false) => true / eq:false / ne:true / is:null / isnot:null
* allowed operators => eq, ne, is, isnot
eai data ls [<parent>] --deactivator <value>
* value formats(type1:value1.type2:value2....|UserID|RoleID) => snow.user:abc / 337ad5c2-4425-4912-9fbf-79814de676fe / eq:snow.role:abc / ne:organization:mila.user:abc / snow.user:gin,mila.fin / in:snow.gin,mila.fin / notin:snow.gin,mila.fin / is:null / isnot:null
* type can be optional if no value conflict
* allowed operators => eq, ne, in, notin, is, isnot
eai data ls [<parent>] --reactivator <value>
* value formats(type1:value1.type2:value2....|UserID|RoleID) => snow.user:abc / 337ad5c2-4425-4912-9fbf-79814de676fe / eq:snow.role:abc / ne:organization:mila.user:abc / snow.user:gin,mila.fin / in:snow.gin,mila.fin / notin:snow.gin,mila.fin / is:null / isnot:null
* type can be optional if no value conflict
* allowed operators => eq, ne, in, notin, is, isnot
eai data ls [<account>] --classification <value>
* value formats(string) => 'servicenow public' / eq:'servicenow public' / ne:'servicenow internal restricted' / 'servicenow public,servicenow internal restricted' / in:'servicenow public','servicenow internal restricted' / notin:'servicenow public','servicenow internal restricted' / is:null / isnot:null
* allowed operators => eq, ne, in, notin, is, isnot
eai data ls [<account>] --include-deactivated --nameAtDeactivation <value> --order nameAtDeactivation
* value formats(nameAtDeactivation) => abc / eq:abc / ne:abc / abc,def / in:abc,def / notin:abc,def / like:%abc% / ilike:%abc% / notlike:%abc% / notilike:%abc% / is:null / isnot:null
* allowed operators => eq, ne, in, notin, like, ilike, notlike, notilike, is, isnot
Note :
1. when using name, all subitems must be named (Account must have name...)
Flags:
--all List all data in the cluster
--classification string Filter data by classification
--created string Filter data by created
--creator string Filter data by creator
--deactivated string Filter data by deactivated
--deactivatedInherited string Filter data by deactivatedInherited
--deactivator string Filter data by deactivator
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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")
--fullName string Filter data by fullName
-h, --help help for ls
--include-deactivated List deactivated data
--name string Filter data by name
--nameAtDeactivation string Filter data by nameAtDeactivation
--no-header Don't output header line
--order string Specify order of results
--owner string Filter data by owner
--ownerInherited string Filter data by ownerInherited
--reactivator string Filter data by reactivator
--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 the EAI_PROFILE environment variable.
eai data new
Create a new data resource under the specified account. Optionally push a local directory and/or create a branch in a single command. Accepts ID or fullName for the parent account.
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 and push a 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
# Create new data with duration-based expiration
eai data new DataName --duration 2M15d12h
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe --duration 1y
eai data new OrgName.AccountName.DataName ./dir --duration 3M
# Create new data with absolute expiration date
eai data new DataName --expiration 2024-12-31
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe --expiration 2024-06-15T14:30:00
eai data new OrgName.AccountName.DataName --expiration 2024-12-31
# Create new data with classification
eai data new DataName --classification 'servicenow internal restricted'
eai data new 337ad5c2-4425-4912-9fbf-79814de676fe --classification 'servicenow public'
eai data new OrgName.AccountName.DataName --classification 'research only'
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Note, when pushing a local directory, set the flag --verbose to see upload progress.
Note, duration supports years (y), months (M), days (d), hours (h), minutes (m), seconds (s)
Note, only one of --duration or --expiration can be specified, not both.
Flags:
--arg stringArray Template argument e.g. Name=Value
--branch string branch to create (e.g. v1) of data
--classification string Data classification
--duration string Duration of the data with units (ns, us, ms, s, m, h, d, M, y) (e.g., 15m, 2d, 1M15d, 1y6M, 2y3M5d12h)
--expiration string Expiration date for the data (format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
eai data pull
Download files from a data resource to a local directory. Supports pulling a specific version or branch with @<version>, individual files or directories, and renaming on download.
Usage:
eai data pull <id>[@<version>] [[<remote/directory>[/<file_name>[:<new_file_name>]]] <./directory>] [flags]
Examples:
# Pull the latest version of a data resource to a 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 part of your default account)
eai data pull AccountName.DataName ./directory/ (if AccountName is part of your personal organization)
# Pull a specific version or branch of a data resource to a 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' in 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' in 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, when pulling content, set the flag --verbose to see download progress.
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
eai data push
Upload local files or directories to an existing data resource. Supports pushing to a specific version or branch with @<version>, and mapping local paths to a remote prefix with --remote-root.
Usage:
eai data push <id>[@<version>] [<path>...] [flags]
Examples:
# Push the current directory to a data ID (latest version).
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe
eai data push OrgName.AccountName.DataName
eai data push DataName (if DataName is part of your default account)
eai data push AccountName.DataName (if AccountName is part of your personal organization)
# Push to a specific version or branch (version or branch must exist).
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe@v0.0.1
eai data push 337ad5c2-4425-4912-9fbf-79814de676fe@7e8e22412cb5c8e17bdcdc5b09e55b91
eai data push OrgName.AccountName.DataName@v0.0.1
eai data push OrgName.AccountName.DataName@7e8e22412cb5c8e17bdcdc5b09e55b91
# Push selected files or a subdirectory (partial update). Paths are preserved
# by default, so dir/file.txt arrives at dir/file.txt on the data resource.
eai data push OrgName.AccountName.DataName path/to/file1.txt
eai data push OrgName.AccountName.DataName path/to/file1.txt path/to/file2.txt
eai data push OrgName.AccountName.DataName path/to/dir/
# Per-include rename via "<src>:<dst>" requires --allow-rename. Without
# the flag, all positional paths are taken literally (so filenames that
# legitimately contain ":" are pushed as-is). With the flag:
# file1.txt is renamed; dir/ is relocated under remote_dir/.
eai data push OrgName.AccountName.DataName --allow-rename path/to/file1.txt:renamed/file1.txt
eai data push OrgName.AccountName.DataName --allow-rename path/to/dir:remote_dir
# Read the file list from a file or stdin (ARG_MAX-safe; spaces in names are OK).
eai data push OrgName.AccountName.DataName --files-from list.txt
git ls-files | eai data push OrgName.AccountName.DataName --files-from -
# Drop the directory structure: every file lands at the data root using just
# its basename (or under --remote-root when combined).
eai data push OrgName.AccountName.DataName --flatten path/to/file1.txt path/to/file2.txt
# Prefix every uploaded file with a remote directory on the data resource.
# With preserve (default): dir/file.txt -> remote_dir/dir/file.txt
# With --flatten: dir/file.txt -> remote_dir/file.txt
eai data push OrgName.AccountName.DataName --remote-root remote_dir path/to/file1.txt
eai data push OrgName.AccountName.DataName --remote-root remote_dir --flatten path/to/file1.txt
# Use --verbose to see per-file upload progress.
eai data push OrgName.AccountName.DataName --verbose
Note, when using name, all entities referenced in the ID must be named (e.g. Account must have a name)
Note, when pushing a local directory, set the flag --verbose to see upload progress.
Flags:
--allow-rename Honor the "<src>:<dst>" rename suffix on each positional include (rename the file's wire path on the data resource). Without this flag, paths are taken literally so filenames containing ":" Just Work.
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--files-from string Read newline-separated list of files to push from a file ("-" for stdin)
--flatten Flatten directory structure: push every file at the data root (or under --remote-root) using just its basename
--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
--remote-root string Prefix every uploaded file with this directory on the data resource
--verbose Verbose mode
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
eai data reactivate
Restore one or more previously deactivated data resources, making them usable again.
Usage:
eai data reactivate <id>... [flags]
Examples:
# Reactivate data(s)
eai data reactivate 577ad5c2-4425-4912-9fbf-79814ge676fd
eai data reactivate 577ad5c2-4425-4912-9fbf-79814ge676fd 737ad5c5-4425-4912-9fbf-79814de676dh
Flags:
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 reactivate
--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 the 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,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
eai data set
Update properties of a data resource, such as name, owner, description, classification, or tags.
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 renames "DataName" to "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
# Update expiration with duration
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --duration 6M
eai data set OrgName.AccountName.DataName --duration 1y3M15d
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --duration 2M15d12h
# Update expiration with absolute date
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --expiration 2024-12-31
eai data set OrgName.AccountName.DataName --expiration 2024-06-15T14:30:00
# Update classification
eai data set 337ad5c2-4425-4912-9fbf-79814de676fe --classification 'servicenow internal restricted'
Note: duration supports years (y), months (M), days (d), hours (h), minutes (m), seconds (s)
Note: only one of --duration or --expiration can be specified, not both.
Flags:
--classification string Data classification
--duration string Duration of the data with units (ns, us, ms, s, m, h, d, M, y) (e.g., 15m, 2d, 1M15d, 1y6M, 2y3M5d12h)
--expiration string Expiration date for the data (format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)
--field strings Alias to --fields, but setting --no-header automatically when there is only one field in the table format (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation (default [id,fullName,creator,created,expiration,ownerInherited,classification])
--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 the EAI_PROFILE environment variable.
eai data size
Show the total storage size of one or more data resources by ID or fullName.
Usage:
eai data size <id>... [flags]
Examples:
# Show data resource 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
# Show data resource size by name(s)
eai data size OrgName.AccountName.DataName
eai data size OrgName.AccountName.DataName OrgName.AccountName.DataName
# Show data resource size
eai data size
Note :
1. when using a name, all referenced entities must be named (for example, the 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,fullName,creator,created,ownerInherited,size,calculated_on])
--fields strings Comma separated list of fields to format. Allowed fields: id, urn, organization, account, name, fullName, creator, created, expiration, owner, ownerInherited, tags, tags.key, tags.value, classification, storage, metadata, version, state, branch, lastAccessed, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, size, calculated_on, branches (default [id,fullName,creator,created,ownerInherited,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 the EAI_PROFILE environment variable.
eai docker
Docker registry commands
Usage:
eai docker [command]
Available Commands:
get-login Print a Docker login command
get-registry Get Toolkit 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 the EAI_PROFILE environment variable.
Use "eai docker [command] --help" for more information about a command.
eai docker get-login
Print the docker login command to authenticate with the Toolkit container registry.
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 the EAI_PROFILE environment variable.
eai docker get-registry
Get Toolkit 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 the 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 the 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 for a job
kill Kill one or more jobs
log Show 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 job information
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 the 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 the EAI_PROFILE environment variable.
eai job exec
Run a command inside a running job's container. If the job is not running yet, exec will wait until it starts. Use --last to target the most recently created 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 the EAI_PROFILE environment variable.
eai job get
Show detailed information about one or more jobs by ID. Use --last to show the most recently submitted job.
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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 the EAI_PROFILE environment variable.
eai job info
Display the complete job specification in YAML format, including all fields. Use --last for the most recently submitted 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 the EAI_PROFILE environment variable.
eai job kill
Cancel one or more running or queued jobs. Use --last to target the most recently submitted job, or --wait to block until jobs reach the CANCELLED state.
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 (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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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
--wait Wait for each job to reach the CANCELLED state
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
eai job log
Show job logs
If the job is not running yet (for example, 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:
# Show logs for the last submitted job
eai job log --last
# Show logs for a job
eai job log 337ad5c2-4425-4912-9fbf-79814de676fe
# Show and follow logs for 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 last N lines of the logs
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
eai job ls
List jobs matching the given filters. By default shows live jobs or jobs that finished in the last 24 hours.
Usage:
eai job ls [flags]
Examples:
# List your live jobs or jobs that have finished in the last 24 hours in your account
eai job ls
# List all your jobs
eai job ls --me
# List jobs for a user
eai job ls --user [org.user_name|user_id]
# List jobs for a service
eai job ls --service [org.account.service_name|service_id]
# List jobs for an account
eai job ls --account [org.account|account_id]
# List jobs for an organization
eai job ls --organization [org|organization_id]
# List all jobs
eai job ls --all
# List jobs in all states
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
# List replica jobs only
eai job ls --replica-jobs
# List any replica rank jobs
eai job ls --all-replica-rank
Flags:
--account string Account ID/Name to use (if empty use default account)
--all List all jobs
--all-replica-rank Show all replica rank jobs instead of only jobs with replica rank 0
-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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 Replica group ID filter. Display jobs belonging to the specified replica 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 24 hours)
-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 the EAI_PROFILE environment variable.
eai job new
Submit a new job to the cluster with the specified scheduling mode, image, resources, and command.
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
# Submit a replica job with elastic failure tolerance (allows 2 failures out of 10)
eai job new --replicas 10 --replica-failures-allowed 2 -i pytorch:latest -- python train.py
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).
--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 fullName.
-n, --dry-run Do not submit, display YAML job spec to stdout and exit.
--enforce-name Automatically rename 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 the 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 the job access to InfiniBand devices
-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 and/or outgoing network. Use "out", "in", or "all"
--no-header Don't output header line
--non-preemptable Forbid interrupting the job. (will run for a maximum of 48h)
--preemptable Allow job to be interrupted.
-p, --priority string Priority for the job (used in computing priority). Valid values: background, low, regular, high, critical. (default: regular)
--replica-failures-allowed int Number of replica failures allowed before terminating entire group (0 = no tolerance, default: 0)
--replica-master-port int Master port number for replica 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 expressions to use user permissions. Syntax: --scopes @scopes.json or --scopes '...'
--tag stringArray Tags (default [])
--tunnel Start a sidecar tunnel to allow port-forwarding.
--url Show job's URL
--wait string Wait until job reaches the specified state before returning. Valid states: QUEUING, QUEUED, RUNNING, CANCELLING, CANCELLED, INTERRUPTED, FAILED, or SUCCEEDED. Case-insensitive; comma-separated for multiple states. Example: --wait RUNNING
-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 the EAI_PROFILE environment variable.
eai job port-forward
Create SSH tunnels between local and remote ports on a running job. Supports forward and reverse tunneling. Use --last to target the most recently created 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 the EAI_PROFILE environment variable.
eai job retry
Resubmit one or more previously cancelled, failed, or interrupted jobs. Use --last to retry the most recently submitted 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
# Retry a job and wait until it reaches RUNNING (bare --wait defaults to RUNNING)
eai job retry --wait 337ad5c2-4425-4912-9fbf-79814de676fe
# Retry a job and wait for a specific state (note the "=" form)
eai job retry --wait=SUCCEEDED 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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
--wait string[="RUNNING"] Wait until job reaches the specified state before returning. Valid states: QUEUING, QUEUED, RUNNING, CANCELLING, CANCELLED, INTERRUPTED, FAILED, or SUCCEEDED. Case-insensitive; comma-separated for multiple states. Defaults to RUNNING when given without a value; use the "=" form for an explicit state. Example: --wait or --wait=SUCCEEDED
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
eai job role
Manage roles
Usage:
eai job role [command]
Available Commands:
deactivate Soft-delete the role(s)
get Show information about role(s)
key Manage long-lived access keys
member Manage members
policy Manage policies
reactivate Restore the role(s)
request-access Request access to a resource for a role
set Update role information
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 the EAI_PROFILE environment variable.
Use "eai job role [command] --help" for more information about a command.
eai job set
Update properties of a job, such as name or bid. Use --last to target the most recently submitted job.
Usage:
eai job set (--last|<id>) [flags]
Examples:
# Set the job name
eai job set 337ad5c2-4425-4912-9fbf-79814de676fe --name "test"
# Remove name from last job
eai job set --last --name ""
# Set the bid for one job to 10
eai job set --bid 10 337ad5c2-4425-4912-9fbf-79814de676fe
# Set the bid for 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,priority,resources.replicas,command,runs.exitCode,accessUrl])
--fields strings Comma separated list of fields to format. Allowed fields: command, data, data.data, data.source, data.version, data.source_mode, data.destination, data.destination_mode, environmentVars, image, isProcessAgent, role, scopes, workdir, resources, 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, replicaFailuresAllowed, name, owner, tags, tags.key, tags.value, options, urn, fullName, account, alive, creator, created, ownerInherited, id, organization, deactivated, deactivatedInherited, deactivator, reactivator, nameAtDeactivation, 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.stateInfo, runs.exitCode, runs.resourceUsageUrl, runs.nodeName, runs.cancelRequestedBy, runs.createdBy, state, stateInfo, totalRuntime, updatedOn, accessUrl, resourceUsageUrl, processAgent, replicaGroupId, replicaRank, priority, children (default [id,state,name,replicaGroupId,account,creator,created,priority,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 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 the 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 for Toolkit
Flags:
-c, --docker-config string Docker configuration file to use
-n, --docker-dry-run Do not write the new Docker configuration. Print it to 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 the 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:
deactivate Soft-delete the organization
get Show information about organization(s)
ls List organizations
new Create a new organization
reactivate Restore the organization
role Manage roles
set Update organization information
size Show 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 the 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:
deactivate Soft-delete the Private Registry resource(s)
get Show information about Private Registry(ies)
ls List Private Registries
new Create a new Private Registry
reactivate Restore the Private Registry resource(s)
set Update Private Registry information
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 the EAI_PROFILE environment variable.
Use "eai privateregistry [command] --help" for more information about a command.
eai profile
Manage profiles
Usage:
eai profile [command]
Available Commands:
add Add a new profile
current Display current profile information
get Show profile information
ls List profiles
rm Remove a profile from the configuration
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 the EAI_PROFILE environment variable.
Use "eai profile [command] --help" for more information about a command.
eai proxy
Start a local HTTP proxy that forwards requests to the Toolkit API with your credentials.
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 the 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 the 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 the 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:
deactivate Soft-delete the role(s)
get Show information about role(s)
key Manage long-lived access keys
ls List roles in an organization or account or team
member Manage members
new Create a new role for an organization, account, or team
policy Manage policies
reactivate Restore the role(s)
request-access Request access to a resource for a role
set Update role information
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 the 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 users and roles allowed by a 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 the 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:
deactivate Soft-delete the service(s)
get Show information about service(s)
ls List services
new Create a new service
reactivate Restore the service(s)
role Manage roles
set Update service information
start Start the service
stop Stop the service
update Update the service's job spec (eai.yaml)
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 the 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:
deactivate Soft-delete the team(s)
get Show information about team(s)
ls List teams
member Manage members
membership Show roles and teams that a team is a member of
new Create a new team
policy Manage policies
reactivate Restore the team(s)
request-access Request access to a resource for a team
role Manage roles
set Update team information
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 the EAI_PROFILE environment variable.
Use "eai team [command] --help" for more information about a command.
eai terms
View and agree to terms and 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 the 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 the EAI_PROFILE environment variable.
eai user
Manage users
Usage:
eai user [command]
Available Commands:
deactivate Soft-delete the user(s)
get Show information about user(s)
invite Send an invitation and create the associated organization user
ls List users
membership Show roles and teams that a user is a member of
policy Manage policies
reactivate Restore the user(s)
request-access Request access to a resource for a user
set Update user information
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 the EAI_PROFILE environment variable.
Use "eai user [command] --help" for more information about a command.
eai version
CLI version utilities
Usage:
eai version [command]
Available Commands:
check Check the current CLI version against a constraint (exit 0 if satisfied, exit 2 if not)
get Print the current CLI version
Flags:
-h, --help help for version
Global Flags:
--no-human-readable Show UUIDs instead of human-readable full names
--profile string Configuration profile. Overridden by the EAI_PROFILE environment variable.
Use "eai version [command] --help" for more information about a command.