Command reference | EZGH Cloud

Generated from ezgh-cli commit 0688df41a869c023cba29d669f3057d941276e55.

Usage

ezgh <command> [flags]

ezgh manages EZGH Cloud from the command line: organizations and projects, IAM (users, bots, groups, policies, API keys), quotas, the Trails audit log, and OCR.

Log in with ezgh login (or ezgh login --device without a browser). Machines use an API key from EZGH_API_KEY instead. Profiles keep separate logins and settings side by side.

Global flags

Every command takes these flags, and -h, --help to print its help.

Flag	Type	Default	Description
`--debug`	boolean		log each request and answer to stderr (never credentials)
`--no-headers`	boolean		leave the header row out of tables
`--org`	string		organization, by ID or slug (default: `EZGH_ORG`, then the profile’s)
`-o`, `--output`	string		output format: table, json or yaml (default: the profile’s, else table)
`--profile`	string		profile to use (default: `EZGH_PROFILE`, then the configured default, then “default”)
`--project`	string		project, by ID, slug or name (default: `EZGH_PROJECT`, then the profile’s)
`--timeout`	duration	`30s`	how long one request may take

Commands

Command	Description
`ezgh auth`	Credentials: status, login, logout, API keys for profiles
`ezgh auth login`	Log in with your EZGH Cloud account (OAuth 2.1)
`ezgh auth logout`	Log out: revoke the profile’s login and forget its credential
`ezgh auth set-api-key`	Store an API key as the profile’s credential, read from stdin
`ezgh auth status`	Show which profile and credential commands use
`ezgh completion`	Generate the autocompletion script for the specified shell
`ezgh completion bash`	Generate the autocompletion script for bash
`ezgh completion fish`	Generate the autocompletion script for fish
`ezgh completion powershell`	Generate the autocompletion script for powershell
`ezgh completion zsh`	Generate the autocompletion script for zsh
`ezgh config`	Read and change the active profile’s settings
`ezgh config get`	Print one of the active profile’s settings, as configured
`ezgh config list`	List the settings commands run with, and where each comes from
`ezgh config set`	Set one of the active profile’s settings
`ezgh config unset`	Clear one of the active profile’s settings
`ezgh iam`	Identity and access: users, invitations, bots, groups, policies, API keys, SCIM, actions, permissions
`ezgh iam actions`	The IAM actions policies can allow or deny
`ezgh iam actions list`	List every IAM action: the platform’s and each registered product’s
`ezgh iam api-keys`	API keys: credentials for code, acting as a user or bot
`ezgh iam api-keys create`	Create an API key for yourself or a bot; the key is shown once
`ezgh iam api-keys delete`	Revoke an API key, by ID, name or prefix
`ezgh iam api-keys list`	List API keys, newest first: every key with apiKeys.list, otherwise your own
`ezgh iam bots`	Bots: non-human members that act through API keys
`ezgh iam bots create`	Create a bot: a non-human member that acts through API keys
`ezgh iam bots delete`	Delete a bot, and with it its API keys
`ezgh iam bots get`	Show a bot, by ID, slug or name
`ezgh iam bots list`	List the organization’s bots
`ezgh iam bots update`	Rename a bot, change its groups, or replace its directly attached policies
`ezgh iam groups`	Groups: policies attached to a group apply to all its members
`ezgh iam groups add-members`	Add users or bots to a group
`ezgh iam groups create`	Create a group
`ezgh iam groups delete`	Delete a group (its members lose the access its policies gave them)
`ezgh iam groups get`	Show a group with its members and policies, by ID, slug or name
`ezgh iam groups list`	List the organization’s groups
`ezgh iam groups remove-members`	Remove users or bots from a group
`ezgh iam groups update`	Change a group’s name or description, or replace its policies
`ezgh iam invitations`	The organization’s invitations (invite with `ezgh iam users invite`)
`ezgh iam invitations get`	Show an invitation, with its accept link
`ezgh iam invitations list`	List the organization’s invitations, newest first
`ezgh iam invitations revoke`	Revoke a pending invitation
`ezgh iam permissions`	Check what you’re allowed to do
`ezgh iam permissions check`	Check whether you may do actions, on the organization or a resource
`ezgh iam policies`	Policies: what users, bots and groups may do
`ezgh iam policies attach`	Attach a policy to a user, bot or group
`ezgh iam policies create`	Create a custom policy
`ezgh iam policies delete`	Delete a custom policy
`ezgh iam policies detach`	Detach a policy from a user, bot or group
`ezgh iam policies get`	Show a policy and its document: a managed policy’s name, or a custom one’s ID, slug or name
`ezgh iam policies list`	List managed and custom policies
`ezgh iam policies update`	Change a custom policy’s name, description or document
`ezgh iam scim`	SCIM provisioning: your identity provider manages people and groups
`ezgh iam scim status`	Show whether SCIM provisioning is on, its base URL, and what it provisioned
`ezgh iam scim tokens`	SCIM tokens: what your identity provider authenticates with
`ezgh iam scim tokens create`	Create a SCIM token for your identity provider; the token is shown once
`ezgh iam scim tokens delete`	Delete a SCIM token, by ID, name or prefix; deleting the last one turns SCIM off
`ezgh iam scim tokens list`	List the organization’s SCIM tokens
`ezgh iam users`	Users: the organization’s people
`ezgh iam users get`	Show a user, by user ID or email
`ezgh iam users invite`	Invite someone into the organization; prints the accept link
`ezgh iam users list`	List the organization’s users
`ezgh iam users remove`	Remove someone from the organization: their groups and policies go, and their API keys are revoked
`ezgh iam users update`	Change the groups a user is in, or replace the policies attached to them directly
`ezgh invitations`	Your own invitations into organizations (needs a login, not an API key)
`ezgh invitations accept`	Accept an invitation, joining its organization
`ezgh invitations decline`	Decline an invitation
`ezgh invitations get`	Show one of your invitations
`ezgh invitations list`	List your pending invitations
`ezgh login`	Log in with your EZGH Cloud account (OAuth 2.1)
`ezgh logout`	Log out: revoke the profile’s login and forget its credential
`ezgh ocr`	OCR: the model catalog, processors, and processing documents
`ezgh ocr models`	OCR models: what each can read, and its versions
`ezgh ocr models get`	Show a model: its versions, capabilities and limits
`ezgh ocr models list`	List the OCR models
`ezgh ocr process`	Read the text in a document (PDF, PNG, JPEG, TIFF, WebP) with a processor
`ezgh ocr processors`	OCR processors: a model and its settings, in a project (`--project`)
`ezgh ocr processors create`	Create a processor: a model and its settings, to process documents with
`ezgh ocr processors delete`	Delete a processor
`ezgh ocr processors disable`	Disable a processor: processing with it is refused until it’s enabled
`ezgh ocr processors enable`	Enable a disabled processor
`ezgh ocr processors get`	Show a processor, by ID, slug or name
`ezgh ocr processors list`	List the project’s OCR processors, newest first
`ezgh ocr processors update`	Change a processor’s name or settings
`ezgh orgs`	Organizations
`ezgh orgs get`	Show an organization (default: the active one), by ID or slug
`ezgh orgs leave`	Leave the organization: your groups, policies and API keys there go
`ezgh orgs list`	List the organizations you belong to
`ezgh profiles`	Profiles: separate logins and settings (work and CI, several organizations)
`ezgh profiles create`	Create a profile
`ezgh profiles delete`	Delete a profile: log it out (revoking its login) and remove its settings and keychain entry
`ezgh profiles list`	List profiles with their domain, identity, and whether their login still works
`ezgh profiles rename`	Rename a profile, moving its credential
`ezgh profiles use`	Make a profile the default
`ezgh projects`	Projects
`ezgh projects create`	Create a project
`ezgh projects delete`	Delete a project
`ezgh projects get`	Show a project (default: the active one), by ID, slug or name
`ezgh projects list`	List the organization’s projects
`ezgh projects update`	Rename a project
`ezgh quotas`	Service quotas: how much of each product the organization may have or use
`ezgh quotas get`	Show one quota, with the value and usage of each scope (project, resource) it has
`ezgh quotas list`	List the organization’s quotas, with values and usage
`ezgh trails`	Trails, the audit log: look up events, or query them with SQL
`ezgh trails events`	Look up events, newest first (the last 7 days unless `--from` says otherwise)
`ezgh trails events get`	Show one event in full
`ezgh trails query`	Trails Query: SQL over the organization’s events, run asynchronously
`ezgh trails query cancel`	Cancel a queued or running query
`ezgh trails query get`	Show a query’s status
`ezgh trails query list`	List query history, newest first (everyone’s with audit.queries.list, else your own)
`ezgh trails query results`	Print a finished query’s rows, or download them as CSV or JSON Lines
`ezgh trails query run`	Run a query: wait for it and print its rows as they’re read
`ezgh trails query schema`	List the trails table’s columns (and, with -o json, the functions queries may use)
`ezgh version`	Print ezgh’s version, commit and build date
`ezgh whoami`	Ask the platform who you are: user or bot, organization, credential