Getting Started

Ramp is an AI-powered CLI tool that helps developers onboard to any codebase in hours, not weeks.

Installation

Install Ramp globally using npm:

npm install -g rampup

Quick Start

1. Login to your account:

   ramp login

2. Navigate to your project:

   cd /path/to/your/project

3. Start the guided onboarding:

   ramp start

4. Or talk to your codebase with voice:

   ramp voice

Requirements

• Node.js 18.0 or above
• A Ramp account (sign up here)
• For voice mode: Sox audio library

  # macOS
  brew install sox
  
  # Ubuntu/Debian
  sudo apt-get install sox

What Ramp Does

Ramp uses AI to help you understand complex codebases faster:

• Voice Mode: Ask questions about the code out loud and get spoken answers
• Guided Onboarding: Step-by-step exploration of project architecture
• Code Q&A: Quick text-based questions about any part of the codebase
• Documentation Generation: Auto-generate onboarding docs for your team