Quickstart

Set up rvue in your repository in under 5 minutes. Extract team intelligence and deliver it to your AI tools.

Prerequisites

  • Node.js 20 or later
  • A GitHub repository with some PR history
  • A GitHub account (for authentication)

Step 1: Authenticate

Log in to rvue with your GitHub account. This opens your browser for OAuth authentication.

Terminal
npx rvue-cli login

A verification code will be displayed in your terminal. Confirm it in your browser, authorize the GitHub OAuth app, and the CLI will automatically pick up your credentials.

Step 2: Enable your repository

Navigate to your project directory and run enable. This performs a full analysis of your codebase and PR history.

Terminal
cd your-project
npx rvue-cli enable

rvue will:

  1. Register your repository with the rvue cloud
  2. Scan your codebase (file patterns, exports, naming conventions)
  3. Import linter/formatter config as conventions
  4. Analyze git history for contributor expertise
  5. Fetch and analyze merged + closed PRs
  6. Run AI-powered extraction on PR review comments
  7. Write intelligence files to your repo

What gets created

.rvue/intelligence.json: Structured team intelligence data

.rvue/config.json: rvue configuration

.cursor/skills/rvue-team-intel/: Agent Skill (auto-discovered by Cursor and compatible tools)

Step 3: Commit the intelligence

Intelligence files are designed to be committed to your repository so your entire team benefits.

Terminal
git add .rvue/ .cursor/skills/ AGENTS.md
git commit -m "chore: add rvue team intelligence"
git push

Check your .gitignore

If your .gitignore contains .cursor/ or .rvue/, you'll need to remove those entries. These files contain no secrets, only extracted patterns.

Step 4: Set up MCP (optional)

For real-time AI tool integration via the Model Context Protocol, install the MCP server in Cursor:

Terminal
npx rvue-cli mcp-install

This adds the rvue MCP server to your Cursor configuration, providing tools like get_team_context, check_code, get_knowledge, and suggest_reviewers.

Step 5: Keep intelligence fresh

As your team merges new PRs, intelligence should be updated. You can sync manually or automate it:

Manual sync

Terminal
npx rvue-cli sync

Automated sync with GitHub Actions

Terminal
npx rvue-cli setup-action

This generates a GitHub Actions workflow that automatically syncs intelligence when PRs are merged to your default branch. See the setup-action reference for details.

Next steps