Getting Started with RMCode

Getting Started

1. Install the GitHub App — Add RMCode to your GitHub organization or personal account
2. Select repositories — Choose which repos get automatic reviews
3. Open a pull request — RMCode reviews it automatically and posts inline comments with fix suggestions
4. Apply fixes — Click "Apply suggestion" on any finding to fix with one click

Free accounts include 30 credits/month, enough for up to 30 Standard reviews. Need more? See plans.

CLI Reviews

Use rmcode for pre-flight reviews from your terminal. The CLI runs locally to collect the diff, file, or stdin content you request, then sends that review content to RMCode for analysis.

npm install -g @review-my-code/rmcode
rmcode login
rmcode --staged
rmcode src/auth.ts
git diff main | rmcode --lang typescript
rmcode --json --fail-on-findings

API Keys

API keys are for authenticated CLI and programmatic review requests. They let scripts, CI jobs, or local terminal sessions use your RMCode account without a browser session. Keep them secret: the full key is shown only once when created.

Use with the CLI

# Install the CLI
npm install -g @review-my-code/rmcode

# Create or copy a key from Dashboard -> API Keys
rmcode login

# Store it for future shell sessions
export RMC_API_KEY=rmc_...

# Review common inputs
rmcode
rmcode --staged
rmcode src/auth.ts
git diff main | rmcode --lang typescript

# Machine-readable output for automation
rmcode --json --fail-on-findings

Use with the HTTP API

curl -X POST "https://review-my-code.com/api/reviews/cli" \
  -H "X-API-Key: rmc_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "snippet",
    "language": "typescript",
    "value": "function add(a: number, b: number) { return a + b; }"
  }'

How It Works

GitHub App & Permissions

When you install the RMCode GitHub App, GitHub asks you to approve a set of permissions. Here's exactly what we request and why.

Permissions requested

What happens during installation

Configuration

Customize RMCode per repository by adding .rmcode.yaml to your repository root.

# Custom rules for the reviewer to enforce
rules:
  - "All database queries must use parameterized statements"
  - "React components must have PropTypes or TypeScript interfaces"

# Patterns to ignore
ignore:
  - "TODO comments without deadlines"
  - "Console.log statements in test files"

# Path filtering
paths:
  exclude:
    - "*.generated.ts"
    - "vendor/"
    - "docs/"

# Review depth
review:
  default_tier: standard
  overrides:
    - tier: pro
      branches:
        target: ["main", "release/**"]
      paths:
        include: ["backend/**", "payments/**"]
    - tier: standard
      branches:
        source: ["docs/**"]
      paths:
        include: ["docs/**"]

# Trigger conditions
triggers:
  branches:
    target: ["main", "develop"]
    exclude: ["release/*"]
  labels:
    skip: ["no-review", "wip"]
  authors:
    exclude: ["dependabot[bot]", "renovate[bot]"]
  skip_draft: true
  skip_bots: true
  max_files: 200

Config Reference

Review Results

Each finding is categorized by severity and includes an explanation, file location, and suggested fix.

Review Tiers

Standard reviews are available from the start. Advanced tiers deliver more thorough reviews with greater accuracy when a PR or repository needs deeper analysis.

Precedence is: plan entitlement ceiling, then matched .rmcode.yaml override, then website default, then plan default. If a config asks for a tier above your plan, RMCode clamps to the highest allowed tier and reports that in review metadata. GitHub App reviews can also use branch/path overrides from .rmcode.yaml; CLI reviews use your website default or plan default.

review:
  default_tier: standard
  overrides:
    - tier: pro
      branches:
        target: ["main"]
      paths:
        include: ["payments/**", "auth/**"]
    - tier: standard
      branches:
        source: ["docs/**"]
      paths:
        include: ["docs/**"]

See plans for full comparison.

FAQ