@grok/agent-sdk 0.7.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/channels/github/cursor-account.d.ts +1 -0
- package/dist/channels/github/cursor-account.d.ts.map +1 -1
- package/dist/channels/github/cursor-account.js +8 -2
- package/dist/channels/origin/cursor-account.d.ts +6 -0
- package/dist/channels/origin/cursor-account.d.ts.map +1 -1
- package/dist/channels/origin/cursor-account.js +17 -0
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.Ch-048af.js → app.CpLKJnOA.js} +4 -4
- package/dist/docs/assets/changelog.md.DoOgjnPC.js +1 -0
- package/dist/docs/assets/{changelog.md.SoN0MK7o.lean.js → changelog.md.DoOgjnPC.lean.js} +1 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.BJ_1eI6D.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.D7BIa9Su.js → VPLocalSearchBox.Cr1HJ_9k.js} +1 -1
- package/dist/docs/assets/chunks/{arc.BIzu7OVF.js → arc.BjpgGAMM.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.DNznI0Sn.js → architectureDiagram-Q4EWVU46.CKdhNPPk.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.B4y6Y5eG.js → baseUniq.iovoEQbg.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BudnBsgw.js → blockDiagram-DXYQGD6D.BYQIeDre.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY._bB00GdB.js → c4Diagram-AHTNJAMY.gbWi2q8N.js} +1 -1
- package/dist/docs/assets/chunks/channel.BP0n324b.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.CRftnUwS.js → chunk-4BX2VUAB.1Mem4UG9.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CSx1x2Ob.js → chunk-4TB4RGXK.Dn3H-X_H.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.KkLHAAbH.js → chunk-55IACEB6.BkpSDZwX.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.DDeKCCtX.js → chunk-EDXVE4YY.BScqy1zP.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DrLlsD9m.js → chunk-FMBD7UC4.Cp394LWf.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.DeVYOGcT.js → chunk-OYMX7WX6.BDv9LhoL.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.Cz4_bS6p.js → chunk-QZHKN3VN.CsgCcrKO.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.CwrYtDVo.js → chunk-YZCP3GAM.BKBpIC5O.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.BhTtyWMA.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.BhTtyWMA.js +1 -0
- package/dist/docs/assets/chunks/clone.BVK2rFqj.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.3d8hflz6.js → cose-bilkent-S5V4N54A.Bs3ZS9PC.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.BVEgjiPg.js → dagre-KV5264BT.CgWi0tY2.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.j7dZpUK_.js → diagram-5BDNPKRD.rn6qIo9N.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.4flIgIon.js → diagram-G4DWMVQ6.ChhW8oww.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.BlJiFh-S.js → diagram-MMDJMWI5.C0wH5KSk.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.DHAOHEyM.js → diagram-TYMM5635.CNEcrwA0.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.DkmyG7xK.js → erDiagram-SMLLAGMA.DCsnKO-7.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.L_WiaAU6.js → flowDiagram-DWJPFMVM.WCMkfvP0.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CT6kOI2a.js → ganttDiagram-T4ZO3ILL.BUb1Sxfr.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.D8CRlLqh.js → gitGraphDiagram-UUTBAWPF._kORbCzm.js} +1 -1
- package/dist/docs/assets/chunks/{graph.CdOyJvsX.js → graph.PrGRm4KW.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.DcmXeSos.js → infoDiagram-42DDH7IO.BxhCjiQM.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BBjY4mxr.js → ishikawaDiagram-UXIWVN3A.5ddTis2y.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.BrXteAB6.js → journeyDiagram-VCZTEJTY.BUStU27-.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.OlHsUJVV.js → kanban-definition-6JOO6SKY.CJd1psl3.js} +1 -1
- package/dist/docs/assets/chunks/{layout.DDwvoQlY.js → layout.DqvbZSML.js} +1 -1
- package/dist/docs/assets/chunks/{linear.BRXPDWj3.js → linear.DOmz-1UB.js} +1 -1
- package/dist/docs/assets/chunks/{min.3YwC0t3o.js → min.33k2v8dM.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.mPHnT2lN.js → mindmap-definition-QFDTVHPH.iISCqCXC.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.DEK2--em.js → pieDiagram-DEJITSTG.BHvVgzmD.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.NCdRAOzK.js → quadrantDiagram-34T5L4WZ.CY3w_-Cn.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DLAocFWZ.js → requirementDiagram-MS252O5E.CHXKQS1v.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.afIOqpyT.js → sankeyDiagram-XADWPNL6.DTtRoGss.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.DXBjvkkE.js → sequenceDiagram-FGHM5R23.NnPcQ3eY.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B_SGgvgs.js → stateDiagram-FHFEXIEX.D8DFciH7.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ESAwmMws.js +1 -0
- package/dist/docs/assets/chunks/{theme.bNyH5NPA.js → theme.CwkiT-Fo.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CE6S1iSb.js → timeline-definition-GMOUNBTQ._wIWkMU6.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Blk7wb8V.js → vennDiagram-DHZGUBPP.NLVv7R6r.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.DQqE3WF8.js → wardley-RL74JXVD.DbsCXUZp.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.MUEQyRnz.js → wardleyDiagram-NUSXRM2D.Dp5uAVDl.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DnJA2aXp.js → xychartDiagram-5P7HB3ND.eOEBq4rX.js} +1 -1
- package/dist/docs/assets/{deployment.md.N9S5KC5R.js → deployment.md.CIRydNl3.js} +2 -2
- package/dist/docs/assets/{deployment.md.N9S5KC5R.lean.js → deployment.md.CIRydNl3.lean.js} +1 -1
- package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.js +82 -0
- package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.lean.js +1 -0
- package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.js → reference_agent-config.md.CfM1S6Ac.js} +2 -2
- package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.lean.js → reference_agent-config.md.CfM1S6Ac.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +35 -35
- package/dist/docs/changelog.html +36 -36
- package/dist/docs/changelog.md +8 -0
- package/dist/docs/deployment.html +38 -38
- package/dist/docs/deployment.md +4 -0
- package/dist/docs/evals.html +35 -35
- package/dist/docs/guides/agent-to-agent.html +35 -35
- package/dist/docs/guides/bitbucket.html +35 -35
- package/dist/docs/guides/cloud-agents.html +35 -35
- package/dist/docs/guides/convert-automation.html +35 -35
- package/dist/docs/guides/github.html +35 -35
- package/dist/docs/guides/gitlab.html +35 -35
- package/dist/docs/guides/improve.html +35 -35
- package/dist/docs/guides/jev.html +35 -35
- package/dist/docs/guides/mcp-oauth.html +35 -35
- package/dist/docs/guides/migrate.html +36 -36
- package/dist/docs/guides/opentelemetry.html +35 -35
- package/dist/docs/guides/pagerduty.html +35 -35
- package/dist/docs/guides/slack.html +35 -35
- package/dist/docs/guides/teams.html +35 -35
- package/dist/docs/guides/webhooks.html +35 -35
- package/dist/docs/guides/workload-identity.html +141 -0
- package/dist/docs/guides/workload-identity.md +227 -0
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +35 -35
- package/dist/docs/index.html +35 -35
- package/dist/docs/llms-full.txt +245 -1
- package/dist/docs/llms.txt +1 -0
- package/dist/docs/quickstart.html +35 -35
- package/dist/docs/reference/access.html +35 -35
- package/dist/docs/reference/agent-config.html +37 -37
- package/dist/docs/reference/agent-config.md +1 -1
- package/dist/docs/reference/artifacts.html +35 -35
- package/dist/docs/reference/channels.html +35 -35
- package/dist/docs/reference/cli.html +35 -35
- package/dist/docs/reference/connections.html +35 -35
- package/dist/docs/reference/evals.html +35 -35
- package/dist/docs/reference/extensions.html +35 -35
- package/dist/docs/reference/hooks.html +35 -35
- package/dist/docs/reference/http-api.html +35 -35
- package/dist/docs/reference/instructions.html +35 -35
- package/dist/docs/reference/limits.html +35 -35
- package/dist/docs/reference/memory.html +35 -35
- package/dist/docs/reference/playground.html +35 -35
- package/dist/docs/reference/project-layout.html +35 -35
- package/dist/docs/reference/schedules.html +35 -35
- package/dist/docs/reference/sessions.html +35 -35
- package/dist/docs/reference/skills.html +35 -35
- package/dist/docs/reference/subagents.html +35 -35
- package/dist/docs/reference/tools.html +35 -35
- package/dist/docs/templates/agentic-owners.html +35 -35
- package/dist/docs/templates/reviews.html +35 -35
- package/dist/docs/troubleshooting.html +35 -35
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +6 -3
- package/dist/internal/cursor-account-mcp-auth.d.ts +7 -1
- package/dist/internal/cursor-account-mcp-auth.d.ts.map +1 -1
- package/dist/internal/cursor-account-mcp-auth.js +20 -5
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -1
- package/dist/internal/discovery/connections.d.ts +5 -0
- package/dist/internal/discovery/connections.d.ts.map +1 -1
- package/dist/internal/discovery/connections.js +18 -1
- package/dist/internal/host-kv-cas.d.ts.map +1 -1
- package/dist/internal/host-kv-cas.js +21 -3
- package/dist/internal/hosted-delivery-protocol.d.ts +1 -0
- package/dist/internal/hosted-delivery-protocol.d.ts.map +1 -1
- package/dist/internal/hosted-delivery-protocol.js +4 -2
- package/dist/internal/hosted-delivery.d.ts +4 -1
- package/dist/internal/hosted-delivery.d.ts.map +1 -1
- package/dist/internal/hosted-delivery.js +3 -1
- package/dist/internal/ids.d.ts +2 -0
- package/dist/internal/ids.d.ts.map +1 -1
- package/dist/internal/ids.js +5 -0
- package/dist/internal/schedule-runner.d.ts +1 -0
- package/dist/internal/schedule-runner.d.ts.map +1 -1
- package/dist/internal/schedule-runner.js +10 -1
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +8 -4
- package/dist/internal/session-engine.d.ts +4 -1
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +3 -1
- package/dist/oidc-token.d.ts +4 -0
- package/dist/oidc-token.d.ts.map +1 -1
- package/dist/playground/assets/chunk-YOKDWASO-BPO_8GRX.js +115 -0
- package/dist/playground/assets/highlighted-body-KPVGNVTW-CxEV-T_f.js +1 -0
- package/dist/playground/assets/index-CjFJhCtb.js +62 -0
- package/dist/playground/assets/index-vwUVwmk8.css +1 -0
- package/dist/playground/assets/mermaid-HWGCJPDP-eK-fpbFn.js +1 -0
- package/dist/playground/index.html +2 -2
- package/docs/changelog.md +8 -0
- package/docs/deployment.md +4 -0
- package/docs/guides/workload-identity.md +232 -0
- package/docs/reference/agent-config.md +1 -1
- package/package.json +3 -1
- package/skills/deploy/SKILL.md +1 -1
- package/dist/docs/assets/changelog.md.SoN0MK7o.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.BdYoBKxY.js +0 -1
- package/dist/docs/assets/chunks/channel.CgxlmuBS.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DWroREP-.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DWroREP-.js +0 -1
- package/dist/docs/assets/chunks/clone.F824-PNx.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.OKAy5Bz7.js +0 -1
- package/dist/playground/assets/index-BaBSZXki.css +0 -1
- package/dist/playground/assets/index-BkAF8YlO.js +0 -62
|
@@ -9,42 +9,42 @@
|
|
|
9
9
|
<link rel="preload stylesheet" href="/docs/assets/style.B7zPxANR.css" as="style">
|
|
10
10
|
<link rel="preload stylesheet" href="/docs/vp-icons.css" as="style">
|
|
11
11
|
|
|
12
|
-
<script type="module" src="/docs/assets/app.
|
|
12
|
+
<script type="module" src="/docs/assets/app.CpLKJnOA.js"></script>
|
|
13
13
|
<link rel="preload" href="/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
|
14
14
|
<link rel="modulepreload" href="/docs/assets/chunks/framework.BNw1pucY.js">
|
|
15
|
-
<link rel="modulepreload" href="/docs/assets/chunks/theme.
|
|
15
|
+
<link rel="modulepreload" href="/docs/assets/chunks/theme.CwkiT-Fo.js">
|
|
16
16
|
<link rel="modulepreload" href="/docs/assets/chunks/katex.DkKDou_j.js">
|
|
17
|
-
<link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.
|
|
18
|
-
<link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.
|
|
19
|
-
<link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.
|
|
20
|
-
<link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.
|
|
21
|
-
<link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.
|
|
22
|
-
<link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF.
|
|
23
|
-
<link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.
|
|
24
|
-
<link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.
|
|
25
|
-
<link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.
|
|
26
|
-
<link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.
|
|
27
|
-
<link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.
|
|
28
|
-
<link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.
|
|
29
|
-
<link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.
|
|
30
|
-
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.
|
|
31
|
-
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.
|
|
32
|
-
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.
|
|
33
|
-
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.
|
|
34
|
-
<link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.
|
|
35
|
-
<link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ.
|
|
36
|
-
<link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.
|
|
37
|
-
<link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.
|
|
38
|
-
<link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.
|
|
39
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.
|
|
40
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.
|
|
41
|
-
<link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.
|
|
42
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.
|
|
43
|
-
<link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.
|
|
44
|
-
<link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.
|
|
45
|
-
<link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.
|
|
46
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.
|
|
47
|
-
<link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.
|
|
17
|
+
<link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.CgWi0tY2.js">
|
|
18
|
+
<link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.Bs3ZS9PC.js">
|
|
19
|
+
<link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.gbWi2q8N.js">
|
|
20
|
+
<link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.WCMkfvP0.js">
|
|
21
|
+
<link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.DCsnKO-7.js">
|
|
22
|
+
<link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF._kORbCzm.js">
|
|
23
|
+
<link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.BUb1Sxfr.js">
|
|
24
|
+
<link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.BxhCjiQM.js">
|
|
25
|
+
<link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.BHvVgzmD.js">
|
|
26
|
+
<link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.CY3w_-Cn.js">
|
|
27
|
+
<link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.eOEBq4rX.js">
|
|
28
|
+
<link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.CHXKQS1v.js">
|
|
29
|
+
<link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.NnPcQ3eY.js">
|
|
30
|
+
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.BhTtyWMA.js">
|
|
31
|
+
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.BhTtyWMA.js">
|
|
32
|
+
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.D8DFciH7.js">
|
|
33
|
+
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ESAwmMws.js">
|
|
34
|
+
<link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.BUStU27-.js">
|
|
35
|
+
<link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ._wIWkMU6.js">
|
|
36
|
+
<link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.iISCqCXC.js">
|
|
37
|
+
<link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.CJd1psl3.js">
|
|
38
|
+
<link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.DTtRoGss.js">
|
|
39
|
+
<link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.CNEcrwA0.js">
|
|
40
|
+
<link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.C0wH5KSk.js">
|
|
41
|
+
<link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.BYQIeDre.js">
|
|
42
|
+
<link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.rn6qIo9N.js">
|
|
43
|
+
<link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.CKdhNPPk.js">
|
|
44
|
+
<link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.5ddTis2y.js">
|
|
45
|
+
<link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.NLVv7R6r.js">
|
|
46
|
+
<link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.ChhW8oww.js">
|
|
47
|
+
<link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.Dp5uAVDl.js">
|
|
48
48
|
<link rel="modulepreload" href="/docs/assets/chunks/virtual_mermaid-config.DDnGl6nM.js">
|
|
49
49
|
<link rel="modulepreload" href="/docs/assets/reference_cli.md.NS6U5a-7.lean.js">
|
|
50
50
|
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
<link rel="alternate" type="text/markdown" href="/docs/reference/cli.md">
|
|
54
54
|
</head>
|
|
55
55
|
<body>
|
|
56
|
-
<div id="app"><div class="Layout" data-v-2236bdfe><!--[--><!--]--><!--[--><span tabindex="-1" data-v-6821dd19></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-6821dd19>Skip to content</a><!--]--><!----><header class="VPNav" data-v-2236bdfe data-v-4e61ebec><div class="VPNavBar" data-v-4e61ebec data-v-9cc98aae><div class="wrapper" data-v-9cc98aae><div class="container" data-v-9cc98aae><div class="title" data-v-9cc98aae><div class="VPNavBarTitle has-sidebar" data-v-9cc98aae data-v-0af80de3><a class="title" href="/docs/" data-v-0af80de3><!--[--><!--]--><!----><span data-v-0af80de3>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.7.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.7.0</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-9cc98aae><div class="content-body" data-v-9cc98aae><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9cc98aae><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9cc98aae data-v-292c275e><span id="main-nav-aria-label" class="visually-hidden" data-v-292c275e> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/quickstart.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9cc98aae data-v-8870d03f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8870d03f data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-9cc98aae data-v-8ec5d5fb data-v-b3186b2b><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b3186b2b><span class="vpi-more-horizontal icon" data-v-b3186b2b></span></button><div class="menu" data-v-b3186b2b><div class="VPMenu" data-v-b3186b2b data-v-0615a312><!----><!--[--><!--[--><!----><div class="group" data-v-8ec5d5fb><div class="item appearance" data-v-8ec5d5fb><p class="label" data-v-8ec5d5fb>Appearance</p><div class="appearance-action" data-v-8ec5d5fb><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8ec5d5fb data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9cc98aae data-v-2752d785><span class="container" data-v-2752d785><span class="top" data-v-2752d785></span><span class="middle" data-v-2752d785></span><span class="bottom" data-v-2752d785></span></span></button></div></div></div></div><div class="divider" data-v-9cc98aae><div class="divider-line" data-v-9cc98aae></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-2236bdfe data-v-60cb0e48><div class="container" data-v-60cb0e48><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-60cb0e48><span class="vpi-align-left menu-icon" data-v-60cb0e48></span><span class="menu-text" data-v-60cb0e48>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-60cb0e48 data-v-179080fa><button data-v-179080fa>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-2236bdfe data-v-62bf049e><div class="curtain" data-v-62bf049e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-62bf049e><span class="visually-hidden" id="sidebar-aria-label" data-v-62bf049e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Getting started</h2><!----></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/changelog.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/teams.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Microsoft Teams</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/deployment.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible has-active" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-2236bdfe data-v-d04ebd1c><div class="VPDoc has-sidebar has-aside" data-v-d04ebd1c data-v-1686efb8><!--[--><!--]--><div class="container" data-v-1686efb8><div class="aside" data-v-1686efb8><div class="aside-curtain" data-v-1686efb8></div><div class="aside-container" data-v-1686efb8><div class="aside-content" data-v-1686efb8><div class="VPDocAside" data-v-1686efb8 data-v-95dd70cb><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-95dd70cb data-v-73c4e114><div class="content" data-v-73c4e114><div class="outline-marker" data-v-73c4e114></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-73c4e114>On this page</div><ul class="VPDocOutlineItem root" data-v-73c4e114 data-v-754cbe32><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-95dd70cb></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-1686efb8><div class="content-container" data-v-1686efb8><!--[--><!--]--><main class="main" data-v-1686efb8><div style="position:relative;" class="vp-doc _docs_reference_cli" data-v-1686efb8><div><h1 id="agent-sdk-cli" tabindex="-1">Agent SDK CLI <a class="header-anchor" href="#agent-sdk-cli" aria-label="Permalink to "Agent SDK CLI""></a></h1><p>The CLI needs Node 22.13 or newer. Run <code>agent-sdk <command> --help</code> to see every flag for that command.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk <command></span></span></code></pre></div><p><code>agent-sdk help --all</code> prints every command, and <code>agent-sdk help <command> --json</code> prints one command's flags as JSON.</p><p>Commands are named <code>agent-sdk <resource> <verb></code>, such as <code>agent-sdk deployment list</code>, apart from workflow verbs such as <code>init</code>, <code>dev</code>, and <code>deploy</code>. Older names, such as <code>agent-sdk deployments</code> or <code>agent-sdk secrets set</code>, still run and print the new form on stderr. The <code>bdk</code> command remains available.</p><h2 id="command-catalog" tabindex="-1">Command catalog <a class="header-anchor" href="#command-catalog" aria-label="Permalink to "Command catalog""></a></h2><h3 id="development-commands" tabindex="-1">Development commands <a class="header-anchor" href="#development-commands" aria-label="Permalink to "Development commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><code>help</code>, <code>--help</code>, <code>-h</code></td><td>Print the command index, or one command's help</td></tr><tr><td><a href="#serve"><code>serve</code></a></td><td>Serve one or more agents over HTTP</td></tr><tr><td><a href="#dev"><code>dev</code></a></td><td>Serve agents with local-development behavior</td></tr><tr><td><a href="#docs"><code>docs</code></a></td><td>Serve the bundled documentation</td></tr><tr><td><a href="#init"><code>init</code></a></td><td>Scaffold a project, or convert an Automation</td></tr><tr><td><a href="#migrate"><code>migrate</code></a></td><td>Open a pull request that migrates an early-alpha project</td></tr><tr><td><a href="#skills-install"><code>skills list</code>, <code>skills install</code></a></td><td>List or refresh the bundled coding-agent skills</td></tr><tr><td><a href="#info"><code>info</code></a></td><td>Print a project's discovered parts or deployment manifest</td></tr><tr><td><a href="#validate"><code>validate</code></a></td><td>Check project diagnostics and set the exit status</td></tr><tr><td><a href="#version"><code>version</code></a></td><td>Print the installed package version</td></tr><tr><td><a href="#update"><code>update</code></a></td><td>Upgrade the installed CLI</td></tr><tr><td><a href="#login-logout-whoami"><code>login</code>, <code>logout</code>, <code>whoami</code></a></td><td>Store, remove, or show the Cursor credential</td></tr></tbody></table><h3 id="session-and-eval-commands" tabindex="-1">Session and eval commands <a class="header-anchor" href="#session-and-eval-commands" aria-label="Permalink to "Session and eval commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#chat"><code>chat</code></a></td><td>Talk to a running agent, or reattach a session</td></tr><tr><td><a href="#run"><code>run</code></a></td><td>Run turns on a local or running agent</td></tr><tr><td><a href="#tool-call"><code>tool call</code></a></td><td>Call a server tool without a model turn</td></tr><tr><td><a href="#logs"><code>logs</code></a></td><td>Follow or dump agent logs</td></tr><tr><td><a href="#session-list"><code>session list</code></a></td><td>List sessions, or their costs</td></tr><tr><td><a href="#session-get"><code>session get</code></a></td><td>Inspect a session or a saved trace</td></tr><tr><td><a href="#session-create"><code>session create</code></a></td><td>Start or continue a hosted session</td></tr><tr><td><a href="#eval"><code>eval</code></a></td><td>Run evals, or list, get, and cancel remote eval batches</td></tr></tbody></table><h3 id="managed-hosting-commands" tabindex="-1">Managed hosting commands <a class="header-anchor" href="#managed-hosting-commands" aria-label="Permalink to "Managed hosting commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#deploy"><code>deploy</code></a></td><td>Deploy an agent</td></tr><tr><td><a href="#deployment-list"><code>deployment list</code>, <code>deployment get</code></a></td><td>List deployments, or inspect one</td></tr><tr><td><a href="#deployment-lifecycle"><code>deployment stop</code>, <code>start</code>, <code>kill</code>, <code>unlock</code>, <code>cancel-runs</code>, <code>upgrade</code>, <code>rollback</code>, <code>delete</code>, <code>rotate-token</code></a></td><td>Change a deployment's state, release, or alias token</td></tr><tr><td><a href="#deployment-update"><code>deployment update</code></a></td><td>Replace a deployment's event repositories</td></tr><tr><td><a href="#secret"><code>secret</code></a></td><td>Set, list, or delete deployment secrets</td></tr></tbody></table><h3 id="connection-and-channel-commands" tabindex="-1">Connection and channel commands <a class="header-anchor" href="#connection-and-channel-commands" aria-label="Permalink to "Connection and channel commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#mcp"><code>mcp serve</code>, <code>mcp install</code></a></td><td>Connect an MCP client to an agent</td></tr><tr><td><a href="#mcp-oauth"><code>mcp oauth</code></a></td><td>Authorize an MCP connection</td></tr><tr><td><a href="#slack"><code>slack</code></a></td><td>Provision and check Slack channel apps</td></tr><tr><td><a href="#teams"><code>teams</code></a></td><td>Connect, check, and package a Microsoft Teams bot</td></tr><tr><td><a href="#github"><code>github</code></a></td><td>Forward, replay, and inspect GitHub webhooks</td></tr><tr><td><a href="#replay-other-webhooks"><code>gitlab</code>, <code>bitbucket</code>, <code>pagerduty</code></a></td><td>Replay and inspect GitLab, Bitbucket, or PagerDuty webhooks</td></tr></tbody></table><h2 id="choose-a-target" tabindex="-1">Targets <a class="header-anchor" href="#choose-a-target" aria-label="Permalink to "Targets {#choose-a-target}""></a></h2><table tabindex="0"><thead><tr><th>Target</th><th>Selection</th><th>Commands</th></tr></thead><tbody><tr><td>Ephemeral local server</td><td>Omit <code>--url</code> and <code>--prod</code></td><td><code>run</code>, <code>tool call</code>, <code>eval</code></td></tr><tr><td>Running server</td><td>Pass <code>--url <baseUrl></code></td><td><code>chat</code>, <code>run</code>, <code>tool call</code>, <code>eval</code>, <code>logs</code>, <code>session list</code>, <code>session get</code>, <code>mcp serve</code></td></tr><tr><td>Default local server</td><td>Omit <code>--url</code> and <code>--prod</code> to use <code>http://127.0.0.1:3000</code></td><td><code>chat</code>, <code>logs</code>, <code>session list</code>, <code>session get</code></td></tr><tr><td>Hosted deployment</td><td>Pass <code>--prod</code></td><td><code>session list</code>, <code>session get</code>, <code>logs</code>. <code>session create</code> is always hosted.</td></tr></tbody></table><p>A hosted deployment supports only the commands in its row. <code>chat</code>, <code>run</code>, <code>tool call</code>, <code>eval</code>, <code>mcp serve</code>, and <code>mcp install</code> exit with a usage error when you pass <code>--prod</code>. To test a hosted agent, start a turn with <a href="#session-create"><code>session create</code></a> and inspect it with <a href="#session-get"><code>session get</code></a>.</p><p><code>--url</code> and <code>--prod</code> are mutually exclusive. An explicit <code>--url</code> must include the slug for a multi-agent server, such as <code>http://127.0.0.1:3000/pr-approver</code>. Otherwise <code>--slug</code> picks the agent, and under <code>--prod</code> it defaults to the <code>--dir</code> basename. <code>--json</code> prints one JSON document on stdout, including errors. Without it, output is text, even when piped.</p><h2 id="local-servers" tabindex="-1">Local servers <a class="header-anchor" href="#local-servers" aria-label="Permalink to "Local servers""></a></h2><h3 id="serve" tabindex="-1">Serve agents <a class="header-anchor" href="#serve" aria-label="Permalink to "Serve agents {#serve}""></a></h3><p><code>serve</code> mounts every project discovered under <code>--dir</code>:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk serve [--dir <path>] [--port <n>] [--host <host>]</span></span>
|
|
56
|
+
<div id="app"><div class="Layout" data-v-2236bdfe><!--[--><!--]--><!--[--><span tabindex="-1" data-v-6821dd19></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-6821dd19>Skip to content</a><!--]--><!----><header class="VPNav" data-v-2236bdfe data-v-4e61ebec><div class="VPNavBar" data-v-4e61ebec data-v-9cc98aae><div class="wrapper" data-v-9cc98aae><div class="container" data-v-9cc98aae><div class="title" data-v-9cc98aae><div class="VPNavBarTitle has-sidebar" data-v-9cc98aae data-v-0af80de3><a class="title" href="/docs/" data-v-0af80de3><!--[--><!--]--><!----><span data-v-0af80de3>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.7.1 (@grok/agent-sdk package)" data-v-a03aeddf>0.7.1</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-9cc98aae><div class="content-body" data-v-9cc98aae><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9cc98aae><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9cc98aae data-v-292c275e><span id="main-nav-aria-label" class="visually-hidden" data-v-292c275e> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/quickstart.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9cc98aae data-v-8870d03f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8870d03f data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-9cc98aae data-v-8ec5d5fb data-v-b3186b2b><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b3186b2b><span class="vpi-more-horizontal icon" data-v-b3186b2b></span></button><div class="menu" data-v-b3186b2b><div class="VPMenu" data-v-b3186b2b data-v-0615a312><!----><!--[--><!--[--><!----><div class="group" data-v-8ec5d5fb><div class="item appearance" data-v-8ec5d5fb><p class="label" data-v-8ec5d5fb>Appearance</p><div class="appearance-action" data-v-8ec5d5fb><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8ec5d5fb data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9cc98aae data-v-2752d785><span class="container" data-v-2752d785><span class="top" data-v-2752d785></span><span class="middle" data-v-2752d785></span><span class="bottom" data-v-2752d785></span></span></button></div></div></div></div><div class="divider" data-v-9cc98aae><div class="divider-line" data-v-9cc98aae></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-2236bdfe data-v-60cb0e48><div class="container" data-v-60cb0e48><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-60cb0e48><span class="vpi-align-left menu-icon" data-v-60cb0e48></span><span class="menu-text" data-v-60cb0e48>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-60cb0e48 data-v-179080fa><button data-v-179080fa>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-2236bdfe data-v-62bf049e><div class="curtain" data-v-62bf049e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-62bf049e><span class="visually-hidden" id="sidebar-aria-label" data-v-62bf049e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Getting started</h2><!----></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/changelog.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/teams.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Microsoft Teams</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/deployment.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/workload-identity.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Workload identity (OIDC)</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible has-active" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-2236bdfe data-v-d04ebd1c><div class="VPDoc has-sidebar has-aside" data-v-d04ebd1c data-v-1686efb8><!--[--><!--]--><div class="container" data-v-1686efb8><div class="aside" data-v-1686efb8><div class="aside-curtain" data-v-1686efb8></div><div class="aside-container" data-v-1686efb8><div class="aside-content" data-v-1686efb8><div class="VPDocAside" data-v-1686efb8 data-v-95dd70cb><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-95dd70cb data-v-73c4e114><div class="content" data-v-73c4e114><div class="outline-marker" data-v-73c4e114></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-73c4e114>On this page</div><ul class="VPDocOutlineItem root" data-v-73c4e114 data-v-754cbe32><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-95dd70cb></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-1686efb8><div class="content-container" data-v-1686efb8><!--[--><!--]--><main class="main" data-v-1686efb8><div style="position:relative;" class="vp-doc _docs_reference_cli" data-v-1686efb8><div><h1 id="agent-sdk-cli" tabindex="-1">Agent SDK CLI <a class="header-anchor" href="#agent-sdk-cli" aria-label="Permalink to "Agent SDK CLI""></a></h1><p>The CLI needs Node 22.13 or newer. Run <code>agent-sdk <command> --help</code> to see every flag for that command.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk <command></span></span></code></pre></div><p><code>agent-sdk help --all</code> prints every command, and <code>agent-sdk help <command> --json</code> prints one command's flags as JSON.</p><p>Commands are named <code>agent-sdk <resource> <verb></code>, such as <code>agent-sdk deployment list</code>, apart from workflow verbs such as <code>init</code>, <code>dev</code>, and <code>deploy</code>. Older names, such as <code>agent-sdk deployments</code> or <code>agent-sdk secrets set</code>, still run and print the new form on stderr. The <code>bdk</code> command remains available.</p><h2 id="command-catalog" tabindex="-1">Command catalog <a class="header-anchor" href="#command-catalog" aria-label="Permalink to "Command catalog""></a></h2><h3 id="development-commands" tabindex="-1">Development commands <a class="header-anchor" href="#development-commands" aria-label="Permalink to "Development commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><code>help</code>, <code>--help</code>, <code>-h</code></td><td>Print the command index, or one command's help</td></tr><tr><td><a href="#serve"><code>serve</code></a></td><td>Serve one or more agents over HTTP</td></tr><tr><td><a href="#dev"><code>dev</code></a></td><td>Serve agents with local-development behavior</td></tr><tr><td><a href="#docs"><code>docs</code></a></td><td>Serve the bundled documentation</td></tr><tr><td><a href="#init"><code>init</code></a></td><td>Scaffold a project, or convert an Automation</td></tr><tr><td><a href="#migrate"><code>migrate</code></a></td><td>Open a pull request that migrates an early-alpha project</td></tr><tr><td><a href="#skills-install"><code>skills list</code>, <code>skills install</code></a></td><td>List or refresh the bundled coding-agent skills</td></tr><tr><td><a href="#info"><code>info</code></a></td><td>Print a project's discovered parts or deployment manifest</td></tr><tr><td><a href="#validate"><code>validate</code></a></td><td>Check project diagnostics and set the exit status</td></tr><tr><td><a href="#version"><code>version</code></a></td><td>Print the installed package version</td></tr><tr><td><a href="#update"><code>update</code></a></td><td>Upgrade the installed CLI</td></tr><tr><td><a href="#login-logout-whoami"><code>login</code>, <code>logout</code>, <code>whoami</code></a></td><td>Store, remove, or show the Cursor credential</td></tr></tbody></table><h3 id="session-and-eval-commands" tabindex="-1">Session and eval commands <a class="header-anchor" href="#session-and-eval-commands" aria-label="Permalink to "Session and eval commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#chat"><code>chat</code></a></td><td>Talk to a running agent, or reattach a session</td></tr><tr><td><a href="#run"><code>run</code></a></td><td>Run turns on a local or running agent</td></tr><tr><td><a href="#tool-call"><code>tool call</code></a></td><td>Call a server tool without a model turn</td></tr><tr><td><a href="#logs"><code>logs</code></a></td><td>Follow or dump agent logs</td></tr><tr><td><a href="#session-list"><code>session list</code></a></td><td>List sessions, or their costs</td></tr><tr><td><a href="#session-get"><code>session get</code></a></td><td>Inspect a session or a saved trace</td></tr><tr><td><a href="#session-create"><code>session create</code></a></td><td>Start or continue a hosted session</td></tr><tr><td><a href="#eval"><code>eval</code></a></td><td>Run evals, or list, get, and cancel remote eval batches</td></tr></tbody></table><h3 id="managed-hosting-commands" tabindex="-1">Managed hosting commands <a class="header-anchor" href="#managed-hosting-commands" aria-label="Permalink to "Managed hosting commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#deploy"><code>deploy</code></a></td><td>Deploy an agent</td></tr><tr><td><a href="#deployment-list"><code>deployment list</code>, <code>deployment get</code></a></td><td>List deployments, or inspect one</td></tr><tr><td><a href="#deployment-lifecycle"><code>deployment stop</code>, <code>start</code>, <code>kill</code>, <code>unlock</code>, <code>cancel-runs</code>, <code>upgrade</code>, <code>rollback</code>, <code>delete</code>, <code>rotate-token</code></a></td><td>Change a deployment's state, release, or alias token</td></tr><tr><td><a href="#deployment-update"><code>deployment update</code></a></td><td>Replace a deployment's event repositories</td></tr><tr><td><a href="#secret"><code>secret</code></a></td><td>Set, list, or delete deployment secrets</td></tr></tbody></table><h3 id="connection-and-channel-commands" tabindex="-1">Connection and channel commands <a class="header-anchor" href="#connection-and-channel-commands" aria-label="Permalink to "Connection and channel commands""></a></h3><table tabindex="0"><thead><tr><th>Command</th><th>Contract</th></tr></thead><tbody><tr><td><a href="#mcp"><code>mcp serve</code>, <code>mcp install</code></a></td><td>Connect an MCP client to an agent</td></tr><tr><td><a href="#mcp-oauth"><code>mcp oauth</code></a></td><td>Authorize an MCP connection</td></tr><tr><td><a href="#slack"><code>slack</code></a></td><td>Provision and check Slack channel apps</td></tr><tr><td><a href="#teams"><code>teams</code></a></td><td>Connect, check, and package a Microsoft Teams bot</td></tr><tr><td><a href="#github"><code>github</code></a></td><td>Forward, replay, and inspect GitHub webhooks</td></tr><tr><td><a href="#replay-other-webhooks"><code>gitlab</code>, <code>bitbucket</code>, <code>pagerduty</code></a></td><td>Replay and inspect GitLab, Bitbucket, or PagerDuty webhooks</td></tr></tbody></table><h2 id="choose-a-target" tabindex="-1">Targets <a class="header-anchor" href="#choose-a-target" aria-label="Permalink to "Targets {#choose-a-target}""></a></h2><table tabindex="0"><thead><tr><th>Target</th><th>Selection</th><th>Commands</th></tr></thead><tbody><tr><td>Ephemeral local server</td><td>Omit <code>--url</code> and <code>--prod</code></td><td><code>run</code>, <code>tool call</code>, <code>eval</code></td></tr><tr><td>Running server</td><td>Pass <code>--url <baseUrl></code></td><td><code>chat</code>, <code>run</code>, <code>tool call</code>, <code>eval</code>, <code>logs</code>, <code>session list</code>, <code>session get</code>, <code>mcp serve</code></td></tr><tr><td>Default local server</td><td>Omit <code>--url</code> and <code>--prod</code> to use <code>http://127.0.0.1:3000</code></td><td><code>chat</code>, <code>logs</code>, <code>session list</code>, <code>session get</code></td></tr><tr><td>Hosted deployment</td><td>Pass <code>--prod</code></td><td><code>session list</code>, <code>session get</code>, <code>logs</code>. <code>session create</code> is always hosted.</td></tr></tbody></table><p>A hosted deployment supports only the commands in its row. <code>chat</code>, <code>run</code>, <code>tool call</code>, <code>eval</code>, <code>mcp serve</code>, and <code>mcp install</code> exit with a usage error when you pass <code>--prod</code>. To test a hosted agent, start a turn with <a href="#session-create"><code>session create</code></a> and inspect it with <a href="#session-get"><code>session get</code></a>.</p><p><code>--url</code> and <code>--prod</code> are mutually exclusive. An explicit <code>--url</code> must include the slug for a multi-agent server, such as <code>http://127.0.0.1:3000/pr-approver</code>. Otherwise <code>--slug</code> picks the agent, and under <code>--prod</code> it defaults to the <code>--dir</code> basename. <code>--json</code> prints one JSON document on stdout, including errors. Without it, output is text, even when piped.</p><h2 id="local-servers" tabindex="-1">Local servers <a class="header-anchor" href="#local-servers" aria-label="Permalink to "Local servers""></a></h2><h3 id="serve" tabindex="-1">Serve agents <a class="header-anchor" href="#serve" aria-label="Permalink to "Serve agents {#serve}""></a></h3><p><code>serve</code> mounts every project discovered under <code>--dir</code>:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk serve [--dir <path>] [--port <n>] [--host <host>]</span></span>
|
|
57
57
|
<span class="line"><span> [--mode multi|single] [--dev] [--api-key <key>]</span></span>
|
|
58
58
|
<span class="line"><span> [--state-root <path>]</span></span>
|
|
59
59
|
<span class="line"><span> [--bearer-token <secret> | --allow-anonymous]</span></span>
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
<span class="line"><span>agent-sdk pagerduty replay [incident-id] [replay flags]</span></span>
|
|
147
147
|
<span class="line"><span>agent-sdk <gitlab|bitbucket|pagerduty> events [--dir <path>] [--json]</span></span>
|
|
148
148
|
<span class="line"><span>agent-sdk <gitlab|bitbucket> forward [--dir <path>]</span></span></code></pre></div><p>Replay takes the same flags as <code>github replay</code>, including <code>--fixtures-dir</code>. <code>events</code> lists the discovered channels, and <code>forward</code> prints the webhook and tunnel recipe for live deliveries.</p><table tabindex="0"><thead><tr><th>Command</th><th>Replay events</th><th>Default event</th><th>Read credential</th><th><code>--secret</code> default</th></tr></thead><tbody><tr><td><code>gitlab replay</code></td><td><code>merge_request</code>, <code>note</code>, <code>pipeline</code>, <code>push</code></td><td><code>merge_request</code></td><td><code>GITLAB_TOKEN</code></td><td><code>GITLAB_WEBHOOK_SECRET</code></td></tr><tr><td><code>bitbucket replay</code></td><td><code>pullrequest:created</code>, <code>pullrequest:updated</code>, <code>pullrequest:comment_created</code>, <code>repo:push</code>, in Cloud or Data Center format</td><td><code>pullrequest:created</code></td><td><code>BITBUCKET_TOKEN</code></td><td><code>BITBUCKET_WEBHOOK_SECRET</code></td></tr><tr><td><code>pagerduty replay</code></td><td><code>incident.triggered</code>, <code>.acknowledged</code>, <code>.annotated</code>, <code>.escalated</code>, <code>.resolved</code>, <code>.reopened</code></td><td><code>incident.triggered</code></td><td>None</td><td><code>PAGERDUTY_WEBHOOK_SECRET</code></td></tr></tbody></table><p>PagerDuty replay's incident ID defaults to <code>PREPLAY1</code>, and <code>--comment</code> is the note body for <code>annotated</code>. Without a secret, its deliveries are unsigned, and <code>agent-sdk dev</code> admits them from loopback. See <a href="./../guides/gitlab.html">GitLab</a>, <a href="./../guides/bitbucket.html">Bitbucket</a>, and <a href="./../guides/pagerduty.html">PagerDuty</a> for channel setup.</p><h2 id="environment-variables" tabindex="-1">Environment variables <a class="header-anchor" href="#environment-variables" aria-label="Permalink to "Environment variables {#environment-variables}""></a></h2><p>The CLI tries <code>--api-key</code>, <code>CURSOR_API_KEY</code>, <code>CURSOR_API_KEY_FILE</code>, <code>CURSOR_SERVICE_ACCOUNT_KEY</code>, then the stored <code>agent-sdk login</code> credential, in that order.</p><table tabindex="0"><thead><tr><th>Variable</th><th>Contract</th></tr></thead><tbody><tr><td><code>CURSOR_API_KEY</code></td><td>Cursor credential.</td></tr><tr><td><code>CURSOR_API_KEY_FILE</code></td><td>Path to a Cursor credential file.</td></tr><tr><td><code>CURSOR_SERVICE_ACCOUNT_KEY</code></td><td>Team service-account credential.</td></tr><tr><td><code>CURSOR_API_BASE_URL</code></td><td>Backend for login, account, deployment, and event commands.</td></tr><tr><td><code>CURSOR_BACKEND_URL</code></td><td>Backend for agent turns. Set it with <code>CURSOR_API_BASE_URL</code> for a non-default backend.</td></tr><tr><td><code>AGENT_SERVE_CONFIG_DIR</code></td><td>CLI config directory for stored credentials and update state.</td></tr><tr><td><code>AGENT_SERVE_NO_UPDATE_CHECK</code>, <code>NO_UPDATE_NOTIFIER</code>, <code>CI</code></td><td>Turn off update checks when set to a value other than <code>0</code>.</td></tr><tr><td><code>GITHUB_WEBHOOK_SECRET</code></td><td>Default secret for GitHub forwarding and replay.</td></tr><tr><td><code>GITHUB_APP_ID</code>, <code>GITHUB_APP_PRIVATE_KEY</code>, <code>GITHUB_APP_INSTALLATION_ID</code></td><td>GitHub App credentials for outbound API calls.</td></tr><tr><td><code>GITHUB_TOKEN</code>, <code>GH_TOKEN</code></td><td>Tokens for outbound GitHub calls.</td></tr><tr><td><code>GITLAB_TOKEN</code>, <code>GITLAB_WEBHOOK_SECRET</code></td><td>GitLab API token and default webhook token.</td></tr><tr><td><code>GITLAB_API_BASE_URL</code></td><td>GitLab REST base URL for self-managed hosts.</td></tr><tr><td><code>BITBUCKET_TOKEN</code>, <code>BITBUCKET_WEBHOOK_SECRET</code></td><td>Bitbucket API token and default signing secret.</td></tr><tr><td><code>BITBUCKET_API_BASE_URL</code></td><td>Bitbucket Data Center REST base URL.</td></tr><tr><td><code>SLACK_BOT_TOKEN</code>, <code>SLACK_APP_TOKEN</code></td><td>Slack tokens for one agent. Multi-agent servers use <code><PREFIX>_SLACK_BOT_TOKEN</code> and <code><PREFIX>_SLACK_APP_TOKEN</code>.</td></tr></tbody></table><h2 id="exit-status" tabindex="-1">Exit status <a class="header-anchor" href="#exit-status" aria-label="Permalink to "Exit status""></a></h2><p>Every command uses these exit codes, and <code>agent-sdk help --json</code> lists them as <code>exitCodes</code>.</p><table tabindex="0"><thead><tr><th>Code</th><th>Meaning</th></tr></thead><tbody><tr><td><code>0</code></td><td><code>ok</code></td></tr><tr><td><code>1</code></td><td><code>failed</code>, <code>aborted</code>, <code>invalid_argument</code>, <code>rate_limited</code>, or <code>unavailable</code></td></tr><tr><td><code>2</code></td><td><code>usage</code>, for a bad command, flag, or argument</td></tr><tr><td><code>3</code></td><td><code>pending</code>, while the work still runs</td></tr><tr><td><code>4</code></td><td><code>not_found</code></td></tr><tr><td><code>5</code></td><td><code>unauthenticated</code> or <code>permission_denied</code></td></tr><tr><td><code>6</code></td><td><code>conflict</code> or <code>failed_precondition</code></td></tr></tbody></table><h2 id="related" tabindex="-1">Related <a class="header-anchor" href="#related" aria-label="Permalink to "Related""></a></h2><ul><li><a href="./project-layout.html">Project layout</a></li><li><a href="./sessions.html">Sessions, events, and streaming</a></li><li><a href="./../deployment.html">Deployment</a></li><li><a href="./../guides/migrate.html">Early-alpha migration</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-1686efb8 data-v-37fd6f02><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-37fd6f02><span class="visually-hidden" id="doc-footer-aria-label" data-v-37fd6f02>Pager</span><div class="pager" data-v-37fd6f02><a class="VPLink link pager-link prev" href="/docs/reference/playground.html" data-v-37fd6f02><!--[--><span class="desc" data-v-37fd6f02>Previous page</span><span class="title" data-v-37fd6f02>Playground</span><!--]--></a></div><div class="pager" data-v-37fd6f02><a class="VPLink link pager-link next" href="/docs/reference/http-api.html" data-v-37fd6f02><!--[--><span class="desc" data-v-37fd6f02>Next page</span><span class="title" data-v-37fd6f02>HTTP API</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
|
149
|
-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"
|
|
149
|
+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"DoOgjnPC\",\"deployment.md\":\"CIRydNl3\",\"evals.md\":\"Dne6VRmZ\",\"guides_agent-to-agent.md\":\"DcB3nhOz\",\"guides_bitbucket.md\":\"BiA6ZMFW\",\"guides_cloud-agents.md\":\"BdWqmUGb\",\"guides_convert-automation.md\":\"BvTxsJ8J\",\"guides_github.md\":\"CcuZ7keS\",\"guides_gitlab.md\":\"DcKusOcU\",\"guides_improve.md\":\"o3WOGR7n\",\"guides_jev.md\":\"DGCzkMUN\",\"guides_mcp-oauth.md\":\"GVPMKcYl\",\"guides_migrate.md\":\"B8CZxnnX\",\"guides_opentelemetry.md\":\"BRSktBHt\",\"guides_pagerduty.md\":\"pMXUkZZc\",\"guides_slack.md\":\"D7Rwyva4\",\"guides_teams.md\":\"7Lz2sbqB\",\"guides_webhooks.md\":\"B5DXt2v1\",\"guides_workload-identity.md\":\"DBV6YkXX\",\"hillclimbing.md\":\"M51bF-oT\",\"index.md\":\"DnJPj_B6\",\"quickstart.md\":\"r-oE8nkX\",\"reference_access.md\":\"C5lblfUC\",\"reference_agent-config.md\":\"CfM1S6Ac\",\"reference_artifacts.md\":\"BJpAI7h9\",\"reference_channels.md\":\"CRvqgU0n\",\"reference_cli.md\":\"NS6U5a-7\",\"reference_connections.md\":\"DoY4vrDH\",\"reference_evals.md\":\"DgfUtfIc\",\"reference_extensions.md\":\"DHbW6eOf\",\"reference_hooks.md\":\"vbIM394-\",\"reference_http-api.md\":\"C7Cb0r2J\",\"reference_instructions.md\":\"CV6Qq0UX\",\"reference_limits.md\":\"CW9PTdxr\",\"reference_memory.md\":\"CdoJISM-\",\"reference_playground.md\":\"DIUsRAcy\",\"reference_project-layout.md\":\"9DiKoE16\",\"reference_schedules.md\":\"Dd8_d0WG\",\"reference_sessions.md\":\"CoCyQLEz\",\"reference_skills.md\":\"SFRZDC41\",\"reference_subagents.md\":\"Dvpq2sUu\",\"reference_tools.md\":\"BhqW6neF\",\"templates_agentic-owners.md\":\"B6ZmKAzT\",\"templates_reviews.md\":\"dr9Xv_KM\",\"troubleshooting.md\":\"CsQTleto\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Agent SDK\",\"description\":\"Build and serve bots and agents from versioned Markdown and TypeScript.\",\"base\":\"/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"sdkVersion\":\"0.7.1\",\"nav\":[{\"text\":\"Quickstart\",\"link\":\"/quickstart\"},{\"text\":\"Guides\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Integrations\",\"link\":\"/guides/github\"},{\"text\":\"Templates\",\"link\":\"/templates/reviews\"},{\"text\":\"Reference\",\"link\":\"/reference/project-layout\"}],\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]},\"sidebar\":[{\"text\":\"Getting started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/\"},{\"text\":\"Changelog\",\"link\":\"/changelog\"},{\"text\":\"Build a PR reviewer\",\"link\":\"/quickstart\"}]},{\"text\":\"Integrations\",\"collapsed\":false,\"items\":[{\"text\":\"GitHub\",\"link\":\"/guides/github\"},{\"text\":\"Slack\",\"link\":\"/guides/slack\"},{\"text\":\"Microsoft Teams\",\"link\":\"/guides/teams\"},{\"text\":\"Webhooks\",\"link\":\"/guides/webhooks\"},{\"text\":\"Cursor Automations\",\"link\":\"/guides/convert-automation\"},{\"text\":\"OpenTelemetry\",\"link\":\"/guides/opentelemetry\"},{\"text\":\"GitLab\",\"link\":\"/guides/gitlab\"},{\"text\":\"Bitbucket\",\"link\":\"/guides/bitbucket\"},{\"text\":\"PagerDuty\",\"link\":\"/guides/pagerduty\"}]},{\"text\":\"Extensions\",\"collapsed\":false,\"items\":[{\"text\":\"Overview\",\"link\":\"/reference/extensions\"},{\"text\":\"Cloud agents\",\"link\":\"/guides/cloud-agents\"},{\"text\":\"Self-improvement\",\"link\":\"/guides/improve\"},{\"text\":\"Jev\",\"link\":\"/guides/jev\"}]},{\"text\":\"Guides\",\"collapsed\":false,\"items\":[{\"text\":\"MCP\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Peer agents\",\"link\":\"/guides/agent-to-agent\"},{\"text\":\"Deployment\",\"link\":\"/deployment\"},{\"text\":\"Workload identity (OIDC)\",\"link\":\"/guides/workload-identity\"},{\"text\":\"Early-alpha migration\",\"link\":\"/guides/migrate\"},{\"text\":\"Evals\",\"link\":\"/evals\"},{\"text\":\"Hillclimbing\",\"link\":\"/hillclimbing\"},{\"text\":\"Build with a coding agent\",\"link\":\"/building-with-agents\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"}]},{\"text\":\"Templates\",\"collapsed\":false,\"items\":[{\"text\":\"Review and triage\",\"link\":\"/templates/reviews\"},{\"text\":\"Agentic Approver\",\"link\":\"/templates/agentic-owners\"}]},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Project layout\",\"link\":\"/reference/project-layout\"},{\"text\":\"Agent config\",\"link\":\"/reference/agent-config\"},{\"text\":\"Instructions\",\"link\":\"/reference/instructions\"},{\"text\":\"Tools\",\"link\":\"/reference/tools\"},{\"text\":\"Skills\",\"link\":\"/reference/skills\"},{\"text\":\"MCP Connections\",\"link\":\"/reference/connections\"},{\"text\":\"Subagents\",\"link\":\"/reference/subagents\"},{\"text\":\"Channels\",\"link\":\"/reference/channels\"},{\"text\":\"Schedules & reminders\",\"link\":\"/reference/schedules\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Memory\",\"link\":\"/reference/memory\"},{\"text\":\"Evals\",\"link\":\"/reference/evals\"},{\"text\":\"Artifacts\",\"link\":\"/reference/artifacts\"},{\"text\":\"Sessions & streaming\",\"link\":\"/reference/sessions\"},{\"text\":\"Playground\",\"link\":\"/reference/playground\"},{\"text\":\"CLI\",\"link\":\"/reference/cli\"},{\"text\":\"HTTP API\",\"link\":\"/reference/http-api\"},{\"text\":\"Access\",\"link\":\"/reference/access\"},{\"text\":\"Limits\",\"link\":\"/reference/limits\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
|
150
150
|
|
|
151
151
|
</body>
|
|
152
152
|
</html>
|