home / skills / jeremylongshore / claude-code-plugins-plus-skills / coderabbit-install-auth

This skill helps you install and configure CodeRabbit authentication for SDK/CLI, enabling secure API access and smooth project setup.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill coderabbit-install-auth

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.3 KB
---
name: coderabbit-install-auth
description: |
  Install and configure CodeRabbit SDK/CLI authentication.
  Use when setting up a new CodeRabbit integration, configuring API keys,
  or initializing CodeRabbit in your project.
  Trigger with phrases like "install coderabbit", "setup coderabbit",
  "coderabbit auth", "configure coderabbit API key".
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pip:*), Grep
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# CodeRabbit Install & Auth

## Overview
Set up CodeRabbit SDK/CLI and configure authentication credentials.

## Prerequisites
- Node.js 18+ or Python 3.10+
- Package manager (npm, pnpm, or pip)
- CodeRabbit account with API access
- API key from CodeRabbit dashboard

## Instructions

### Step 1: Install SDK
```bash
# Node.js
npm install @coderabbit/sdk

# Python
pip install coderabbit
```

### Step 2: Configure Authentication
```bash
# Set environment variable
export CODERABBIT_API_KEY="your-api-key"

# Or create .env file
echo 'CODERABBIT_API_KEY=your-api-key' >> .env
```

### Step 3: Verify Connection
```typescript
// Test connection code here
```

## Output
- Installed SDK package in node_modules or site-packages
- Environment variable or .env file with API key
- Successful connection verification output

## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| Invalid API Key | Incorrect or expired key | Verify key in CodeRabbit dashboard |
| Rate Limited | Exceeded quota | Check quota at https://docs.coderabbit.com |
| Network Error | Firewall blocking | Ensure outbound HTTPS allowed |
| Module Not Found | Installation failed | Run `npm install` or `pip install` again |

## Examples

### TypeScript Setup
```typescript
import { CodeRabbitClient } from '@coderabbit/sdk';

const client = new CodeRabbitClient({
  apiKey: process.env.CODERABBIT_API_KEY,
});
```

### Python Setup
```python
from coderabbit import CodeRabbitClient

client = CodeRabbitClient(
    api_key=os.environ.get('CODERABBIT_API_KEY')
)
```

## Resources
- [CodeRabbit Documentation](https://docs.coderabbit.com)
- [CodeRabbit Dashboard](https://api.coderabbit.com)
- [CodeRabbit Status](https://status.coderabbit.com)

## Next Steps
After successful auth, proceed to `coderabbit-hello-world` for your first API call.

Overview

This skill installs the CodeRabbit SDK/CLI and configures authentication so your app can call CodeRabbit APIs. It guides you through installing the package for Node.js or Python, setting an API key as an environment variable or .env entry, and verifying the connection. The goal is a reproducible, secure auth setup for new integrations.

How this skill works

The skill installs the official CodeRabbit client for your runtime (npm for Node.js, pip for Python) and helps you persist an API key to the environment. It configures CODERABBIT_API_KEY via shell export or a .env file and provides a minimal verification snippet to confirm successful authentication. It also surfaces common errors and next steps to validate quota and network access.

When to use it

  • Onboarding a new project that will call CodeRabbit APIs
  • Switching environments (local, CI, or production) and needing secure API keys
  • Automating developer setup for a team or CI pipeline
  • Recovering from auth failures or rotating API keys
  • Setting up a demo or tutorial that requires CodeRabbit access

Best practices

  • Store CODERABBIT_API_KEY in environment variables or a secrets manager, not in source control
  • Use minimal-scoped API keys and rotate them regularly via the CodeRabbit dashboard
  • Verify network egress (HTTPS) from CI or servers to avoid connection issues
  • Test authentication with a small API call after install to confirm permissions and quota
  • Automate install and env configuration in project bootstrap scripts or devcontainers

Example use cases

  • Quick local setup: npm install @coderabbit/sdk, export CODERABBIT_API_KEY, run a test script
  • Python service boot: pip install coderabbit, load API key from environment or secrets, initialize client
  • CI pipeline: inject CODERABBIT_API_KEY from CI secrets store and run integration tests
  • Onboarding script: add installer and .env creation to developer setup to reduce friction
  • Troubleshooting: follow error table to resolve invalid keys, rate limits, or network blocks

FAQ

What runtimes are supported?

Node.js (18+) and Python (3.10+) are supported; install @coderabbit/sdk for Node or coderabbit for Python.

Where should I store the API key?

Use environment variables, a secrets manager, or CI secret storage. Avoid committing .env files to source control.

How do I verify the installation worked?

Run the provided minimal client snippet to make a small API call; check for successful authentication and expected response.