Docyrus CLI

Guide for using the docyrus CLI to interact with the Docyrus platform from the terminal.

Command Overview

See references/cli-manifest.md for complete command reference with all flags and arguments.

Common Workflows

First-Time Setup

1. Authenticate: docyrus auth login
2. Select tenant: docyrus auth tenants use --tenantId <id>
3. Verify: docyrus auth who

Discover API & Entities

Download the tenant OpenAPI spec and explore available endpoints and entities:

# Download/refresh tenant OpenAPI spec
docyrus discover api --json

# List all API namespaces (e.g. /v1/users, /v1/teams)
docyrus discover namespaces --json

# List endpoints under a path prefix (with or without /v1)
docyrus discover path /v1/users --json
docyrus discover path /teams --json

# Get full endpoint details (defaults to GET; use [METHOD] prefix for others)
docyrus discover endpoint /v1/users/me --json
docyrus discover endpoint [PUT]/v1/users/me/photo --json

# Get full entity/schema definition
docyrus discover entity UserEntity --json

# Search endpoints and entities by comma-separated terms
docyrus discover search users,UserEntity --json

Discover Data Sources

1. List apps: docyrus apps list
2. Get metadata: docyrus ds get <appSlug> <dataSourceSlug>

Query Records (ds list)

Basic listing:

docyrus ds list crm contacts --columns "name, email, phone" --limit 20

With filters (JSON object):

docyrus ds list crm contacts \
  --columns "name, email" \
  --filters '{"rules":[{"field":"status","operator":"=","value":"active"}]}'

With relation expansion:

docyrus ds list crm contacts \
  --columns "name, ...related_account(account_name, account_phone)"

Date shortcut filter:

docyrus ds list crm tasks --filters '{"rules":[{"field":"created_on","operator":"this_month"}]}'

See references/list-query-examples.md for comprehensive filter, sort, pagination, and combined query examples.

CRUD Operations

Create:

docyrus ds create crm contacts --data '{"name":"Jane Doe","email":"jane@example.com"}'

Update:

docyrus ds update crm contacts <recordId> --data '{"phone":"+1234567890"}'

Delete:

docyrus ds delete crm contacts <recordId>

Arbitrary API Calls

docyrus curl /v1/users/me
docyrus curl /v1/dev/apps -X GET --format json
docyrus curl /v1/some/endpoint -X POST -d '{"key":"value"}'

Key Rules

• Arguments use appSlug and dataSourceSlug (not IDs) — run docyrus apps list and docyrus ds get to discover slugs
• --filters accepts a JSON string following the filter group structure: {"combinator":"and","rules":[...]}
• Filter operators include: =, !=, >, >=, <, <=, like, not like, in, not in, empty, not empty, between, today, this_month, this_quarter, last_30_days, active_user
• Filter on related fields using rel_<relation_slug>/<field_slug> syntax
• --columns uses comma-separated field slugs with support for relation expansion (), spread ..., aliasing :, and functions @
• --format controls output: toon (default table), json, yaml, md, jsonl
• --verbose wraps response in full envelope with metadata

References

• CLI Manifest — Complete command reference with all flags, arguments, and options.
• List Query Examples — Practical ds list examples covering columns, filters, sorting, pagination, and combined queries.