Skip to main content

Create and Maintain CLIs

Describe the workflow you want. The agent can turn it into a command, keep its output compatible, and verify the result.

Start With a Workflow

Use a command when a workflow is useful enough to repeat. A private plugin is the default for personal workflows; Webcmd core does not bundle site adapters.

What to Put in the Prompt

Specify the target, command name, inputs, login needs, safety limits, and verification expectations. Name the JSON fields you need: stable JSON fields are the contract for people and other agents that consume the command.

What the Agent Should Do

The agent should check the existing registry first, reuse or extend a matching adapter, explore only when needed, implement the simplest reliable command, and validate it. When updating or healing a command, it preserves compatible inputs and output fields unless you request a breaking change.

What a Good Handoff Includes

A finished command should include:
  • Command usage and output schema.
  • Adapter location and strategy used.
  • Verification result and JSON examples.
  • Known limitations and any required authentication.
  • Clear next steps if authentication or site access blocked the work.

Extend an Existing Command

Repair Instead of Duplicating

When a command breaks, repair the existing command instead of creating a near-duplicate.
Only add a new command when the workflow itself has changed.

Private, Plugin, or Upstream

Keep personal or company workflows in private plugins. The legacy ~/.webcmd/clis/ path remains supported, but new portable work should use plugins. Prepare a plugin for upstream only when it is broadly useful and ready for repository review.