asteroid command calls the Asteroid API from your terminal, scripts and CI. It needs Node.js 22 or later.
1
Install
2
Sign in
--no-skills to skip that step. asteroid skill sync installs or refreshes them at any time.3
Check it works
Organizations
asteroid orgs lists the organizations you can act in. asteroid use <org> sets the default by id or name.
--org <org> acts in another organization for one command.
Skills
The Asteroid skills areSKILL.md files, in the Agent Skills format, that teach a coding agent how to use
the platform. asteroid login writes them into every skills directory it finds:
asteroid skill sync brings them up to date. It writes the files that changed, removes the skills the API no longer
serves (--no-remove keeps them), and leaves a skill directory it did not create alone.
Do not edit an installed skill. The next sync overwrites the edit. If a skill is missing something about how a portal
works that would have helped you build your automation, save it as a portal memory with
asteroid memory create --portal <name> --description <line> --content <text>. Asteroid reviews portal memory to
improve the skill.
Keep it to general knowledge of the portal. It is not about one customer’s account or instance of it.
Once a day, a
command run at a terminal with your sign-in, without
--json, says when the installed skills are out of date.
Commands run with ASTEROID_API_KEY never say it. asteroid skill list and asteroid skill get <name> show
the skills without installing them.
CI and agents
SetASTEROID_API_KEY instead of signing in. An API key belongs to one organization, so --org does not apply.
--json to get the API response as JSON. Scripts should read --json, because the text output may change
between releases. Exit codes: 0 ok, 1 API or sign-in error, 2 usage error.
Shell completion
Load the completion script when your shell starts.Environment
Next
CLI reference
Every command, its arguments and its flags
Call a workflow
Run workflows from your own code

