---

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 jeremy@intentsolutions.io

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

Copyimport { CodeRabbitClient } from '@coderabbit/sdk';

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

Step 3: Make Your First API Call

Copyasync 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:

CopySuccess! Your CodeRabbit connection is working.

Error Handling

Examples

TypeScript Example

Copyimport { 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

Copyfrom coderabbit import CodeRabbitClient

client = CodeRabbitClient()

# Your first API call here

Resources

• CodeRabbit Getting Started
• CodeRabbit API Reference
• CodeRabbit Examples

Next Steps

Proceed to coderabbit-local-dev-loop for development workflow setup.