Observal

Observal: Core CLI Operations

Critical Rules

1. EXECUTE commands: run them in your shell, do not just display them.
2. Set timeout to 60 seconds: most commands make HTTP calls.
3. Use single quotes for --prompt and --description values to avoid shell quoting issues.
4. Do NOT run observal auth status first. Other commands surface auth problems clearly on their own.
5. When in doubt about a flag, run <command> --help first. Never guess flag names.
6. Pass --output json on every list/show command. It is stable and machine readable.
7. Pass --yes / -y on destructive commands so they do not block on a confirmation prompt.
8. Resolve 409 conflicts deterministically: --update for in-place edits, --bump for versioned releases.
9. Only fall back to local file writes if a command exits with Connection failed or Not configured.
10. Never invent OTEL_* or CLAUDE_CODE_ENABLE_TELEMETRY environment variables. Telemetry flows through observal-shim and session push hooks only.

Procedure: Pull Agent

Install an agent's full config (rules, MCP servers, hooks, skills) into a local IDE.

observal agent pull AGENT_NAME --ide kiro --no-prompt --dir .

Flags:

• --ide (required): claude-code, kiro, cursor, gemini-cli, vscode, codex, copilot, copilot-cli, opencode
• --version <semver>: install a specific version (e.g. 1.2.0). Omit for latest.
• --scope user|project: install scope (Claude Code, Kiro, Gemini only)
• --model <name> or --model <ide>=<name>: override saved model (repeatable)
• --tools t1,t2: Claude Code tool whitelist
• --dry-run: preview file writes without touching disk
• --no-prompt: skip interactive confirmation
• --dir <path>: target directory (default: current)

Merge behavior: MCP configs are merged with existing IDE config files, not overwritten. Existing user entries are preserved.

Version pinning: When --version is specified, the exact content from that version is installed. The lockfile (~/.observal/lockfile.json) records the pin. If another agent depends on the same component at a different version, a warning is displayed.

If the user did not specify an IDE, ask which one before running.

Procedure: Outdated

Check for newer versions of installed agents and components.

observal outdated
observal outdated --ide claude-code
observal outdated --output json

Reads ~/.observal/lockfile.json and compares each pinned version against the registry's latest. Reports a table of outdated items with current vs latest version.

Procedure: Scan IDEs

Read-only inventory of installed components across all detected IDEs. Never modifies any file.

observal scan
observal scan --ide kiro
observal scan --ide claude-code

Reports: detected IDEs, MCP servers (with shimmed status), skills, hooks, agents, and unregistered components.

Procedure: Doctor

Diagnose only. Does not fix anything.

observal doctor

Reports: Observal config validity, server reachability, hook installation status per IDE, skill presence. Exits non-zero if issues found.

Procedure: Doctor Patch

Apply instrumentation. Run with --dry-run first when the user is unsure.

observal doctor patch --all --all-ides --dry-run
observal doctor patch --all --all-ides
observal doctor patch --hook --shim --ide kiro
observal doctor patch --all --ide claude-code
observal doctor patch --hook --all-ides
observal doctor patch --shim --all-ides

Required: at least one of --hook / --shim / --all, AND at least one of --all-ides / --ide. Creates timestamped backups before modifying any file.

Procedure: Doctor Cleanup

Remove Observal-managed hooks and env vars from IDE configs. Leaves user content untouched.

observal doctor cleanup --dry-run
observal doctor cleanup
observal doctor cleanup --ide kiro

Procedure: Auth

observal auth login
observal auth login --server https://observal.example.com
observal auth login --sso
observal auth login --email me@x.com --password '...'
observal auth whoami --output json
observal auth status
observal auth logout
observal auth change-password
observal auth set-username new-handle

On a fresh server, auth login auto-bootstraps an admin from localhost (no prompts needed).

Procedure: CLI Config

observal config show
observal config path
observal config set output json
observal config set server_url https://observal.example.com
observal config aliases
observal config alias MY_AGENT abc-123

Error Reference

Output Contract

For every CLI invocation, format your response:

1. One sentence stating intent.
2. The exact command in a fenced code block.
3. The result: success / specific error.
4. The next action, or "done".

For full command reference, read references/commands.md. For agent creation use the observal-agents skill. For registry operations use observal-registry. For observability use observal-ops. For admin tasks use observal-admin.