SDK
Integrasikan Claude Code secara terprogram ke dalam aplikasi Anda menggunakan SDK.
SDK Claude Code memungkinkan pengembang untuk mengintegrasikan Claude Code secara terprogram ke dalam aplikasi mereka. SDK ini memungkinkan menjalankan Claude Code sebagai subproses, menyediakan cara untuk membangun asisten dan alat pengkodean bertenaga AI yang memanfaatkan kemampuan Claude.
SDK tersedia untuk penggunaan command line, TypeScript, dan Python.
Autentikasi
Untuk menggunakan SDK Claude Code, kami merekomendasikan pembuatan API key khusus:
- Buat API key Anthropic di Anthropic Console
- Kemudian, atur variabel lingkungan
ANTHROPIC_API_KEY
. Kami merekomendasikan untuk menyimpan kunci ini dengan aman (misalnya menggunakan Github secret)
Penggunaan dasar SDK
SDK Claude Code memungkinkan Anda menggunakan Claude Code dalam mode non-interaktif dari aplikasi Anda.
Command line
Berikut beberapa contoh dasar untuk SDK command line:
TypeScript
SDK TypeScript disertakan dalam paket utama @anthropic-ai/claude-code
di NPM:
SDK TypeScript menerima semua argumen yang didukung oleh SDK command line, serta:
Argumen | Deskripsi | Default |
---|---|---|
abortController | Pengontrol pembatalan | new AbortController() |
cwd | Direktori kerja saat ini | process.cwd() |
executable | Runtime JavaScript mana yang digunakan | node saat menjalankan dengan Node.js, bun saat menjalankan dengan Bun |
executableArgs | Argumen yang diteruskan ke executable | [] |
pathToClaudeCodeExecutable | Path ke executable Claude Code | Executable yang disertakan dengan @anthropic-ai/claude-code |
Python
SDK Python tersedia sebagai claude-code-sdk
di PyPI:
Prasyarat:
- Python 3.10+
- Node.js
- Claude Code CLI:
npm install -g @anthropic-ai/claude-code
Penggunaan dasar:
SDK Python menerima semua argumen yang didukung oleh SDK command line melalui kelas ClaudeCodeOptions
:
Penggunaan lanjutan
Dokumentasi di bawah ini menggunakan SDK command line sebagai contoh, tetapi juga dapat digunakan dengan SDK TypeScript dan Python.
Percakapan multi-turn
Untuk percakapan multi-turn, Anda dapat melanjutkan percakapan atau melanjutkan dari sesi terbaru:
System prompt kustom
Anda dapat memberikan system prompt kustom untuk mengarahkan perilaku Claude:
Anda juga dapat menambahkan instruksi ke system prompt default:
Konfigurasi MCP
Model Context Protocol (MCP) memungkinkan Anda memperluas Claude Code dengan alat dan sumber daya tambahan dari server eksternal. Dengan menggunakan flag --mcp-config
, Anda dapat memuat server MCP yang menyediakan kemampuan khusus seperti akses database, integrasi API, atau alat kustom.
Buat file konfigurasi JSON dengan server MCP Anda:
Kemudian gunakan dengan Claude Code:
Saat menggunakan alat MCP, Anda harus secara eksplisit mengizinkannya menggunakan flag --allowedTools
. Nama alat MCP mengikuti pola mcp__<serverName>__<toolName>
di mana:
serverName
adalah kunci dari file konfigurasi MCP AndatoolName
adalah alat spesifik yang disediakan oleh server tersebut
Langkah keamanan ini memastikan bahwa alat MCP hanya digunakan ketika secara eksplisit diizinkan.
Jika Anda hanya menentukan nama server (yaitu, mcp__<serverName>
), semua alat dari server tersebut akan diizinkan.
Pola glob (misalnya, mcp__go*
) tidak didukung.
Alat prompt izin kustom
Secara opsional, gunakan --permission-prompt-tool
untuk meneruskan alat MCP yang akan kami gunakan untuk memeriksa apakah pengguna memberikan izin kepada model untuk memanggil alat tertentu. Ketika model memanggil alat, hal berikut terjadi:
- Kami pertama-tama memeriksa pengaturan izin: semua file settings.json, serta
--allowedTools
dan--disallowedTools
yang diteruskan ke SDK; jika salah satu dari ini mengizinkan atau menolak pemanggilan alat, kami melanjutkan dengan pemanggilan alat - Jika tidak, kami memanggil alat MCP yang Anda berikan di
--permission-prompt-tool
Alat MCP --permission-prompt-tool
diteruskan nama alat dan input, dan harus mengembalikan payload yang di-JSON-stringify dengan hasilnya. Payload harus berupa salah satu dari:
Misalnya, implementasi alat prompt izin MCP TypeScript mungkin terlihat seperti ini:
Untuk menggunakan alat ini, tambahkan server MCP Anda (misalnya dengan --mcp-config
), kemudian panggil SDK seperti ini:
Catatan penggunaan:
- Gunakan
updatedInput
untuk memberi tahu model bahwa prompt izin mengubah inputnya; jika tidak, aturupdatedInput
ke input asli, seperti dalam contoh di atas. Misalnya, jika alat menampilkan diff edit file kepada pengguna dan membiarkan mereka mengedit diff secara manual, alat prompt izin harus mengembalikan edit yang diperbarui tersebut. - Payload harus di-JSON-stringify
Opsi CLI yang tersedia
SDK memanfaatkan semua opsi CLI yang tersedia di Claude Code. Berikut adalah opsi utama untuk penggunaan SDK:
Flag | Deskripsi | Contoh |
---|---|---|
--print , -p | Jalankan dalam mode non-interaktif | claude -p "query" |
--output-format | Tentukan format output (text , json , stream-json ) | claude -p --output-format json |
--resume , -r | Lanjutkan percakapan berdasarkan ID sesi | claude --resume abc123 |
--continue , -c | Lanjutkan percakapan terbaru | claude --continue |
--verbose | Aktifkan logging verbose | claude --verbose |
--max-turns | Batasi giliran agentic dalam mode non-interaktif | claude --max-turns 3 |
--system-prompt | Ganti system prompt (hanya dengan --print ) | claude --system-prompt "Custom instruction" |
--append-system-prompt | Tambahkan ke system prompt (hanya dengan --print ) | claude --append-system-prompt "Custom instruction" |
--allowedTools | Daftar alat yang diizinkan dipisahkan spasi, atau string daftar alat yang diizinkan dipisahkan koma | claude --allowedTools mcp__slack mcp__filesystem claude --allowedTools "Bash(npm install),mcp__filesystem" |
--disallowedTools | Daftar alat yang ditolak dipisahkan spasi, atau string daftar alat yang ditolak dipisahkan koma | claude --disallowedTools mcp__splunk mcp__github claude --disallowedTools "Bash(git commit),mcp__github" |
--mcp-config | Muat server MCP dari file JSON | claude --mcp-config servers.json |
--permission-prompt-tool | Alat MCP untuk menangani prompt izin (hanya dengan --print ) | claude --permission-prompt-tool mcp__auth__prompt |
Untuk daftar lengkap opsi CLI dan fitur, lihat dokumentasi penggunaan CLI.
Format output
SDK mendukung beberapa format output:
Output teks (default)
Mengembalikan hanya teks respons:
Output JSON
Mengembalikan data terstruktur termasuk metadata:
Format respons:
Output JSON streaming
Streaming setiap pesan saat diterima:
Setiap percakapan dimulai dengan pesan sistem init
awal, diikuti oleh daftar pesan pengguna dan asisten, diikuti oleh pesan sistem result
akhir dengan statistik. Setiap pesan dipancarkan sebagai objek JSON terpisah.
Skema pesan
Pesan yang dikembalikan dari API JSON diketik secara ketat sesuai dengan skema berikut:
Kami akan segera mempublikasikan tipe-tipe ini dalam format yang kompatibel dengan JSONSchema. Kami menggunakan semantic versioning untuk paket Claude Code utama untuk mengkomunikasikan perubahan yang merusak format ini.
Tipe Message
dan MessageParam
tersedia di SDK Anthropic. Misalnya, lihat SDK Anthropic TypeScript dan Python.
Contoh
Integrasi skrip sederhana
Memproses file dengan Claude
Manajemen sesi
Praktik terbaik
-
Gunakan format output JSON untuk parsing respons secara terprogram:
-
Tangani kesalahan dengan anggun - periksa kode keluar dan stderr:
-
Gunakan manajemen sesi untuk mempertahankan konteks dalam percakapan multi-turn
-
Pertimbangkan batas waktu untuk operasi yang berjalan lama:
-
Hormati batas rate saat membuat beberapa permintaan dengan menambahkan penundaan antar panggilan
Aplikasi dunia nyata
SDK Claude Code memungkinkan integrasi yang kuat dengan alur kerja pengembangan Anda. Salah satu contoh yang patut diperhatikan adalah Claude Code GitHub Actions, yang menggunakan SDK untuk menyediakan kemampuan tinjauan kode otomatis, pembuatan PR, dan triase masalah langsung dalam alur kerja GitHub Anda.
Sumber daya terkait
- Penggunaan dan kontrol CLI - Dokumentasi CLI lengkap
- Integrasi GitHub Actions - Otomatisasi alur kerja GitHub Anda dengan Claude
- Tutorial - Panduan langkah demi langkah untuk kasus penggunaan umum