Skip to navigation

Preview a CLI surface

Renders the saved cli surface the way a publish would build it: the exact --help text of the CLI and of each command, each command’s flags and an example, and the SKILL.md. Compares that build with the version the install host serves, listing added, removed and changed commands and changed settings. Reads the install host’s bucket and never writes to it; a surface that is turned off still previews.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

productIdstringRequired
surfaceIdstringRequired

Response

Preview
binNamestring
The command name the preview renders, which is also the install slug
builtinslist of objects

The built-in commands every CLI has, as --help lists them

commandslist of objects
One entry per tool command, hidden ones included, sorted by command path
displayNamestring

The name --help opens with: the product name

helpstring

The exact text <bin> --help prints

publishobject
skillstring

The SKILL.md a publish writes and <bin> skill install installs

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error
503
Service Unavailable Error