🛡️ RSOLV Documentation

Installation

Get started with RSOLV in 3 simple steps:

Step 1: Get Your API Key

Sign up at rsolv.dev/signup to get 10 free credits.

Step 2: Add API Key to GitHub Secrets

In your repository: Settings → Secrets and variables → Actions → New repository secret

• Name: RSOLV_API_KEY
• Value: Your API key from Step 1

Step 3: Create Workflow File

Create .github/workflows/rsolv-security.yml:

name: RSOLV Security

on:
  push:
    branches: [main]
  schedule:
    - cron: '0 0 * * 0'  # Weekly scan

jobs:
  security:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      issues: write
      pull-requests: write

    steps:
      - uses: actions/checkout@v4

      - name: RSOLV Security Scan
        uses: RSOLV-dev/rsolv-action@v3
        with:
          rsolvApiKey: ${{ secrets.RSOLV_API_KEY }}
          mode: 'scan'  # Start with scan only

Troubleshooting

Common Issues

Authentication Errors

Problem: "API key invalid" or 401 errors

Solution:

• Verify API key is correctly set in GitHub Secrets
• Check for extra spaces or newlines in the secret value
• Ensure your API key is active at rsolv.dev/dashboard

Pull Request Creation Failures

Problem: RSOLV can't create pull requests

Solution:

• Verify workflow has contents: write and pull-requests: write permissions
• Ensure GITHUB_TOKEN is properly configured in workflow
• Check branch protection rules aren't blocking automated PRs

File Path Issues

Problem: "File not found" errors

Solution: Always use relative paths in issue descriptions:

• ✅ Correct: app/data/allocations-dao.js
• ❌ Wrong: /app/data/allocations-dao.js

Rate Limit Errors

Problem: "Rate limit exceeded" (429 errors)

Solution:

• AST validation API: 500 requests/hour per API key
• Reduce scan frequency or split into smaller jobs
• Contact support@rsolv.dev for higher limits

API Reference

Action Inputs

All available inputs for the RSOLV GitHub Action:

Core Inputs

Input	Description	Required	Default
rsolvApiKey	RSOLV API key	Yes	-
mode	Operation mode: scan, validate, mitigate, full	No	scan
max_issues	Max issues to process per run	No	1

Support

• 📧 Email: support@rsolv.dev
• 💬 GitHub: Report Issues
• 📚 Marketplace: RSOLV on GitHub