CLI

ezgh is the EZGH Cloud command-line tool. It manages organizations and projects, IAM, service quotas, Trails and OCR through the same public APIs as the console, with your IAM access. People log in with their EZGH Cloud account; code and CI use an API key.

• Install the CLI: the installer for macOS, Linux and Windows, or a release archive.
• Authentication: log in, use an API key, log out.
• Profiles and configuration: separate logins and default settings, the configuration file, environment variables.
• Command reference: every command and flag.

curl -fsSL https://get.ezghcloud.com | sh
ezgh login
ezgh projects list
ezgh trails events --from 2h --event-name DeleteProject

Commands

ezgh <command> --help prints a command’s help.

Naming resources

Commands take an organization by ID or slug (org_k3f9a0x2m7qp); projects, bots, groups, policies and OCR processors by ID, slug or name; and users by ID or email. A name must match exactly one resource, or the command fails. Commands use your organization unless you choose another with --org; commands that work in a project take --project. See Profiles and configuration to set defaults.

Output

Commands print tables by default. -o json and -o yaml print the API’s own objects with the API’s field names, and lists keep the API’s envelope, so the API reference describes the output too:

ezgh projects list

ID                                     SLUG               NAME   CREATED
0199a3c2-6c2f-7e51-8a4b-3d9f7c2e5a81   prj_g7h8i9j0k1l2   web    2026-09-28T10:00:00.000Z

ezgh projects list -o json

{
  "projects": [
    {
      "id": "0199a3c2-6c2f-7e51-8a4b-3d9f7c2e5a81",
      "organizationId": "0199a3c2-5b1e-7d40-9f3a-2c8e6b1d4f70",
      "name": "web",
      "slug": "prj_g7h8i9j0k1l2",
      "resourceName": "ezgh::org_k3f9a0x2m7qp:prj_g7h8i9j0k1l2",
      "createdAt": "2026-09-28T10:00:00.000Z",
      "updatedAt": "2026-09-28T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}

• --no-headers leaves the header row out of tables.
• Results go to standard output. Messages, warnings and errors go to standard error.
• A list reads one page. --limit sets the page size, --all reads every page, and --cursor starts from a page’s nextCursor. When there are more results, a table is followed by a note on standard error, and JSON and YAML have a nextCursor.
• ezgh ocr process prints the document’s text by default; -o json and -o yaml print the full result.
• Secrets that are shown once, such as a new API key, are printed alone on standard output.

Global flags

Every command takes these flags:

Confirmations

Commands that delete or remove something ask for confirmation when standard input is a terminal. Otherwise they fail unless you pass --yes (-y).

Errors and exit codes

Errors go to standard error with the platform’s message and error code, any validation issues, the quota’s limit and usage for a quota refusal, and the request ID.

ezgh retries a request refused with 429 or 503 after the Retry-After it gives, up to 4 attempts, when the wait is at most a minute. A quota_exceeded refusal is never retried. ezgh ocr process retries only when processing couldn’t start (503 capacity_unavailable), because each processing request is billed.