Skip to main content
View Markdown

Coding Agents

This path is for coding agents, automation scripts, and operational tools working with ZeyOS. Every task starts by choosing one of three routes:

RouteUse it forInterfaces
Build a ZeyOS appNative manifests, services, resources, weblets, hooks and settingsiXML/Zymba, zeysdk
Connect an external applicationSoftware outside ZeyOS that reads or writes itCLI, MCP, @zeyos/client, REST
Use ZeyOS business dataQuestions and explicitly requested record operationsThe 15 domain skills, through the CLI or MCP

Install the zeyos router skill, and the agent classifies tasks itself:

Bash
zeyos skills install zeyos --target claude --global
zeyos skills verify --target claude --global

An explanation, code edit, review or validation-only task must never trigger a live query, compile, push or run, and loading a skill authorizes nothing. For harness configuration, including OpenCode V2, see Agent Setup. Native work also uses the copyable project instructions; the separate ZeyOS SDK provides compilation checks without executing the source, and runtime tests are a separate step.

Start Here​

For Connect an external application and Use ZeyOS business data, start with the CLI:

NeedRecommended interfaceWhy
Fast CRUD against common business resourceszeyosHuman-readable help, JSON output, built-in auth flow, safe delete confirmation
Reliable shell automation and pipelineszeyos --jsonStable machine-readable output, easy to combine with jq and scripts
Access beyond the CLI's curated resource registry@zeyos/clientCovers the full generated API surface
Non-JavaScript or custom HTTP clientsREST/OpenAPIRaw endpoint and schema reference
  1. Follow the Agent Quickstart to authenticate and make your first read/write calls.
  2. Use Agent Recipes for common ticket, account, task, and project workflows.
  3. Check CLI Coverage and Escalation whenever you need a resource or request shape the CLI does not expose directly.

Working Rules​

  • Prefer --json for agent-driven flows.
  • Prefer filters-style JSON payloads in CLI examples so the transition to @zeyos/client stays consistent.
  • Use visibility: 0 on resources that have the column — accounts, contacts, tickets, tasks, projects, items, documents, notes, opportunities, appointments, campaigns, mailinglists, storages, contracts, ledgers — unless you want archived (1) or deleted (2) records. Most other resources have no visibility column — transactions (and every billing/procurement entity), payments, messages, actionsteps, addresses, users, prices, dunning — and filtering on it there returns an opaque HTTP 400. Check with zeyos describe <entity> when unsure.
  • Treat delete as destructive. The CLI prompts by default; use --force only in deliberate automation.
  • Switch to the JavaScript client when the task needs unsupported resources, browser/session behavior, or low-level request control.