Documentation Index
Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Starting June 15, 2026, Agent SDK and
claude -p usage on subscription plans will draw from a new monthly Agent SDK credit, separate from your interactive usage limits. See Use the Claude Agent SDK with your Claude plan for details.-p dengan prompt Anda dan opsi CLI apa pun:
claude -p). Untuk paket SDK Python dan TypeScript dengan output terstruktur, callback persetujuan alat, dan objek pesan asli, lihat dokumentasi Agent SDK lengkap.
Penggunaan dasar
Tambahkan bendera-p (atau --print) ke perintah claude apa pun untuk menjalankannya secara non-interaktif. Semua opsi CLI bekerja dengan -p, termasuk:
--continueuntuk melanjutkan percakapan--allowedToolsuntuk persetujuan otomatis alat--output-formatuntuk output terstruktur
Mulai lebih cepat dengan bare mode
Tambahkan--bare untuk mengurangi waktu startup dengan melewati penemuan otomatis hooks, skills, plugins, server MCP, auto memory, dan CLAUDE.md. Tanpanya, claude -p memuat konteks yang sama dengan sesi interaktif, termasuk apa pun yang dikonfigurasi di direktori kerja atau ~/.claude.
Bare mode berguna untuk CI dan skrip di mana Anda memerlukan hasil yang sama di setiap mesin. Hook di ~/.claude rekan kerja atau server MCP di .mcp.json proyek tidak akan berjalan, karena bare mode tidak pernah membacanya. Hanya bendera yang Anda berikan secara eksplisit yang berlaku.
Contoh ini menjalankan tugas ringkasan sekali pakai dalam bare mode dan pra-menyetujui alat Read sehingga panggilan selesai tanpa prompt izin:
| Untuk memuat | Gunakan |
|---|---|
| Penambahan prompt sistem | --append-system-prompt, --append-system-prompt-file |
| Pengaturan | --settings <file-or-json> |
| Server MCP | --mcp-config <file-or-json> |
| Agen kustom | --agents <json> |
| Plugin | --plugin-dir <path>, --plugin-url <url> |
ANTHROPIC_API_KEY atau apiKeyHelper dalam JSON yang diteruskan ke --settings. Bedrock, Vertex, dan Foundry menggunakan kredensial penyedia biasa mereka.
--bare adalah mode yang direkomendasikan untuk panggilan skrip dan SDK, dan akan menjadi default untuk -p di rilis mendatang.Contoh
Contoh-contoh ini menyoroti pola CLI umum. Untuk CI dan panggilan skrip lainnya, tambahkan--bare sehingga mereka tidak mengambil apa pun yang kebetulan dikonfigurasi secara lokal.
Saluran data melalui Claude
Mode non-interaktif membaca stdin, sehingga Anda dapat menyalurkan data dan mengarahkan respons keluar seperti alat baris perintah lainnya. Contoh ini menyalurkan log build ke Claude dan menulis penjelasan ke file:--output-format json, payload respons mencakup total_cost_usd dan rincian biaya per-model, sehingga pemanggil skrip dapat melacak pengeluaran per invokasi tanpa berkonsultasi dengan dashboard penggunaan.
Sejak Claude Code v2.1.128, stdin yang disalurkan dibatasi pada 10MB. Jika Anda melampaui batas, Claude Code keluar dengan kesalahan yang jelas dan status bukan nol. Untuk bekerja dengan input yang lebih besar, tulis konten ke file dan referensikan jalur file dalam prompt Anda alih-alih menyalurkannya.
Tambahkan Claude ke skrip build
Anda dapat membungkus panggilan non-interaktif dalam skrip untuk menggunakan Claude sebagai linter atau reviewer khusus proyek. Skrippackage.json ini menyalurkan diff terhadap main ke Claude dan memintanya untuk melaporkan typo. Menyalurkan diff berarti Claude tidak memerlukan izin Bash untuk membacanya, dan tanda kutip ganda yang di-escape menjaga skrip portabel ke Windows:
Dapatkan output terstruktur
Gunakan--output-format untuk mengontrol bagaimana respons dikembalikan:
text(default): output teks biasajson: JSON terstruktur dengan hasil, ID sesi, dan metadatastream-json: JSON yang dibatasi baris baru untuk streaming real-time
result:
--output-format json dengan --json-schema dan definisi JSON Schema. Respons mencakup metadata tentang permintaan (ID sesi, penggunaan, dll.) dengan output terstruktur di bidang structured_output.
Contoh ini mengekstrak nama fungsi dan mengembalikannya sebagai array string:
Streaming respons
Gunakan--output-format stream-json dengan --verbose dan --include-partial-messages untuk menerima token saat dihasilkan. Setiap baris adalah objek JSON yang mewakili acara:
-r menampilkan string mentah (tanpa tanda kutip) dan -j bergabung tanpa baris baru sehingga token streaming terus menerus:
system/api_retry sebelum mencoba ulang. Anda dapat menggunakan ini untuk menampilkan kemajuan percobaan ulang atau menerapkan logika backoff kustom.
| Bidang | Tipe | Deskripsi |
|---|---|---|
type | "system" | tipe pesan |
subtype | "api_retry" | mengidentifikasi ini sebagai acara percobaan ulang |
attempt | integer | nomor percobaan saat ini, dimulai dari 1 |
max_retries | integer | total percobaan ulang yang diizinkan |
retry_delay_ms | integer | milidetik hingga percobaan berikutnya |
error_status | integer atau null | kode status HTTP, atau null untuk kesalahan koneksi tanpa respons HTTP |
error | string | kategori kesalahan: authentication_failed, oauth_org_not_allowed, billing_error, rate_limit, invalid_request, server_error, max_output_tokens, atau unknown |
uuid | string | pengidentifikasi acara unik |
session_id | string | sesi yang dimiliki acara |
system/init melaporkan metadata sesi termasuk model, alat, server MCP, dan plugin yang dimuat. Ini adalah acara pertama dalam aliran kecuali CLAUDE_CODE_SYNC_PLUGIN_INSTALL diatur, dalam hal ini acara plugin_install mendahuluinya. Gunakan bidang plugin untuk gagal CI ketika plugin tidak dimuat:
| Bidang | Tipe | Deskripsi |
|---|---|---|
plugins | array | plugin yang berhasil dimuat, masing-masing dengan name dan path |
plugin_errors | array | kesalahan waktu muat plugin, masing-masing dengan plugin, type, dan message. Mencakup versi dependensi yang tidak terpenuhi dan kegagalan muat --plugin-dir seperti jalur yang hilang atau arsip yang tidak valid. Plugin yang terpengaruh diturunkan dan tidak ada di plugins. Kunci dihilangkan ketika tidak ada kesalahan |
CLAUDE_CODE_SYNC_PLUGIN_INSTALL diatur, Claude Code memancarkan acara system/plugin_install saat plugin marketplace dipasang sebelum giliran pertama. Gunakan ini untuk menampilkan kemajuan pemasangan di UI Anda sendiri.
| Bidang | Tipe | Deskripsi |
|---|---|---|
type | "system" | tipe pesan |
subtype | "plugin_install" | mengidentifikasi ini sebagai acara pemasangan plugin |
status | "started", "installed", "failed", atau "completed" | started dan completed membatasi pemasangan keseluruhan; installed dan failed melaporkan marketplace individual |
name | string, opsional | nama marketplace, hadir pada installed dan failed |
error | string, opsional | pesan kegagalan, hadir pada failed |
uuid | string | pengidentifikasi acara unik |
session_id | string | sesi yang dimiliki acara |
Persetujuan otomatis alat
Gunakan--allowedTools untuk membiarkan Claude menggunakan alat tertentu tanpa meminta. Contoh ini menjalankan suite pengujian dan memperbaiki kegagalan, memungkinkan Claude untuk menjalankan perintah Bash dan membaca/mengedit file tanpa meminta izin:
dontAsk menolak apa pun yang tidak ada dalam aturan permissions.allow Anda atau set perintah read-only, yang berguna untuk CI runs yang terkunci. acceptEdits memungkinkan Claude menulis file tanpa meminta dan juga persetujuan otomatis perintah filesystem umum seperti mkdir, touch, mv, dan cp. Perintah shell lainnya dan permintaan jaringan masih memerlukan entri --allowedTools atau aturan permissions.allow, jika tidak run akan berhenti ketika salah satu dicoba:
Buat komit
Contoh ini meninjau perubahan yang dipentaskan dan membuat komit dengan pesan yang sesuai:--allowedTools menggunakan sintaks aturan izin. Spasi di akhir * memungkinkan pencocokan awalan, jadi Bash(git diff *) memungkinkan perintah apa pun yang dimulai dengan git diff. Spasi sebelum * penting: tanpanya, Bash(git diff*) juga akan cocok dengan git diff-index.
skills yang dipanggil pengguna seperti
/commit dan perintah bawaan hanya tersedia dalam mode interaktif. Dalam mode -p, jelaskan tugas yang ingin Anda capai.Sesuaikan prompt sistem
Gunakan--append-system-prompt untuk menambahkan instruksi sambil mempertahankan perilaku default Claude Code. Contoh ini menyalurkan diff PR ke Claude dan menginstruksikannya untuk meninjau kerentanan keamanan:
--system-prompt untuk sepenuhnya mengganti prompt default.
Lanjutkan percakapan
Gunakan--continue untuk melanjutkan percakapan terbaru, atau --resume dengan ID sesi untuk melanjutkan percakapan tertentu. Contoh ini menjalankan tinjauan, kemudian mengirim prompt tindak lanjut:
Langkah berikutnya
- Agent SDK quickstart: bangun agen pertama Anda dengan Python atau TypeScript
- CLI reference: semua bendera dan opsi CLI
- GitHub Actions: gunakan Agent SDK dalam alur kerja GitHub
- GitLab CI/CD: gunakan Agent SDK dalam pipeline GitLab