Commands Reference

Complete reference for every CLI command, with options and examples.

Global Options

These options work with any command:

Option	Description
--json	Output as formatted JSON
--yaml	Output as YAML
--no-color	Disable ANSI color output
-h, --help	Show help for a command

---

login

Authenticate with a ZeyOS instance via OAuth 2.0 authorization code flow.

Text

zeyos login [options]

Option	Description
--base-url <url>	ZeyOS platform URL
--client-id <id>	OAuth application ID
--secret <secret>	OAuth application secret
--scope <scope>	OAuth scope
--port <port>	Local callback port (default: 9005)
--global	Save credentials to global config
--force	Overwrite existing credentials
--clean	Discard saved config and re-prompt for everything
--manual	Don't open browser; paste code manually

Examples:

Bash

# Interactive login (prompts for missing values)
zeyos login

# Pre-fill connection values; the OAuth browser/code step still runs
zeyos login --base-url https://cloud.zeyos.com/demo \
            --client-id myapp --secret "$ZEYOS_CLIENT_SECRET"

# Start fresh, ignore any saved credentials
zeyos login --clean

# Manual mode (useful in SSH / headless environments)
zeyos login --manual

info

When values are not provided as flags, the CLI prompts interactively for the ZeyOS URL, application ID, and application secret. The secret prompt does not echo input. For CI or fully unattended agents, provide ZEYOS_BASE_URL, ZEYOS_TOKEN, and optionally ZEYOS_REFRESH_TOKEN, ZEYOS_CLIENT_ID, and ZEYOS_CLIENT_SECRET through the environment instead of running zeyos login.

---

logout

Revoke the stored token and clear saved credentials.

Text

zeyos logout [--global]

Option	Description
--global	Clear global credentials instead of local

Examples:

Bash

zeyos logout          # Clear local .zeyos/auth.json tokens
zeyos logout --global # Clear ~/.config/zeyos/credentials.json tokens

---

whoami

Show information about the currently authenticated user.

Text

zeyos whoami [--json|--yaml]

Examples:

Bash

zeyos whoami          # Table output
zeyos whoami --json
zeyos whoami --show-token --json   # explicitly include the current access token

---

list

Query and list records for a resource with filtering, sorting, and pagination.

Text

zeyos list <resource> [options]

Option	Description
--fields <fields>	Field selection — comma-separated, JSON object, or JSON array (see below)
--filter <json>	Filter criteria — JSON object
--sort <fields>	Sort fields, comma-separated (prefix + asc, - desc)
--limit <n>	Maximum records to return (default: 50)
--offset <n>	Skip the first n records
--expand <fields>	Expand JSON/binary columns (e.g. binfile, items)
--extdata	Include extended data fields
--json	JSON output
--yaml	YAML output

Fields format:

The --fields option supports three formats:

Format	Example
Comma-separated	--fields ID,name,status
JSON object (with aliases)	--fields '{"Name":"lastname","City":"contact.city"}'
JSON array	--fields '["ID","name","status"]'

Examples:

Bash

# List tickets with default configured fields
zeyos list tickets

# Custom filters
zeyos list tickets --filter '{"status":1,"priority":3}'

# Specify fields with aliases
zeyos list accounts --fields '{"Name":"lastname","City":"contact.city"}'

# Comma-separated fields
zeyos list tickets --fields ID,name,status,priority

# Sort by multiple columns
zeyos list tickets --sort "+name,-lastmodified"

# Pagination
zeyos list tickets --limit 10 --offset 20

# Include extended data
zeyos list tickets --extdata

# JSON output for scripting
zeyos list tickets --json | jq length

Pagination Info

When results fill the page limit, the CLI makes a second API call to get the total count and displays:

Text

Showing 1–10 of 47  (--offset 10 for next page)

---

count

Count records for a resource, with optional filtering. Returns a plain number by default.

Text

zeyos count <resource> [options]

Option	Description
--filter <json>	Filter criteria — JSON object
--json	Output as {"count": N}
--yaml	YAML output

Examples:

Bash

# Total tickets
zeyos count tickets
# → 47

# Filtered count
zeyos count tickets --filter '{"status":1}'
# → 12

# JSON output for scripting
zeyos count accounts --json
# → {"count": 156}

---

get

Fetch a single record by ID.

Text

zeyos get <resource> <id> [options]

Option	Description
--fields <fields>	Field selection — comma-separated, JSON object, or JSON array
--extdata	Include extended data fields
--tags	Include tags
--all	Fetch all data (extdata + tags + all fields)
--json	JSON output
--yaml	YAML output

Aliases: show

Examples:

Bash

# Get a ticket with configured fields
zeyos get ticket 42

# Include extended data
zeyos get ticket 42 --extdata

# Include tags
zeyos get ticket 42 --tags

# Include both extdata and tags
zeyos get ticket 42 --extdata --tags

# Get everything — all fields, extdata, and tags
zeyos get ticket 42 --all

# JSON output
zeyos get account 15 --json

# Using the alias
zeyos show ticket 42

Date Formatting

Date fields like duedate, lastmodified, and creationdate are automatically formatted as YYYY-MM-DD in table/record output. Raw Unix timestamps are preserved in JSON and YAML output. The format is configurable via dateFormat in your auth config file.

---

create

Create a new record. Fields can be provided as a JSON blob or as individual flags.

Text

zeyos create <resource> [--data <json>] [--field value ...]

Option	Description
--data <json>	Complete record as a JSON string
--<field> <value>	Set individual field (any unknown flag becomes a field)

Examples:

Bash

# Using --data JSON
zeyos create ticket --data '{"name":"Fix login bug","status":0,"priority":3}'

# Using individual field flags
zeyos create ticket --name "Fix login bug" --status 0 --priority 3

# Create an account
zeyos create account --name "ACME Corp" --visibility 0

# JSON output (returns the created record)
zeyos create ticket --name "New feature" --json

Type Coercion

Field values are automatically coerced: "true" → true, "false" → false, "null" → null, and numeric strings become numbers. This means --status 0 sends the integer 0, not the string "0".

---

update

Update an existing record by ID. Same input modes as create.

Text

zeyos update <resource> <id> [--data <json>] [--field value ...]

Aliases: edit

Examples:

Bash

# Using --data JSON
zeyos update ticket 42 --data '{"status":4}'

# Using field flags
zeyos update ticket 42 --status 4 --priority 2

# Update account name
zeyos update account 15 --name "ACME Corporation"

---

delete

Delete a record by ID. Prompts for confirmation by default.

Text

zeyos delete <resource> <id> [--force]

Option	Description
--force	Skip confirmation prompt

Aliases: rm, remove

Examples:

Bash

# Interactive confirmation
zeyos delete ticket 42

# Skip confirmation
zeyos delete ticket 42 --force

# Using aliases
zeyos rm ticket 42
zeyos remove ticket 42

---

resources

List all curated CLI resources and their operations. This is the authoritative boundary for what the CLI supports directly.

Text

zeyos resources

Shows a table of all CLI-supported resource types and available operations.

---

describe

Show a resource's schema — fields, types, foreign keys and enum values — from the generated schema. Runs offline (no login required), so an agent can discover the data model before making any call.

Text

# Field/type/enum/foreign-key listing for a resource
zeyos describe tickets

# Machine-readable schema
zeyos describe accounts --json

Foreign keys are shown as → <table>, and enum fields list their valid values (e.g. status → 0=NOTSTARTED 1=AWAITINGACCEPTANCE …). The operations available for the resource are listed at the bottom.

---

skills

Discover and install the bundled ZeyOS agent skill packs into the local project, so a coding agent (Claude, Codex, …) operates against ZeyOS with the right conventions out of the box.

Text

# List the bundled skills
zeyos skills list

# Print a skill's instructions
zeyos skills show zeyos-work-management

# Install all skills (or named ones) into the project
zeyos skills install
zeyos skills install zeyos-billing-insights --target claude

Options for install:

Option	Description
--target claude|codex	Where to install (default: auto-detect, fallback .claude/skills)
--force	Overwrite existing skill folders

Skills are copied into <target>/skills/<name>/, with the shared reference files installed alongside (<target>/skills/shared/) so the skills' ../shared/… links resolve.

---

Command Aliases

Alias	Equivalent
show	get
edit	update
rm	delete
remove	delete
resource	resources
skill	skills