Docyrus CLITerminal-first · Multi-tenant

Operate Docyrus from the command line

Authenticate once, switch environments and tenants, inspect OpenAPI, manage schemas, query live data, call the API directly, and run AI-assisted workflows across the Docyrus Platform from one terminal.

Sign Up for DocyrusView GitHub

One terminal control plane for the full Docyrus Platform

Docyrus CLI compresses platform setup, data operations, schema management, API discovery, and operator tooling into a single workflow that fits how technical teams actually work.

Session bootstrap

Environment, auth, and tenant context

Move between live, beta, alpha, and dev environments. Keep local or global settings, switch accounts and tenants, and preserve command context in structured output.

Device Code loginAccount switchingTenant switching
docyrus env list --json

docyrus auth login --clientId "83a8df32-3738-4b5a-a0c7-87976adb1631" --json

docyrus auth tenants use 1002 --json
Schema + data

Schema and data workflows

Use `studio` for developer-facing schema CRUD and `ds` for tenant-aware record operations, including filtering, bulk updates, file input, and live metadata access.

Data source CRUDField and enum updatesRecord list/create/update/delete
docyrus studio list-data-sources --appSlug crm --expand fields --json

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

docyrus ds update crm contacts REC_102 --data '{"status":"active"}'
Discover + call

OpenAPI discovery and direct API access

Inspect namespaces, endpoints, entities, and cached tenant specs without leaving the terminal, then drop into `docyrus curl` when you need direct request-level control.

OpenAPI cacheEndpoint searchDirect requests
docyrus discover namespaces --json

docyrus discover endpoint /v1/users/me --json

docyrus curl /v1/users/me -i
Operator tooling

Operator helpers for AI and browser workflows

Run `docyrus ai` for agent chat, use Chrome automation helpers, or launch the Bun-powered TUI when a visual terminal workflow fits better than raw commands.

AI chatChrome helpersInteractive TUI
docyrus ai "Summarize open incidents"

docyrus chrome content https://status.acme.app

docyrus tui
Install

Install and start in minutes

The CLI is designed to move from setup to useful work fast: install the package, authenticate, and immediately begin working against your tenant context.

Local or global settingsJSON output when neededContext included in successful results
Install
pnpm add -g @docyrus/docyrus
First login
docyrus auth login --clientId "83a8df32-3738-4b5a-a0c7-87976adb1631" --json

docyrus auth who --json

What You Can Run

Docyrus CLI is for real terminal workflows: onboarding a project, switching tenants, shaping schema, inspecting the API, running data tasks, and supporting operator automation without juggling multiple tools.

Common workflows

Three high-value patterns technical teams run with Docyrus CLI.

Bootstrap operator context

Authenticate with Device Code, resolve active tenant context, and move cleanly across live, beta, alpha, and local environments.

Shape schema and query live data

List data sources, update fields and enums, query records with filters and formulas, and call tenant-specific endpoints from the same shell flow.

Run AI and browser-assisted tasks

Combine AI chat, Chrome automation, API discovery, and the terminal UI for support, ops, and debugging workflows that need more than a raw REST client.

Frequently asked questions about Docyrus CLI

What is Docyrus CLI?+

Docyrus CLI is the terminal interface for authenticating into Docyrus, switching environments and tenants, inspecting OpenAPI, managing schema, querying data, and running operator workflows from the command line.

When should developers use Docyrus CLI?+

Developers should use it when they want fast terminal workflows for platform setup, schema management, discovery, data operations, or AI-assisted operator tasks without moving across multiple tools.

What can teams ship with Docyrus CLI?+

Teams can ship bootstrap scripts, admin workflows, schema updates, record operations, tenant-aware automation, and terminal-first tooling around the Docyrus platform.

How does Docyrus CLI fit with other Docyrus developer tools?+

It works alongside the REST API, Data MCP, and Docyrus apps as the terminal control surface for developers, operators, and AI-assisted workflows.

Use the terminal as your control plane for the Docyrus Platform

Start with authentication and environment context, then move from discovery to data and schema operations without switching out of your CLI workflow.

Sign Up for DocyrusView GitHub