Skip to navigation

Publish a CLI surface

Writes the surface’s cli.json, SKILL.md and install scripts to the install host under its slug (its command name), so curl -fsSL https://get.runtype.com/<slug> | sh installs it. With installDomain set, publish issues a TXT token (_runtype-install.<installDomain>); once a publish finds it, the install scripts point at https://<installDomain>, which serves the same files at its root. Until then the CLI installs from the Runtype host and installDomain.state is pending. The first version is 1.0.0; changed files bump the patch version. A slug belongs to the first surface that publishes it, a verified domain to the surface whose TXT record proves it, and a name close to a protected brand needs a manual review first.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

productIdstringRequired
surfaceIdstringRequired

Response

Published or unchanged
installobject
installDomainobject

The custom install domain the surface asks for and whether it is verified; null when it asks for none

outcomeenum

unchanged: the files match the last publish, so the version stays; every file is still rewritten

Allowed values:
publishedAtstring
slugstring
versionstring

Errors

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