Skip to main content
The Revolte CLI enables you to move from intent to code in seconds. Follow this guide to install the CLI, sign in, and run your first task from the interactive shell.
Prerequisite: Ensure your repository is connected to a Revolte application. Learn how in the Get Started guide.
1

Install CLI

Install the Revolte CLI globally using npm.
Terminal
2

Authenticate

Sign in to connect your local environment with your Revolte account.
Terminal
This opens a browser window to complete authentication. Once you approve the sign-in, your terminal session is updated automatically with the necessary credentials.
On a machine without a browser (e.g. over SSH), pass --no-browser to print a link you can open elsewhere: revolte auth login --no-browser.
3

Launch the shell

Run revolte inside your project directory to open the interactive shell.
Terminal
Picking up a previous session? Run revolte --resume <threadId> to continue an earlier conversation instead of starting a new one.
4

Describe your task

Once the shell is open, type any natural language prompt describing the task you want Revolte AI to execute.

Enter a task for Revolte AI to execute.

Describe a bug or technical issue for Revolte AI to fix.

Once you hit Enter, Revolte AI begins analyzing your project context.
5

Autonomous Execution

Revolte AI starts working directly in your local directory. It automatically identifies the necessary files, applies the changes, and ensures everything aligns with your existing architecture.
If the tool requests permission to modify specific files, simply review the plan and approve it to proceed.
6

Review and Push

Once the task is complete, review the generated code locally. If you’re satisfied with the results, commit and push the changes to your repository.
Terminal

​
Give the agent project-specific context

Drop a .revolte/guides.md file in your project root to give the agent standing context about your codebase—conventions, architecture notes, or guardrails that aren’t obvious from the code alone. When present, Revolte reads and follows it before making any changes, the same way it would follow an explicit instruction in your prompt. Use it for things like:
  • Build, test, and lint commands
  • Naming conventions and folder structure
  • Patterns or components to reuse instead of reinventing
  • Explicit dos and don’ts for the codebase
Keep it focused on what the agent can’t infer by reading the repository—skip anything that’s already obvious from the code or git history.

​
Next steps