Avora CLI

Use the Avora CLI to bring an Avora workspace into your terminal, prepare it for local development, run it, and verify the generated project.

The CLI supports both guided terminal workflows and direct commands. Start with the interactive menu when learning the tool, then use individual commands when you want a repeatable workflow or machine-readable output.

What This Section Covers

The CLI documentation covers installation, sign-in, workspace pulls, Git repositories, local runs, verification reports, and recovery from common setup problems.

You can use the CLI to:

• Sign in to an Avora account and list available workspaces.
• Pull generated workspace code into a local folder.
• Open, update, and run a previously pulled project.
• Connect or synchronize a separate Git repository.
• Run lint, type-check, test, and build checks.
• Produce JSON reports for scripts and AI-assisted debugging.

Before You Continue

Install a current Node.js release with npm. Workspace pulls also require an Avora account and access to the Avora API. Depending on the project you run, you may also need Git, Python 3, or the unzip command.

The current CLI is installed from the local avora-cli package. It is not documented here as a public npm package.

Recommended Order

1. Install and run the CLI.
2. Learn the help screen and interactive menu.
3. Sign in to Avora.
4. List and pull a workspace.
5. Run and verify the project.

Pages in This Group

Related Documentation

• VS Code Extension for the editor-based pull and run workflow.
• Code Generation for generating and exporting code in Avora.
• Deployment for moving a reviewed backend beyond local development.