Skip to main content

CLI Commands

Complete reference for all Ramp CLI commands.

Authentication​

ramp login​

Authenticate with your Ramp account.

ramp login

Opens a browser window to complete authentication. Your session token is stored locally in ~/.ramp/.

ramp logout​

Sign out of your Ramp account.

ramp logout

ramp status​

Check your current authentication and subscription status.

ramp status

Onboarding​

ramp start​

Begin guided onboarding for the current project.

ramp start

This command:

  • Scans your project structure
  • Identifies key files and patterns
  • Guides you through the architecture step-by-step

ramp explore​

Scan and analyze the project structure.

ramp explore

ramp guide​

Generate an ONBOARDING.md file for your project.

ramp guide

Creates comprehensive onboarding documentation based on AI analysis of your codebase.

ramp learn​

Start an AI-guided tour of the repository.

ramp learn

Voice Mode​

ramp voice​

Start voice mode to talk to your codebase.

ramp voice

Requires Sox to be installed for audio capture. Ask questions naturally and receive spoken answers with code context.

ramp voice:usage​

Check your voice minutes usage.

ramp voice:usage

Q&A​

ramp ask​

Ask a quick question about the codebase.

ramp ask "How does authentication work?"
ramp ask "Where are the API routes defined?"

Configuration​

ramp config​

View or update configuration.

# View current config
ramp config

# Set a value
ramp config set <key> <value>

Help​

ramp help​

Show help for any command.

ramp help
ramp help voice
ramp help start

ramp --version​

Show the installed version.

ramp --version