home / skills / jeremylongshore / claude-code-plugins-plus-skills / coderabbit-hello-world
/plugins/saas-packs/coderabbit-pack/skills/coderabbit-hello-world
This skill helps you bootstrap a minimal CodeRabbit hello world in TypeScript or Python, enabling quick API setup and connection verification.
npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill coderabbit-hello-worldReview the files below or copy the command above to add this skill to your agents.
---
name: coderabbit-hello-world
description: |
Create a minimal working CodeRabbit example.
Use when starting a new CodeRabbit integration, testing your setup,
or learning basic CodeRabbit API patterns.
Trigger with phrases like "coderabbit hello world", "coderabbit example",
"coderabbit quick start", "simple coderabbit code".
allowed-tools: Read, Write, Edit
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---
# CodeRabbit Hello World
## Overview
Minimal working example demonstrating core CodeRabbit functionality.
## Prerequisites
- Completed `coderabbit-install-auth` setup
- Valid API credentials configured
- Development environment ready
## Instructions
### Step 1: Create Entry File
Create a new file for your hello world example.
### Step 2: Import and Initialize Client
```typescript
import { CodeRabbitClient } from '@coderabbit/sdk';
const client = new CodeRabbitClient({
apiKey: process.env.CODERABBIT_API_KEY,
});
```
### Step 3: Make Your First API Call
```typescript
async function main() {
// Your first API call here
}
main().catch(console.error);
```
## Output
- Working code file with CodeRabbit client initialization
- Successful API response confirming connection
- Console output showing:
```
Success! Your CodeRabbit connection is working.
```
## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| Import Error | SDK not installed | Verify with `npm list` or `pip show` |
| Auth Error | Invalid credentials | Check environment variable is set |
| Timeout | Network issues | Increase timeout or check connectivity |
| Rate Limit | Too many requests | Wait and retry with exponential backoff |
## Examples
### TypeScript Example
```typescript
import { CodeRabbitClient } from '@coderabbit/sdk';
const client = new CodeRabbitClient({
apiKey: process.env.CODERABBIT_API_KEY,
});
async function main() {
// Your first API call here
}
main().catch(console.error);
```
### Python Example
```python
from coderabbit import CodeRabbitClient
client = CodeRabbitClient()
# Your first API call here
```
## Resources
- [CodeRabbit Getting Started](https://docs.coderabbit.com/getting-started)
- [CodeRabbit API Reference](https://docs.coderabbit.com/api)
- [CodeRabbit Examples](https://docs.coderabbit.com/examples)
## Next Steps
Proceed to `coderabbit-local-dev-loop` for development workflow setup.This skill provides a minimal, working CodeRabbit example to verify your integration and demonstrate basic API patterns. It helps you initialize the client, make a first request, and observe a successful connection. Use it to confirm credentials and environment setup quickly.
The skill shows creating a small entry file, importing the CodeRabbit client, initializing it with configured credentials, and making a simple API call. It returns a console confirmation message on success and includes common error causes and remedies. Both TypeScript and Python snippets are provided so you can test whichever runtime you use.
What do I do if the import fails?
Verify the SDK is installed for your runtime (npm or pip) and that your environment matches the example language.
How can I fix authentication errors?
Check that the API key environment variable is set correctly and that the key has required permissions; retry after correcting the variable.