starred/orca
1
0
Fork 0
mirror of https://github.com/stablyai/orca.git synced 2026-11-13 09:27:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
hide-codex-error-msg
orca/skill-guides/orca-plugin-authoring/references/cli.md
T
Neil 3e52963a9a docs(plugins): fix custom-editor authoring papercuts from dogfood (#37337) 
- shot --act: say edits only dirty the tab; end with Cmd/Ctrl+S to save
- manifest: compound suffixes like .sketch.json open by default
- cli.md: list plugin check's exit codes, including plugin_check_failed
- workflow: how to run and stop the dev app from a source checkout
- plugin create --help: real descriptions for --template/--publisher/--id/--name
- recipes: declaration file for vendored ESM libraries
2026-11-01 21:48:46 -08:00

3.7 KiB
Raw Permalink Blame History

Plugin CLI commands

ORCA is the Orca executable you resolved. Every command takes --json; branch on error.code. Exit codes: 0 ok, 1 error, 2 the plugin is invalid (plugin_invalid), 3 approval is needed (approval_required or approval_stale). Except plugin check: 0 ok, 1 a panel failed to render or an editor failed its static check (plugin_check_failed), 2 the plugin is invalid (plugin_invalid). Run ORCA <command> --help for a command's notes.

  • ORCA plugin create <dir> --template <theme|terminal-theme|icon-theme|syntax|language-pack|editor|panel|components|worker-panel|hook> [--publisher <name>] [--id <id>] [--name <display name>] [--json]: Scaffold a new Orca plugin from a template
  • ORCA plugin types <dir> [--json]: Write the TypeScript typings for Orca plugins into a plugin folder
  • ORCA plugin test [dir] [--json]: Run a plugin's own tests on this machine, unsandboxed: only for code you trust
  • ORCA plugin check [dir] [--json]: Validate a plugin, render each components panel once on this machine (unsandboxed: only for code you trust), and statically check each custom editor
  • ORCA plugin validate <dir|orca-plugin.json|orca-catalog.json> [--json]: Check a plugin folder, manifest or catalog the way Orca will load it
  • ORCA plugin inspect <dir> [--json]: Show what a plugin folder contributes, the access it asks for, and its content hash
  • ORCA plugin release-entry <dir> [--json]: Print the catalog release entry for a plugin folder's committed HEAD
  • ORCA plugin list [--json]: List plugins on the Orca host with their status and access level
  • ORCA plugin logs <plugin-key> [--json]: Print the recent log lines of a plugin
  • ORCA plugin enable <plugin-key> [--approve <fingerprint>] [--json]: Enable a plugin; code and capabilities need --approve
  • ORCA plugin disable <plugin-key> [--json]: Disable a plugin
  • ORCA plugin system on [--json]: Turn plugins on for the Orca host
  • ORCA plugin system off [--json]: Turn plugins off for the Orca host
  • ORCA plugin restart <plugin-key> [--json]: Stop a plugin's worker so its next command or event starts it fresh
  • ORCA plugin dev watch <dir> [--check] [--shot <out-dir> [--shot-panel <id>]] [--approve <fingerprint>] [--json]: Load a plugin folder, then stream its logs and reloads until Ctrl-C
  • ORCA plugin dev load <dir> [--approve <fingerprint>] [--json]: Load a plugin folder into Orca as a development plugin
  • ORCA plugin dev reload [<dir>] [--approve <fingerprint>] [--json]: Reload development plugins now, or one folder and re-check its approval
  • ORCA plugin dev inspect <plugin-key> [--json]: Open DevTools for a plugin's open panels and editors
  • ORCA plugin dev emit <dir|plugin-key> <event> [--data <json>] [--json]: Fire a test event at a development plugin's worker and open panels
  • ORCA plugin dev hook <dir|plugin-key> <hook> --data <json> [--json]: Run a hook through a development plugin's worker and print what the chain decided
  • ORCA plugin dev request <dir|plugin-key> <name> [--data <json>] [--panel <id>] [--timeout-ms <ms>] [--json]: Call a development plugin's worker handler the way a panel's plugin.request does
  • ORCA plugin dev unload <dir|plugin-key> [--json]: Remove a development folder from Orca
  • ORCA plugin open <plugin-key> [--panel <id> | --editor <file>] [--json]: Show a plugin's panel in Orca's right sidebar, or open a file in its editor
  • ORCA plugin shot <plugin-key|dir> [--panel <id> | --editor <file> | --status-bar | --window] [--theme <light|dark>] [--width <px>] [--height <px>] [--act '<json>' [--in-place] | --scenario <name>] [--out <file.png>] [--json]: Save a PNG of a plugin panel exactly as Orca draws it, to look at what you built
Reference in New Issue View Git Blame Copy Permalink