ApexDocsOpen Apex
Developer

Agent tools: SOS, brand, schema, and skills

Use Apex CLI agent-oriented commands for brand context, SOS handoffs, command schema introspection, and local skill installation.

These commands are designed for automation and external agent workflows. They expose public CLI behavior only; internal dashboards, internal API routes, and operations runbooks are not part of this reference.

Documentation for AI tools

AI tools can discover the concise documentation index at /llms.txt or read the complete documentation corpus at /llms-full.txt. Both files are generated from the same manifest as this site, so their page lists stay current.

Brand context

bash
apex brand
apex brand --json

apex brand reads the current shop brand context. Human output prints the prompt-ready brand block when one exists. JSON output returns brandContext, or null with a message when no profile exists yet.

Use this before generating customer-facing experiment copy so external agents inherit the same brand grounding as Apex-managed workflows.

SOS tickets

bash
apex sos create \
  --type qa \
  --experiment 00000000-0000-4000-8000-000000000040 \
  --sub-class "tracking evidence missing" \
  --loom https://www.loom.com/share/example \
  --description @sos-description.md
 
apex sos mine --json
CommandFlagsBehavior
apex sos create--type <type>, --loom <url>, --experiment <id>, --sub-class <text>, --description <text-or-@file>, optional [description] argumentCreates an Apex SOS ticket through the API; with --experiment it appends to that experiment's open ticket of the same type when one exists. Without --experiment, the CLI now always opens a new Jira ticket instead of appending to the shop's oldest open ticket of the same type.
apex sos mineNone beyond global flagsLists tickets created by the current API key.

SOS type values are full_handover, design, development, qa, config, bug, and help. The default type is qa. Bug reports and help requests work with shop API keys; the internal handover, design, development, QA, and config types require a DRIP user account with platform access.

Schema introspection

bash
apex schema --json

apex schema prints the current command tree, aliases, argument metadata, options, descriptions, default values, nested commands, and a body JSON Schema for commands with a documented request document. Agents should call this before scripting unfamiliar commands.

Field semantics

FieldMeaning
requiredFor options, the flag takes a required value; for arguments, the positional itself is mandatory.
optionalThe option takes an optional value when its flag is present.
mandatoryThe option flag itself must be passed. This is always a boolean.
defaultValueThe portable default exposed to callers. Path defaults are environment-independent and resolved against the current directory only when the command runs.
bodyThe JSON Schema of the JSON document sent by that command.
schemaVersionThe top-level schema contract version. Version 2 adds explicit mandatory-option semantics.

Skill files

bash
apex skills
apex skills --install
apex skills --install --target ./.claude/skills --json

apex skills prints the package paths for the CLI AGENTS.md contract and the bundled apex-cli skill. With --install, it copies both files into <target>/apex-cli. The default target is .claude/skills.

Agent contract reminders

  • Use apex, not inferred fuzzy command names.
  • Prefer --json and parse the envelope, not human tables.
  • Treat .apex/ folders as CLI-owned metadata.
  • Treat preview tokens and API keys as secrets.
  • Do not edit generated QA or launch state directly; use apex experiments qa.