Gunakan fitur Claude Code di SDK
Muat instruksi proyek, skills, hooks, dan fitur Claude Code lainnya ke dalam agen SDK Anda.
Agent SDK dibangun di atas fondasi yang sama dengan Claude Code, yang berarti agen SDK Anda memiliki akses ke fitur berbasis filesystem yang sama: instruksi proyek (CLAUDE.md dan rules), skills, hooks, dan lainnya.
Ketika Anda menghilangkan settingSources, query() membaca pengaturan filesystem yang sama dengan Claude Code CLI: pengaturan pengguna, proyek, dan lokal, file CLAUDE.md, dan skills, agen, dan perintah di .claude/. Untuk menjalankan tanpa ini, teruskan settingSources: [], yang membatasi agen hanya pada apa yang Anda konfigurasi secara terprogram. Pengaturan kebijakan terkelola dan konfigurasi global ~/.claude.json dibaca terlepas dari opsi ini. Lihat Apa yang tidak dikontrol settingSources.
Untuk gambaran konseptual tentang apa yang dilakukan setiap fitur dan kapan menggunakannya, lihat Perluas Claude Code.
Kontrol pengaturan filesystem dengan settingSources
Opsi sumber pengaturan (setting_sources di Python, settingSources di TypeScript) mengontrol pengaturan berbasis filesystem mana yang dimuat SDK. Teruskan daftar eksplisit untuk memilih sumber tertentu, atau teruskan array kosong untuk menonaktifkan pengaturan pengguna, proyek, dan lokal.
Contoh ini memuat pengaturan tingkat pengguna dan tingkat proyek dengan menetapkan settingSources ke ["user", "project"]:
from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ResultMessage
async for message in query(
prompt="Help me refactor the auth module",
options=ClaudeAgentOptions(
# "user" loads from ~/.claude/, "project" loads from ./.claude/ in cwd.
# Together they give the agent access to CLAUDE.md, skills, hooks, and
# permissions from both locations.
setting_sources=["user", "project"],
allowed_tools=["Read", "Edit", "Bash"],
),
):
if isinstance(message, AssistantMessage):
for block in message.content:
if hasattr(block, "text"):
print(block.text)
if isinstance(message, ResultMessage) and message.subtype == "success":
print(f"\nResult: {message.result}")
import { query } from "@anthropic-ai/claude-agent-sdk";
for await (const message of query({
prompt: "Help me refactor the auth module",
options: {
// "user" loads from ~/.claude/, "project" loads from ./.claude/ in cwd.
// Together they give the agent access to CLAUDE.md, skills, hooks, and
// permissions from both locations.
settingSources: ["user", "project"],
allowedTools: ["Read", "Edit", "Bash"]
}
})) {
if (message.type === "assistant") {
for (const block of message.message.content) {
if (block.type === "text") console.log(block.text);
}
}
if (message.type === "result" && message.subtype === "success") {
console.log(`\nResult: ${message.result}`);
}
}
Setiap sumber memuat pengaturan dari lokasi tertentu, di mana <cwd> adalah direktori kerja yang Anda teruskan melalui opsi cwd, atau direktori saat ini proses jika tidak diatur. Untuk definisi tipe lengkap, lihat SettingSource (TypeScript) atau SettingSource (Python).
| Sumber | Apa yang dimuat | Lokasi |
|---|---|---|
"project" |
CLAUDE.md proyek, .claude/rules/*.md, skills proyek, hooks proyek, settings.json proyek |
<cwd>/.claude/ dan setiap direktori induk hingga akar filesystem (berhenti ketika .claude/ ditemukan atau tidak ada lagi induk) |
"user" |
CLAUDE.md pengguna, ~/.claude/rules/*.md, skills pengguna, pengaturan pengguna |
~/.claude/ |
"local" |
CLAUDE.local.md (gitignored), .claude/settings.local.json |
<cwd>/ |
Menghilangkan settingSources setara dengan ["user", "project", "local"].
Opsi cwd menentukan di mana SDK mencari pengaturan proyek. Jika baik cwd maupun direktori induknya tidak berisi folder .claude/, fitur tingkat proyek tidak akan dimuat.
Apa yang tidak dikontrol settingSources
settingSources mencakup pengaturan pengguna, proyek, dan lokal. Beberapa input dibaca terlepas dari nilainya:
| Input | Perilaku | Untuk menonaktifkan |
|---|---|---|
| Pengaturan kebijakan terkelola | Selalu dimuat ketika ada di host | Hapus file pengaturan terkelola |
Konfigurasi global ~/.claude.json |
Selalu dibaca | Pindahkan dengan CLAUDE_CONFIG_DIR di env |
Memori otomatis di ~/.claude/projects/<project>/memory/ |
Dimuat secara default ke dalam system prompt | Atur autoMemoryEnabled: false di pengaturan, atau CLAUDE_CODE_DISABLE_AUTO_MEMORY=1 di env |
Instruksi proyek (CLAUDE.md dan rules)
File CLAUDE.md dan file .claude/rules/*.md memberikan agen Anda konteks persisten tentang proyek Anda: konvensi pengkodean, perintah build, keputusan arsitektur, dan instruksi. Ketika settingSources mencakup "project" (seperti dalam contoh di atas), SDK memuat file ini ke dalam konteks pada awal sesi. Agen kemudian mengikuti konvensi proyek Anda tanpa Anda mengulanginya di setiap prompt.
Lokasi pemuatan CLAUDE.md
| Level | Lokasi | Kapan dimuat |
|---|---|---|
| Proyek (root) | <cwd>/CLAUDE.md atau <cwd>/.claude/CLAUDE.md |
settingSources mencakup "project" |
| Rules proyek | <cwd>/.claude/rules/*.md |
settingSources mencakup "project" |
| Proyek (direktori induk) | File CLAUDE.md di direktori di atas cwd |
settingSources mencakup "project", dimuat pada awal sesi |
| Proyek (direktori anak) | File CLAUDE.md di subdirektori cwd |
settingSources mencakup "project", dimuat sesuai permintaan ketika agen membaca file di subtree itu |
| Lokal (gitignored) | <cwd>/CLAUDE.local.md |
settingSources mencakup "local" |
| Pengguna | ~/.claude/CLAUDE.md |
settingSources mencakup "user" |
| Rules pengguna | ~/.claude/rules/*.md |
settingSources mencakup "user" |
Semua level bersifat aditif: jika file CLAUDE.md proyek dan pengguna keduanya ada, agen melihat keduanya. Tidak ada aturan preseden keras antara level; jika instruksi bertentangan, hasilnya tergantung pada bagaimana Claude menafsirkannya. Tulis aturan yang tidak bertentangan, atau nyatakan preseden secara eksplisit di file yang lebih spesifik ("Instruksi proyek ini menggantikan default tingkat pengguna yang bertentangan").
Untuk cara menyusun dan mengorganisir konten CLAUDE.md, lihat Kelola memori Claude.
Skills
Skills adalah file markdown yang memberikan agen Anda pengetahuan khusus dan alur kerja yang dapat dipanggil. Tidak seperti CLAUDE.md (yang dimuat setiap sesi), skills dimuat sesuai permintaan. Agen menerima deskripsi skill pada startup dan memuat konten lengkap ketika relevan.
Skills ditemukan dari filesystem melalui settingSources. Ketika opsi skills pada query() dihilangkan, skills pengguna dan proyek yang ditemukan diaktifkan dan tool Skill tersedia, sesuai dengan perilaku CLI. Untuk mengontrol skills mana yang diaktifkan, berikan skills sebagai "all", daftar nama skill, atau [] untuk menonaktifkan semua. SDK mengaktifkan tool Skill secara otomatis ketika skills diatur, jadi Anda tidak perlu menambahkannya ke allowedTools.
from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage
# Skills in .claude/skills/ are discovered automatically
# when settingSources includes "project"
async for message in query(
prompt="Review this PR using our code review checklist",
options=ClaudeAgentOptions(
setting_sources=["user", "project"],
skills="all",
allowed_tools=["Read", "Grep", "Glob"],
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)
import { query } from "@anthropic-ai/claude-agent-sdk";
// Skills in .claude/skills/ are discovered automatically
// when settingSources includes "project"
for await (const message of query({
prompt: "Review this PR using our code review checklist",
options: {
settingSources: ["user", "project"],
skills: "all",
allowedTools: ["Read", "Grep", "Glob"]
}
})) {
if (message.type === "result" && message.subtype === "success") {
console.log(message.result);
}
}
Untuk lebih lanjut tentang membuat dan menggunakan skills, lihat Agent Skills di SDK.
Hooks
SDK mendukung dua cara untuk mendefinisikan hooks, dan mereka berjalan beriringan:
- Filesystem hooks: perintah shell yang didefinisikan di
settings.json, dimuat ketikasettingSourcesmencakup sumber yang relevan. Ini adalah hooks yang sama yang akan Anda konfigurasi untuk sesi Claude Code interaktif. - Programmatic hooks: fungsi callback yang diteruskan langsung ke
query(). Ini berjalan dalam proses aplikasi Anda dan dapat mengembalikan keputusan terstruktur. Lihat Kontrol eksekusi dengan hooks.
Kedua tipe berjalan selama siklus hidup hook yang sama. Jika Anda sudah memiliki hooks di .claude/settings.json proyek Anda dan Anda menetapkan settingSources: ["project"], hooks tersebut berjalan secara otomatis di SDK tanpa konfigurasi tambahan.
Callback hook menerima input tool dan mengembalikan dict keputusan. Mengembalikan {} (dict kosong) berarti izinkan tool untuk melanjutkan. Mengembalikan {"decision": "block", "reason": "..."} mencegah eksekusi dan alasan dikirim ke Claude sebagai hasil tool. Lihat panduan hooks untuk tanda tangan callback lengkap dan tipe pengembalian.
from claude_agent_sdk import query, ClaudeAgentOptions, HookMatcher, ResultMessage
# PreToolUse hook callback. Positional args:
# input_data: HookInput dict with tool_name, tool_input, hook_event_name
# tool_use_id: str | None, the ID of the tool call being intercepted
# context: HookContext, carries session metadata
async def audit_bash(input_data, tool_use_id, context):
command = input_data.get("tool_input", {}).get("command", "")
if "rm -rf" in command:
return {"decision": "block", "reason": "Destructive command blocked"}
return {} # Empty dict: allow the tool to proceed
# Filesystem hooks from .claude/settings.json run automatically
# when settingSources loads them. You can also add programmatic hooks:
async for message in query(
prompt="Refactor the auth module",
options=ClaudeAgentOptions(
setting_sources=["project"], # Loads hooks from .claude/settings.json
hooks={
"PreToolUse": [
HookMatcher(matcher="Bash", hooks=[audit_bash]),
]
},
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)
import { query, type HookInput, type HookJSONOutput } from "@anthropic-ai/claude-agent-sdk";
// PreToolUse hook callback. HookInput is a discriminated union on
// hook_event_name, so narrowing on it gives TypeScript the right
// tool_input shape for this event.
const auditBash = async (input: HookInput): Promise<HookJSONOutput> => {
if (input.hook_event_name !== "PreToolUse") return {};
const toolInput = input.tool_input as { command?: string };
if (toolInput.command?.includes("rm -rf")) {
return { decision: "block", reason: "Destructive command blocked" };
}
return {}; // Empty object: allow the tool to proceed
};
// Filesystem hooks from .claude/settings.json run automatically
// when settingSources loads them. You can also add programmatic hooks:
for await (const message of query({
prompt: "Refactor the auth module",
options: {
settingSources: ["project"], // Loads hooks from .claude/settings.json
hooks: {
PreToolUse: [{ matcher: "Bash", hooks: [auditBash] }]
}
}
})) {
if (message.type === "result" && message.subtype === "success") {
console.log(message.result);
}
}
Kapan menggunakan tipe hook mana
| Tipe hook | Terbaik untuk |
|---|---|
Filesystem (settings.json) |
Berbagi hooks antara sesi CLI dan SDK. Mendukung "command" (skrip shell), "http" (POST ke endpoint), "mcp_tool" (panggil tool server MCP yang terhubung), "prompt" (LLM mengevaluasi prompt), dan "agent" (menghasilkan agen verifier). Ini dijalankan di agen utama dan subagen apa pun yang dihasilkannya. |
Programmatic (callbacks di query()) |
Logika khusus aplikasi; mengembalikan keputusan terstruktur; integrasi dalam proses. Dibatasi hanya pada sesi utama. |
Untuk detail lengkap tentang hooks terprogram, lihat Kontrol eksekusi dengan hooks. Untuk sintaks hook filesystem, lihat Hooks.
Pilih fitur yang tepat
Agent SDK memberi Anda akses ke beberapa cara untuk memperluas perilaku agen Anda. Jika Anda tidak yakin mana yang digunakan, tabel ini memetakan tujuan umum ke pendekatan yang tepat.
| Anda ingin... | Gunakan | Permukaan SDK |
|---|---|---|
| Atur konvensi proyek yang selalu diikuti agen Anda | CLAUDE.md | settingSources: ["project"] memuat secara otomatis |
| Berikan agen materi referensi yang dimuat ketika relevan | Skills | settingSources + skills option |
| Jalankan alur kerja yang dapat digunakan kembali (deploy, review, release) | User-invocable skills | settingSources + skills option |
| Delegasikan subtask terisolasi ke konteks segar (research, review) | Subagents | Parameter agents + allowedTools: ["Agent"] |
| Koordinasikan beberapa instans Claude Code dengan daftar tugas bersama dan pesan inter-agen langsung | Agent teams | Tidak dikonfigurasi langsung melalui opsi SDK. Agent teams adalah fitur CLI di mana satu sesi bertindak sebagai pemimpin tim, mengoordinasikan pekerjaan di seluruh rekan kerja independen |
| Jalankan logika deterministik pada tool calls (audit, block, transform) | Hooks | Parameter hooks dengan callbacks, atau skrip shell dimuat melalui settingSources |
| Berikan Claude akses tool terstruktur ke layanan eksternal | MCP | Parameter mcpServers |
Setiap fitur yang Anda aktifkan menambah jendela konteks agen Anda. Untuk biaya per-fitur dan bagaimana fitur ini berlapis bersama, lihat Perluas Claude Code.
Sumber daya terkait
- Perluas Claude Code: Gambaran konseptual semua fitur ekstensi, dengan tabel perbandingan dan analisis biaya konteks
- Skills di SDK: Panduan lengkap menggunakan skills secara terprogram
- Subagents: Tentukan dan panggil subagents untuk subtask terisolasi
- Hooks: Intersep dan kontrol perilaku agen di titik eksekusi kunci
- Permissions: Kontrol akses tool dengan mode, rules, dan callbacks
- System prompts: Suntikkan konteks tanpa file CLAUDE.md