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.
npx rvue-cli loginA 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.
cd your-project
npx rvue-cli enablervue will:
- Register your repository with the rvue cloud
- Scan your codebase (file patterns, exports, naming conventions)
- Import linter/formatter config as conventions
- Analyze git history for contributor expertise
- Fetch and analyze merged + closed PRs
- Run AI-powered extraction on PR review comments
- 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.
git add .rvue/ .cursor/skills/ AGENTS.md
git commit -m "chore: add rvue team intelligence"
git push⚠Check your .gitignore
.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:
npx rvue-cli mcp-installThis 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
npx rvue-cli syncAutomated sync with GitHub Actions
npx rvue-cli setup-actionThis 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
- CLI Reference: All commands, options, and usage patterns
- Dashboard Guide: Explore your intelligence data in the web UI
- Core Concepts: Understand the intelligence model in depth
- Configuration: Customize analysis parameters and exclusions