Back to Details

coderabbit-hello-world

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

CodeRabbit Hello World

CodeRabbit Hello World

Overview

概述

Minimal working example demonstrating core CodeRabbit functionality.
展示CodeRabbit核心功能的最简可运行示例。

Prerequisites

前提条件

  • Completed 
    coderabbit-install-auth
    setup
  • Valid API credentials configured
  • Development environment ready
  • 已完成
    coderabbit-install-auth
    配置
  • 已配置有效的API凭证
  • 开发环境准备就绪

Instructions

操作步骤

Step 1: Create Entry File

步骤1：创建入口文件

Create a new file for your hello world example.
为你的hello world示例创建一个新文件。

Step 2: Import and Initialize Client

步骤2：导入并初始化客户端

typescript
import { CodeRabbitClient } from '@coderabbit/sdk';

const client = new CodeRabbitClient({
  apiKey: process.env.CODERABBIT_API_KEY,
});
typescript
import { CodeRabbitClient } from '@coderabbit/sdk';

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

Step 3: Make Your First API Call

步骤3：发起首次API调用

typescript
async function main() {
  // Your first API call here
}

main().catch(console.error);
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.
  • 包含CodeRabbit客户端初始化的可运行代码文件
  • 确认连接成功的API响应
  • 控制台输出如下内容：
Success! Your CodeRabbit connection is working.

Error Handling

错误处理

ErrorCauseSolution
Import ErrorSDK not installedVerify with 
npm list
or 
pip show
Auth ErrorInvalid credentialsCheck environment variable is set
TimeoutNetwork issuesIncrease timeout or check connectivity
Rate LimitToo many requestsWait and retry with exponential backoff
错误类型原因解决方案
导入错误SDK未安装使用
npm list
或
pip show
验证
认证错误凭证无效检查环境变量是否已设置
超时错误网络问题增加超时时间或检查网络连接
速率限制错误请求过多等待后重试，使用指数退避策略

Examples

示例

TypeScript Example

TypeScript示例

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);
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示例

python
from coderabbit import CodeRabbitClient

client = CodeRabbitClient()
python
from coderabbit import CodeRabbitClient

client = CodeRabbitClient()

Your first API call here

Your first API call here

undefined
undefined

Resources

相关资源

Next Steps

后续步骤

Proceed to 
coderabbit-local-dev-loop
for development workflow setup.
继续查看
coderabbit-local-dev-loop
以设置开发工作流。