@grok/agent-sdk 0.6.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/AGENTS.md +40 -0
- 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/github/forward.d.ts +5 -0
- package/dist/channels/github/forward.d.ts.map +1 -1
- package/dist/channels/github/forward.js +6 -3
- 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/channels/slack/api.d.ts +18 -0
- package/dist/channels/slack/api.d.ts.map +1 -1
- package/dist/channels/slack/api.js +31 -0
- package/dist/channels/slack/approvals.d.ts +19 -2
- package/dist/channels/slack/approvals.d.ts.map +1 -1
- package/dist/channels/slack/approvals.js +90 -19
- package/dist/channels/slack/attachments.d.ts +7 -2
- package/dist/channels/slack/attachments.d.ts.map +1 -1
- package/dist/channels/slack/attachments.js +318 -156
- package/dist/channels/slack/connect-card.d.ts +16 -0
- package/dist/channels/slack/connect-card.d.ts.map +1 -0
- package/dist/channels/slack/connect-card.js +31 -0
- package/dist/channels/slack/credentials.d.ts +10 -2
- package/dist/channels/slack/credentials.d.ts.map +1 -1
- package/dist/channels/slack/credentials.js +17 -15
- package/dist/channels/slack/defaults.d.ts.map +1 -1
- package/dist/channels/slack/defaults.js +18 -9
- package/dist/channels/slack/dispatch.d.ts +1 -1
- package/dist/channels/slack/dispatch.d.ts.map +1 -1
- package/dist/channels/slack/dispatch.js +19 -3
- package/dist/channels/slack/inbound.d.ts +8 -2
- package/dist/channels/slack/inbound.d.ts.map +1 -1
- package/dist/channels/slack/inbound.js +25 -4
- package/dist/channels/slack/index.d.ts +3 -2
- package/dist/channels/slack/index.d.ts.map +1 -1
- package/dist/channels/slack/index.js +3 -2
- package/dist/channels/slack/init.d.ts.map +1 -1
- package/dist/channels/slack/init.js +2 -1
- package/dist/channels/slack/mentions.d.ts +28 -0
- package/dist/channels/slack/mentions.d.ts.map +1 -0
- package/dist/channels/slack/mentions.js +178 -0
- package/dist/channels/slack/setup.js +1 -1
- package/dist/channels/slack/slack-channel.d.ts.map +1 -1
- package/dist/channels/slack/slack-channel.js +46 -3
- package/dist/channels/slack/stop.d.ts.map +1 -1
- package/dist/channels/slack/stop.js +7 -1
- package/dist/channels/slack/thread-context.d.ts +3 -0
- package/dist/channels/slack/thread-context.d.ts.map +1 -1
- package/dist/channels/slack/thread-context.js +17 -7
- package/dist/channels/slack/tool-approval-events.d.ts.map +1 -1
- package/dist/channels/slack/tool-approval-events.js +55 -2
- package/dist/channels/slack/types.d.ts +2 -0
- package/dist/channels/slack/types.d.ts.map +1 -1
- package/dist/channels/teams/activity.d.ts +33 -0
- package/dist/channels/teams/activity.d.ts.map +1 -0
- package/dist/channels/teams/activity.js +213 -0
- package/dist/channels/teams/auth.d.ts +25 -0
- package/dist/channels/teams/auth.d.ts.map +1 -0
- package/dist/channels/teams/auth.js +55 -0
- package/dist/channels/teams/bot-framework-auth.d.ts +33 -0
- package/dist/channels/teams/bot-framework-auth.d.ts.map +1 -0
- package/dist/channels/teams/bot-framework-auth.js +154 -0
- package/dist/channels/teams/cards.d.ts +23 -0
- package/dist/channels/teams/cards.d.ts.map +1 -0
- package/dist/channels/teams/cards.js +107 -0
- package/dist/channels/teams/connector.d.ts +48 -0
- package/dist/channels/teams/connector.d.ts.map +1 -0
- package/dist/channels/teams/connector.js +159 -0
- package/dist/channels/teams/credentials.d.ts +65 -0
- package/dist/channels/teams/credentials.d.ts.map +1 -0
- package/dist/channels/teams/credentials.js +84 -0
- package/dist/channels/teams/delivery.d.ts +14 -0
- package/dist/channels/teams/delivery.d.ts.map +1 -0
- package/dist/channels/teams/delivery.js +169 -0
- package/dist/channels/teams/dispatch.d.ts +45 -0
- package/dist/channels/teams/dispatch.d.ts.map +1 -0
- package/dist/channels/teams/dispatch.js +402 -0
- package/dist/channels/teams/engagement.d.ts +32 -0
- package/dist/channels/teams/engagement.d.ts.map +1 -0
- package/dist/channels/teams/engagement.js +120 -0
- package/dist/channels/teams/index.d.ts +21 -0
- package/dist/channels/teams/index.d.ts.map +1 -0
- package/dist/channels/teams/index.js +19 -0
- package/dist/channels/teams/marks.d.ts +19 -0
- package/dist/channels/teams/marks.d.ts.map +1 -0
- package/dist/channels/teams/marks.js +96 -0
- package/dist/channels/teams/senders.d.ts +27 -0
- package/dist/channels/teams/senders.d.ts.map +1 -0
- package/dist/channels/teams/senders.js +72 -0
- package/dist/channels/teams/teams-channel.d.ts +43 -0
- package/dist/channels/teams/teams-channel.d.ts.map +1 -0
- package/dist/channels/teams/teams-channel.js +278 -0
- package/dist/channels/teams/text.d.ts +7 -0
- package/dist/channels/teams/text.d.ts.map +1 -0
- package/dist/channels/teams/text.js +63 -0
- package/dist/channels/teams/types.d.ts +306 -0
- package/dist/channels/teams/types.d.ts.map +1 -0
- package/dist/channels/teams/types.js +1 -0
- package/dist/channels.d.ts +31 -0
- package/dist/channels.d.ts.map +1 -1
- package/dist/channels.js +37 -0
- package/dist/connections.d.ts +1 -1
- package/dist/connections.d.ts.map +1 -1
- package/dist/docs/404.html +3 -3
- package/dist/docs/assets/{app.lt-BYgI2.js → app.CpLKJnOA.js} +4 -4
- package/dist/docs/assets/changelog.md.DoOgjnPC.js +1 -0
- package/dist/docs/assets/{changelog.md.DVNB-ApU.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.v_dV4U2Q.js → VPLocalSearchBox.Cr1HJ_9k.js} +2 -2
- package/dist/docs/assets/chunks/{arc.5o92kOg5.js → arc.BjpgGAMM.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.C-oTwnNq.js → architectureDiagram-Q4EWVU46.CKdhNPPk.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.zJ-VNOib.js → baseUniq.iovoEQbg.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.B9ZJZuPd.js → blockDiagram-DXYQGD6D.BYQIeDre.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.BBMwSIaN.js → c4Diagram-AHTNJAMY.gbWi2q8N.js} +1 -1
- package/dist/docs/assets/chunks/channel.BP0n324b.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.D8qAJpDD.js → chunk-4BX2VUAB.1Mem4UG9.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.B8QR5cdE.js → chunk-4TB4RGXK.Dn3H-X_H.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.BsWxVuew.js → chunk-55IACEB6.BkpSDZwX.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.BeGygY_i.js → chunk-EDXVE4YY.BScqy1zP.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DdwgH-ZH.js → chunk-FMBD7UC4.Cp394LWf.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.B9zC_ALe.js → chunk-OYMX7WX6.BDv9LhoL.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.BIxJ0rcL.js → chunk-QZHKN3VN.CsgCcrKO.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.qiM_23_f.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.BKB971D5.js → cose-bilkent-S5V4N54A.Bs3ZS9PC.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CcILjJgp.js → dagre-KV5264BT.CgWi0tY2.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DkY9A0nu.js → diagram-5BDNPKRD.rn6qIo9N.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BbdzmjMt.js → diagram-G4DWMVQ6.ChhW8oww.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.Be0zy1cM.js → diagram-MMDJMWI5.C0wH5KSk.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.zOiEycLe.js → diagram-TYMM5635.CNEcrwA0.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.DUd_9HMF.js → erDiagram-SMLLAGMA.DCsnKO-7.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.2KPYoZBO.js → flowDiagram-DWJPFMVM.WCMkfvP0.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.DqE8_YpP.js → ganttDiagram-T4ZO3ILL.BUb1Sxfr.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.CO0Tk47h.js → gitGraphDiagram-UUTBAWPF._kORbCzm.js} +1 -1
- package/dist/docs/assets/chunks/{graph.CNe5KbNy.js → graph.PrGRm4KW.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.BBhJ1X1B.js → infoDiagram-42DDH7IO.BxhCjiQM.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.KSIw9w3I.js → ishikawaDiagram-UXIWVN3A.5ddTis2y.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.BN2Y5oUJ.js → journeyDiagram-VCZTEJTY.BUStU27-.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.2KFuDYn_.js → kanban-definition-6JOO6SKY.CJd1psl3.js} +1 -1
- package/dist/docs/assets/chunks/{layout.Demb_pzL.js → layout.DqvbZSML.js} +1 -1
- package/dist/docs/assets/chunks/{linear.kYKxzbbR.js → linear.DOmz-1UB.js} +1 -1
- package/dist/docs/assets/chunks/{min.DwmCN5dF.js → min.33k2v8dM.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.CGlz01QG.js → mindmap-definition-QFDTVHPH.iISCqCXC.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.n3qsq4nA.js → pieDiagram-DEJITSTG.BHvVgzmD.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.CGNJ1GSb.js → quadrantDiagram-34T5L4WZ.CY3w_-Cn.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.VhAzHDwQ.js → requirementDiagram-MS252O5E.CHXKQS1v.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.DmHA5pW-.js → sankeyDiagram-XADWPNL6.DTtRoGss.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23._TC1aKhg.js → sequenceDiagram-FGHM5R23.NnPcQ3eY.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B-kLjV3O.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.BaVlHHL-.js → theme.CwkiT-Fo.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CresbphV.js → timeline-definition-GMOUNBTQ._wIWkMU6.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.CegHD8Y4.js → vennDiagram-DHZGUBPP.NLVv7R6r.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.DjCmZrUO.js → wardley-RL74JXVD.DbsCXUZp.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.BJ7s1zdZ.js → wardleyDiagram-NUSXRM2D.Dp5uAVDl.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.IrEXlemI.js → xychartDiagram-5P7HB3ND.eOEBq4rX.js} +1 -1
- package/dist/docs/assets/{deployment.md.DJtuDVLh.js → deployment.md.CIRydNl3.js} +3 -3
- package/dist/docs/assets/{deployment.md.DJtuDVLh.lean.js → deployment.md.CIRydNl3.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.BdWqmUGb.js +14 -0
- package/dist/docs/assets/{guides_cloud-agents.md.CiXAW6on.lean.js → guides_cloud-agents.md.BdWqmUGb.lean.js} +1 -1
- package/dist/docs/assets/guides_teams.md.7Lz2sbqB.js +50 -0
- package/dist/docs/assets/guides_teams.md.7Lz2sbqB.lean.js +1 -0
- 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/assets/{reference_channels.md.CPWOpdsC.js → reference_channels.md.CRvqgU0n.js} +1 -1
- package/dist/docs/assets/{reference_cli.md.DHm6DmYk.js → reference_cli.md.NS6U5a-7.js} +14 -4
- package/dist/docs/assets/{reference_cli.md.DHm6DmYk.lean.js → reference_cli.md.NS6U5a-7.lean.js} +1 -1
- package/dist/docs/assets/{reference_limits.md.CbdtFr4T.js → reference_limits.md.CW9PTdxr.js} +3 -3
- package/dist/docs/assets/{reference_limits.md.CbdtFr4T.lean.js → reference_limits.md.CW9PTdxr.lean.js} +1 -1
- package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.js → reference_schedules.md.Dd8_d0WG.js} +3 -3
- package/dist/docs/assets/{reference_sessions.md.NXVQt9mP.js → reference_sessions.md.CoCyQLEz.js} +2 -2
- package/dist/docs/assets/{reference_sessions.md.NXVQt9mP.lean.js → reference_sessions.md.CoCyQLEz.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.DzCPNPkG.js → reference_skills.md.SFRZDC41.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.DzCPNPkG.lean.js → reference_skills.md.SFRZDC41.lean.js} +1 -1
- package/dist/docs/assets/{style.DK0YX1WL.css → style.B7zPxANR.css} +1 -1
- package/dist/docs/assets/troubleshooting.md.CsQTleto.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.DfKKvW1R.lean.js → troubleshooting.md.CsQTleto.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +37 -37
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +43 -0
- package/dist/docs/deployment.html +40 -40
- package/dist/docs/deployment.md +14 -0
- package/dist/docs/evals.html +37 -37
- package/dist/docs/guides/agent-to-agent.html +37 -37
- package/dist/docs/guides/bitbucket.html +37 -37
- package/dist/docs/guides/cloud-agents.html +43 -38
- package/dist/docs/guides/cloud-agents.md +47 -0
- package/dist/docs/guides/convert-automation.html +37 -37
- package/dist/docs/guides/github.html +37 -37
- package/dist/docs/guides/gitlab.html +37 -37
- package/dist/docs/guides/improve.html +37 -37
- package/dist/docs/guides/jev.html +37 -37
- package/dist/docs/guides/mcp-oauth.html +37 -37
- package/dist/docs/guides/migrate.html +37 -37
- package/dist/docs/guides/opentelemetry.html +37 -37
- package/dist/docs/guides/pagerduty.html +37 -37
- package/dist/docs/guides/slack.html +37 -37
- package/dist/docs/guides/teams.html +109 -0
- package/dist/docs/guides/teams.md +384 -0
- package/dist/docs/guides/webhooks.html +37 -37
- 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 +37 -37
- package/dist/docs/index.html +37 -37
- package/dist/docs/llms-full.txt +881 -5
- package/dist/docs/llms.txt +2 -0
- package/dist/docs/quickstart.html +37 -37
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/agent-config.html +39 -39
- package/dist/docs/reference/agent-config.md +1 -1
- package/dist/docs/reference/artifacts.html +37 -37
- package/dist/docs/reference/channels.html +38 -38
- package/dist/docs/reference/channels.md +1 -0
- package/dist/docs/reference/cli.html +50 -40
- package/dist/docs/reference/cli.md +116 -0
- package/dist/docs/reference/connections.html +37 -37
- package/dist/docs/reference/evals.html +37 -37
- package/dist/docs/reference/extensions.html +37 -37
- package/dist/docs/reference/hooks.html +37 -37
- package/dist/docs/reference/http-api.html +37 -37
- package/dist/docs/reference/instructions.html +37 -37
- package/dist/docs/reference/limits.html +39 -39
- package/dist/docs/reference/limits.md +4 -4
- package/dist/docs/reference/memory.html +37 -37
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/project-layout.html +37 -37
- package/dist/docs/reference/schedules.html +40 -40
- package/dist/docs/reference/sessions.html +38 -38
- package/dist/docs/reference/sessions.md +13 -0
- package/dist/docs/reference/skills.html +40 -40
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/tools.html +37 -37
- package/dist/docs/templates/agentic-owners.html +37 -37
- package/dist/docs/templates/reviews.html +37 -37
- package/dist/docs/troubleshooting.html +38 -38
- package/dist/docs/troubleshooting.md +21 -0
- package/dist/evals/run-facts.d.ts.map +1 -1
- package/dist/evals/run-facts.js +4 -0
- package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.d.ts +12 -0
- package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.d.ts.map +1 -0
- package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.js +42 -0
- package/dist/extensions/cursor-cloud-agents/extension.d.ts +10 -7
- package/dist/extensions/cursor-cloud-agents/extension.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/extension.js +3 -2
- package/dist/extensions/cursor-cloud-agents/lib/agent-id.d.ts +5 -0
- package/dist/extensions/cursor-cloud-agents/lib/agent-id.d.ts.map +1 -0
- package/dist/extensions/cursor-cloud-agents/lib/agent-id.js +10 -0
- package/dist/extensions/cursor-cloud-agents/lib/backend.d.ts +57 -3
- package/dist/extensions/cursor-cloud-agents/lib/backend.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/lib/backend.js +150 -35
- package/dist/extensions/cursor-cloud-agents/lib/fleet.d.ts +32 -4
- package/dist/extensions/cursor-cloud-agents/lib/fleet.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/lib/fleet.js +93 -7
- package/dist/extensions/cursor-cloud-agents/lib/launch-agent.d.ts +24 -7
- package/dist/extensions/cursor-cloud-agents/lib/launch-agent.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/lib/launch-agent.js +158 -25
- package/dist/extensions/cursor-cloud-agents/lib/stop-signal.d.ts +18 -0
- package/dist/extensions/cursor-cloud-agents/lib/stop-signal.d.ts.map +1 -0
- package/dist/extensions/cursor-cloud-agents/lib/stop-signal.js +27 -0
- package/dist/extensions/cursor-cloud-agents/lib/transcript.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/lib/transcript.js +2 -3
- package/dist/extensions/cursor-cloud-agents/lib/watch.d.ts +26 -12
- package/dist/extensions/cursor-cloud-agents/lib/watch.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/lib/watch.js +115 -46
- package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.d.ts +16 -5
- package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.d.ts.map +1 -1
- package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.js +76 -20
- package/dist/extensions/cursor-cloud-agents/skills/handoff.md +2 -2
- package/dist/extensions/cursor-cloud-agents/tools/get.js +2 -2
- package/dist/extensions/cursor-cloud-agents/tools/launch.js +1 -1
- package/dist/extensions.d.ts.map +1 -1
- package/dist/extensions.js +18 -3
- package/dist/files-backends/agent-store-presigned-url.js +5 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/internal/approval-gate.d.ts +6 -1
- package/dist/internal/approval-gate.d.ts.map +1 -1
- package/dist/internal/approval-gate.js +13 -2
- package/dist/internal/authored-loaders.js +1 -1
- package/dist/internal/channel-architecture.d.ts.map +1 -1
- package/dist/internal/channel-architecture.js +3 -1
- package/dist/internal/cli/commands/channels.d.ts +9 -3
- package/dist/internal/cli/commands/channels.d.ts.map +1 -1
- package/dist/internal/cli/commands/channels.js +193 -4
- package/dist/internal/cli/commands/index.d.ts.map +1 -1
- package/dist/internal/cli/commands/index.js +6 -1
- package/dist/internal/cli/commands/serve.d.ts.map +1 -1
- package/dist/internal/cli/commands/serve.js +25 -5
- package/dist/internal/cli/dispatch.d.ts.map +1 -1
- package/dist/internal/cli/dispatch.js +22 -8
- package/dist/internal/cli/flags.d.ts +14 -0
- package/dist/internal/cli/flags.d.ts.map +1 -1
- package/dist/internal/cli/flags.js +14 -0
- package/dist/internal/cli/help.d.ts.map +1 -1
- package/dist/internal/cli/help.js +3 -1
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +6 -3
- package/dist/internal/cli-cursor.js +2 -2
- package/dist/internal/cli-deploy.d.ts +1 -0
- package/dist/internal/cli-deploy.d.ts.map +1 -1
- package/dist/internal/cli-deploy.js +19 -1
- package/dist/internal/cli-mcp.d.ts.map +1 -1
- package/dist/internal/cli-mcp.js +5 -3
- package/dist/internal/cli-teams-doctor.d.ts +39 -0
- package/dist/internal/cli-teams-doctor.d.ts.map +1 -0
- package/dist/internal/cli-teams-doctor.js +508 -0
- package/dist/internal/cli-teams-forward.d.ts +84 -0
- package/dist/internal/cli-teams-forward.d.ts.map +1 -0
- package/dist/internal/cli-teams-forward.js +386 -0
- package/dist/internal/cli-teams-package.d.ts +26 -0
- package/dist/internal/cli-teams-package.d.ts.map +1 -0
- package/dist/internal/cli-teams-package.js +123 -0
- package/dist/internal/cli-teams.d.ts +15 -0
- package/dist/internal/cli-teams.d.ts.map +1 -0
- package/dist/internal/cli-teams.js +253 -0
- package/dist/internal/connect-click.d.ts +12 -0
- package/dist/internal/connect-click.d.ts.map +1 -0
- package/dist/internal/connect-click.js +22 -0
- package/dist/internal/continuation-channel.d.ts +5 -1
- package/dist/internal/continuation-channel.d.ts.map +1 -1
- package/dist/internal/continuation-channel.js +34 -0
- package/dist/internal/continuation-identity.d.ts +7 -4
- package/dist/internal/continuation-identity.d.ts.map +1 -1
- package/dist/internal/continuation-identity.js +66 -1
- package/dist/internal/convert-automation/convert-workflow.js +2 -2
- package/dist/internal/credential-env-names.d.ts +36 -0
- package/dist/internal/credential-env-names.d.ts.map +1 -0
- package/dist/internal/credential-env-names.js +68 -0
- package/dist/internal/cursor/account-mcp.d.ts +67 -9
- package/dist/internal/cursor/account-mcp.d.ts.map +1 -1
- package/dist/internal/cursor/account-mcp.js +206 -25
- package/dist/internal/cursor/backend-client.d.ts +10 -1
- package/dist/internal/cursor/backend-client.d.ts.map +1 -1
- package/dist/internal/cursor/backend-client.js +19 -7
- package/dist/internal/cursor/cloud-agent-identity.d.ts +81 -0
- package/dist/internal/cursor/cloud-agent-identity.d.ts.map +1 -0
- package/dist/internal/cursor/cloud-agent-identity.js +224 -0
- package/dist/internal/cursor/credentials.d.ts.map +1 -1
- package/dist/internal/cursor/credentials.js +3 -1
- package/dist/internal/cursor-account-mcp-auth.d.ts +8 -1
- package/dist/internal/cursor-account-mcp-auth.d.ts.map +1 -1
- package/dist/internal/cursor-account-mcp-auth.js +22 -6
- package/dist/internal/deploy-client.d.ts.map +1 -1
- package/dist/internal/deploy-client.js +34 -2
- package/dist/internal/deploy-manifest.d.ts +51 -3
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +96 -7
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +6 -1
- 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 +71 -1
- package/dist/internal/discovery/extensions.d.ts.map +1 -1
- package/dist/internal/discovery/extensions.js +2 -0
- package/dist/internal/discovery/info.d.ts.map +1 -1
- package/dist/internal/discovery/info.js +4 -0
- package/dist/internal/env-file.d.ts +1 -0
- package/dist/internal/env-file.d.ts.map +1 -1
- package/dist/internal/env-file.js +18 -17
- package/dist/internal/env-prefix.d.ts +11 -0
- package/dist/internal/env-prefix.d.ts.map +1 -0
- package/dist/internal/env-prefix.js +23 -0
- package/dist/internal/event-id-dedupe.d.ts +12 -0
- package/dist/internal/event-id-dedupe.d.ts.map +1 -0
- package/dist/{channels/slack → internal}/event-id-dedupe.js +7 -4
- package/dist/internal/event-mapper.d.ts +7 -2
- package/dist/internal/event-mapper.d.ts.map +1 -1
- package/dist/internal/event-mapper.js +7 -0
- package/dist/internal/expected-delivery-failure.d.ts.map +1 -1
- package/dist/internal/expected-delivery-failure.js +3 -0
- package/dist/internal/extension-namespace.d.ts +9 -0
- package/dist/internal/extension-namespace.d.ts.map +1 -0
- package/dist/internal/extension-namespace.js +14 -0
- package/dist/internal/guid.d.ts +2 -0
- package/dist/internal/guid.d.ts.map +1 -0
- package/dist/internal/guid.js +4 -0
- package/dist/internal/host-kv-cas.d.ts +13 -0
- package/dist/internal/host-kv-cas.d.ts.map +1 -0
- package/dist/internal/host-kv-cas.js +26 -0
- package/dist/internal/host-kv.d.ts +4 -1
- package/dist/internal/host-kv.d.ts.map +1 -1
- package/dist/internal/host-kv.js +15 -2
- package/dist/internal/hosted-catch-protocol.d.ts +5 -0
- package/dist/internal/hosted-catch-protocol.d.ts.map +1 -1
- package/dist/internal/hosted-catch-protocol.js +5 -0
- package/dist/internal/hosted-catch.d.ts +2 -0
- package/dist/internal/hosted-catch.d.ts.map +1 -1
- package/dist/internal/hosted-catch.js +6 -1
- package/dist/internal/hosted-delivery-protocol.d.ts +4 -0
- package/dist/internal/hosted-delivery-protocol.d.ts.map +1 -1
- package/dist/internal/hosted-delivery-protocol.js +73 -3
- package/dist/internal/hosted-delivery.d.ts +9 -3
- package/dist/internal/hosted-delivery.d.ts.map +1 -1
- package/dist/internal/hosted-delivery.js +14 -3
- package/dist/internal/hosted-session-fixture.js +1 -1
- package/dist/internal/hosting.d.ts +5 -0
- package/dist/internal/hosting.d.ts.map +1 -1
- package/dist/internal/hosting.js +7 -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/install-cursor-skills.d.ts +6 -7
- package/dist/internal/install-cursor-skills.d.ts.map +1 -1
- package/dist/internal/install-cursor-skills.js +15 -9
- package/dist/internal/interview/agent-questions.d.ts +1 -1
- package/dist/internal/interview/agent-questions.d.ts.map +1 -1
- package/dist/internal/interview/agent-questions.js +4 -3
- package/dist/internal/local-control-plane.d.ts.map +1 -1
- package/dist/internal/local-control-plane.js +24 -0
- package/dist/internal/mcp-allowlist-in-use.d.ts +23 -0
- package/dist/internal/mcp-allowlist-in-use.d.ts.map +1 -0
- package/dist/internal/mcp-allowlist-in-use.js +93 -0
- package/dist/internal/mcp-endpoint.d.ts.map +1 -1
- package/dist/internal/mcp-endpoint.js +8 -10
- package/dist/internal/mcp-host.d.ts +19 -1
- package/dist/internal/mcp-host.d.ts.map +1 -1
- package/dist/internal/mcp-host.js +67 -3
- package/dist/internal/mcp-oauth.d.ts.map +1 -1
- package/dist/internal/mcp-oauth.js +5 -7
- package/dist/internal/oidcAudiences.d.ts +22 -0
- package/dist/internal/oidcAudiences.d.ts.map +1 -0
- package/dist/internal/oidcAudiences.js +35 -0
- package/dist/internal/otel/collector.d.ts.map +1 -1
- package/dist/internal/otel/collector.js +2 -0
- package/dist/internal/platform-timers.d.ts +2 -0
- package/dist/internal/platform-timers.d.ts.map +1 -1
- package/dist/internal/platform-timers.js +14 -0
- package/dist/internal/private-file.d.ts +32 -1
- package/dist/internal/private-file.d.ts.map +1 -1
- package/dist/internal/private-file.js +209 -7
- package/dist/internal/redact-values.d.ts +3 -0
- package/dist/internal/redact-values.d.ts.map +1 -0
- package/dist/internal/redact-values.js +19 -0
- package/dist/internal/reminder-control-plane-protocol.d.ts +7 -1
- package/dist/internal/reminder-control-plane-protocol.d.ts.map +1 -1
- package/dist/internal/reminder-followup-error.d.ts +23 -0
- package/dist/internal/reminder-followup-error.d.ts.map +1 -0
- package/dist/internal/reminder-followup-error.js +12 -0
- package/dist/internal/reminder-runner.d.ts +15 -1
- package/dist/internal/reminder-runner.d.ts.map +1 -1
- package/dist/internal/reminder-runner.js +95 -21
- package/dist/internal/resolved-connections.d.ts.map +1 -1
- package/dist/internal/resolved-connections.js +23 -3
- package/dist/internal/run-client.js +2 -1
- package/dist/internal/run-program.d.ts +31 -0
- package/dist/internal/run-program.d.ts.map +1 -0
- package/dist/internal/run-program.js +150 -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/sdk-runner.d.ts +28 -2
- package/dist/internal/sdk-runner.d.ts.map +1 -1
- package/dist/internal/sdk-runner.js +298 -38
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +53 -8
- package/dist/internal/session-credential.d.ts +14 -0
- package/dist/internal/session-credential.d.ts.map +1 -0
- package/dist/internal/session-credential.js +25 -0
- package/dist/internal/session-engine.d.ts +140 -6
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +583 -93
- package/dist/internal/storage-coordinator.d.ts +3 -1
- package/dist/internal/storage-coordinator.d.ts.map +1 -1
- package/dist/internal/storage-coordinator.js +13 -0
- package/dist/internal/storage-roles.d.ts +9 -1
- package/dist/internal/storage-roles.d.ts.map +1 -1
- package/dist/internal/teams-channel-profile.d.ts +41 -0
- package/dist/internal/teams-channel-profile.d.ts.map +1 -0
- package/dist/internal/teams-channel-profile.js +91 -0
- package/dist/internal/teams-devtunnel.d.ts +55 -0
- package/dist/internal/teams-devtunnel.d.ts.map +1 -0
- package/dist/internal/teams-devtunnel.js +205 -0
- package/dist/internal/teams-tunnel-proxy.d.ts +17 -0
- package/dist/internal/teams-tunnel-proxy.d.ts.map +1 -0
- package/dist/internal/teams-tunnel-proxy.js +100 -0
- package/dist/internal/testing/conversation-identity-vectors.d.ts +7 -1
- package/dist/internal/testing/conversation-identity-vectors.d.ts.map +1 -1
- package/dist/internal/testing/conversation-identity-vectors.js +67 -0
- package/dist/internal/testing/hosted-http.d.ts +15 -0
- package/dist/internal/testing/hosted-http.d.ts.map +1 -0
- package/dist/internal/testing/hosted-http.js +86 -0
- package/dist/internal/testing/teams-activity-fixtures.d.ts +28 -0
- package/dist/internal/testing/teams-activity-fixtures.d.ts.map +1 -0
- package/dist/internal/testing/teams-activity-fixtures.js +236 -0
- package/dist/internal/testing/teams-doctor-fixtures.d.ts +76 -0
- package/dist/internal/testing/teams-doctor-fixtures.d.ts.map +1 -0
- package/dist/internal/testing/teams-doctor-fixtures.js +216 -0
- package/dist/internal/tunnel-process.d.ts +29 -0
- package/dist/internal/tunnel-process.d.ts.map +1 -0
- package/dist/internal/tunnel-process.js +105 -0
- package/dist/internal/turn-context.d.ts +28 -0
- package/dist/internal/turn-context.d.ts.map +1 -0
- package/dist/internal/turn-context.js +1 -0
- package/dist/oidc-token.d.ts +131 -0
- package/dist/oidc-token.d.ts.map +1 -0
- package/dist/oidc-token.js +221 -0
- 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/dist/teams-app-package.d.ts +78 -0
- package/dist/teams-app-package.d.ts.map +1 -0
- package/dist/teams-app-package.js +204 -0
- package/dist/tools.d.ts +1 -1
- package/dist/tools.d.ts.map +1 -1
- package/dist/types.d.ts +271 -2
- package/dist/types.d.ts.map +1 -1
- package/docs/changelog.md +43 -0
- package/docs/deployment.md +14 -0
- package/docs/guides/cloud-agents.md +47 -0
- package/docs/guides/teams.md +389 -0
- package/docs/guides/workload-identity.md +232 -0
- package/docs/reference/agent-config.md +1 -1
- package/docs/reference/channels.md +1 -0
- package/docs/reference/cli.md +116 -0
- package/docs/reference/limits.md +4 -4
- package/docs/reference/sessions.md +13 -0
- package/docs/troubleshooting.md +21 -0
- package/package.json +23 -46
- package/skills/create-agent/SKILL.md +17 -4
- package/skills/debug/SKILL.md +1 -0
- package/skills/deploy/SKILL.md +1 -1
- package/skills/framework-map/SKILL.md +1 -0
- package/skills/setup-teams/SKILL.md +141 -0
- package/templates/agentic-owners/bot/lib/owners/parse.ts +1 -0
- package/dist/channels/slack/event-id-dedupe.d.ts +0 -10
- package/dist/channels/slack/event-id-dedupe.d.ts.map +0 -1
- package/dist/docs/assets/changelog.md.DVNB-ApU.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.DdlR-9Oe.js +0 -1
- package/dist/docs/assets/chunks/channel.CdyTxaXV.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CeUcN6TW.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CeUcN6TW.js +0 -1
- package/dist/docs/assets/chunks/clone.DpIwUbur.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.HtBkUH4J.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +0 -9
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +0 -3
- package/dist/playground/assets/index-CnFd5R1_.js +0 -62
- package/dist/playground/assets/index-DNzRv6G8.css +0 -1
- /package/dist/docs/assets/{reference_channels.md.CPWOpdsC.lean.js → reference_channels.md.CRvqgU0n.lean.js} +0 -0
- /package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +0 -0
|
@@ -6,54 +6,54 @@
|
|
|
6
6
|
<title>CLI | Agent SDK</title>
|
|
7
7
|
<meta name="description" content="Look up Agent SDK commands, targets, flags, outputs, and exit status.">
|
|
8
8
|
<meta name="generator" content="VitePress v1.6.4">
|
|
9
|
-
<link rel="preload stylesheet" href="/docs/assets/style.
|
|
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
|
-
<link rel="modulepreload" href="/docs/assets/reference_cli.md.
|
|
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>
|
|
51
51
|
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
|
52
52
|
<link rel="alternate" type="text/plain" href="/docs/llms.txt">
|
|
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-738a160a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-a98c2453></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-a98c2453>Skip to content</a><!--]--><!----><header class="VPNav" data-v-738a160a data-v-76ad4059><div class="VPNavBar" data-v-76ad4059 data-v-6fc2afcb><div class="wrapper" data-v-6fc2afcb><div class="container" data-v-6fc2afcb><div class="title" data-v-6fc2afcb><div class="VPNavBarTitle has-sidebar" data-v-6fc2afcb data-v-9e6caa3f><a class="title" href="/docs/" data-v-9e6caa3f><!--[--><!--]--><!----><span data-v-9e6caa3f>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.6.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.6.0</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-6fc2afcb><div class="content-body" data-v-6fc2afcb><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6fc2afcb><!--[--><!----><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-6fc2afcb data-v-78f72f99><span id="main-nav-aria-label" class="visually-hidden" data-v-78f72f99> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/quickstart.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6fc2afcb data-v-bf7c3d0f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bf7c3d0f data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-6fc2afcb data-v-799c9281 data-v-070c9767><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-070c9767><span class="vpi-more-horizontal icon" data-v-070c9767></span></button><div class="menu" data-v-070c9767><div class="VPMenu" data-v-070c9767 data-v-c05d27ee><!----><!--[--><!--[--><!----><div class="group" data-v-799c9281><div class="item appearance" data-v-799c9281><p class="label" data-v-799c9281>Appearance</p><div class="appearance-action" data-v-799c9281><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-799c9281 data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></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-6fc2afcb data-v-2caaf84e><span class="container" data-v-2caaf84e><span class="top" data-v-2caaf84e></span><span class="middle" data-v-2caaf84e></span><span class="bottom" data-v-2caaf84e></span></span></button></div></div></div></div><div class="divider" data-v-6fc2afcb><div class="divider-line" data-v-6fc2afcb></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-738a160a data-v-e0cbfd80><div class="container" data-v-e0cbfd80><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-e0cbfd80><span class="vpi-align-left menu-icon" data-v-e0cbfd80></span><span class="menu-text" data-v-e0cbfd80>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-e0cbfd80 data-v-36e0b8e9><button data-v-36e0b8e9>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-738a160a data-v-2859715e><div class="curtain" data-v-2859715e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-2859715e><span class="visually-hidden" id="sidebar-aria-label" data-v-2859715e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Getting started</h2><!----></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/changelog.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/deployment.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible has-active" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-738a160a data-v-9f462cdf><div class="VPDoc has-sidebar has-aside" data-v-9f462cdf data-v-995f90b4><!--[--><!--]--><div class="container" data-v-995f90b4><div class="aside" data-v-995f90b4><div class="aside-curtain" data-v-995f90b4></div><div class="aside-container" data-v-995f90b4><div class="aside-content" data-v-995f90b4><div class="VPDocAside" data-v-995f90b4 data-v-10889960><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-10889960 data-v-afb61a88><div class="content" data-v-afb61a88><div class="outline-marker" data-v-afb61a88></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-afb61a88>On this page</div><ul class="VPDocOutlineItem root" data-v-afb61a88 data-v-0587367d><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-10889960></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-995f90b4><div class="content-container" data-v-995f90b4><!--[--><!--]--><main class="main" data-v-995f90b4><div style="position:relative;" class="vp-doc _docs_reference_cli" data-v-995f90b4><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="#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>
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
<span class="line"><span> [--peers-url <url>]</span></span>
|
|
64
64
|
<span class="line"><span> [--no-schedules] [--no-playground] [--no-docs]</span></span>
|
|
65
65
|
<span class="line"><span> [--cursor-events --repo <owner/name>]...</span></span></code></pre></div><p><code>serve</code> listens on <code>127.0.0.1:3000</code>, or the next free port when that one is taken. <code>--mode multi</code>, the default, mounts each project at <code>/<slug>/v1/*</code>, and <code>--mode single</code> mounts one project at <code>/v1/*</code>. <code>--dev</code> turns off schedule and reminder firing and admits unsigned loopback GitHub deliveries.</p><p><code>--bearer-token</code> requires a token on routes that don't declare their own authentication. <code>--allow-anonymous</code> admits every caller as one principal, so use it only behind a trusted network boundary. The slugs <code>v1</code>, <code>playground</code>, and <code>docs</code> are reserved.</p><h3 id="dev" tabindex="-1">Develop locally <a class="header-anchor" href="#dev" aria-label="Permalink to "Develop locally {#dev}""></a></h3><p><code>dev</code> is <code>serve --dev</code> with an optional project path:</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 dev</span></span>
|
|
66
|
-
<span class="line"><span>agent-sdk dev ./agent-sdk-pr-reviewer --port 3000</span></span></code></pre></div><p>It accepts every <code>serve</code> option. Don't combine the path with a different <code>--dir</code>.</p><h3 id="docs" tabindex="-1">Serve the docs <a class="header-anchor" href="#docs" aria-label="Permalink to "Serve the docs {#docs}""></a></h3><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 docs [--port <n>] [--host 127.0.0.1] [--print]</span></span></code></pre></div><p><code>docs</code> serves the bundled documentation on a loopback port until you press Ctrl-C. <code>--print</code> prints the URL without opening a browser.</p><h2 id="sessions-and-turns" tabindex="-1">Sessions and turns <a class="header-anchor" href="#sessions-and-turns" aria-label="Permalink to "Sessions and turns""></a></h2><h3 id="chat" tabindex="-1">Chat with an agent <a class="header-anchor" href="#chat" aria-label="Permalink to "Chat with an agent {#chat}""></a></h3><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 chat [--url <baseUrl>] [--message <text>]</span></span>
|
|
66
|
+
<span class="line"><span>agent-sdk dev ./agent-sdk-pr-reviewer --port 3000</span></span></code></pre></div><p>It accepts every <code>serve</code> option. Don't combine the path with a different <code>--dir</code>.</p><p>When an agent has a Microsoft Teams channel, <code>dev</code> also opens a cloudflared quick tunnel and prints that channel's messaging endpoint. Pass <code>--tunnel devtunnel</code> for an endpoint that stays the same across restarts, and <code>--tunnel-id <id></code> to pick the dev tunnel. See <a href="#teams">Configure Microsoft Teams</a>.</p><h3 id="docs" tabindex="-1">Serve the docs <a class="header-anchor" href="#docs" aria-label="Permalink to "Serve the docs {#docs}""></a></h3><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 docs [--port <n>] [--host 127.0.0.1] [--print]</span></span></code></pre></div><p><code>docs</code> serves the bundled documentation on a loopback port until you press Ctrl-C. <code>--print</code> prints the URL without opening a browser.</p><h2 id="sessions-and-turns" tabindex="-1">Sessions and turns <a class="header-anchor" href="#sessions-and-turns" aria-label="Permalink to "Sessions and turns""></a></h2><h3 id="chat" tabindex="-1">Chat with an agent <a class="header-anchor" href="#chat" aria-label="Permalink to "Chat with an agent {#chat}""></a></h3><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 chat [--url <baseUrl>] [--message <text>]</span></span>
|
|
67
67
|
<span class="line"><span> [--session <id> | --resume] [--continuation-token <token>]</span></span>
|
|
68
68
|
<span class="line"><span> [--slug <slug>] [--json] [--text] [--no-color]</span></span></code></pre></div><p>On a TTY, <code>chat</code> opens a REPL and sends any <code>--message</code> first. Without a TTY, it sends <code>--message</code> as one turn, or reads newline-delimited messages until EOF. <code>--session <id></code> reattaches a stored session, and <code>--resume</code> picks the most recent one.</p><h3 id="run" tabindex="-1">Run turns <a class="header-anchor" href="#run" aria-label="Permalink to "Run turns {#run}""></a></h3><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 run [--dir <path>] [--message <text>]...</span></span>
|
|
69
69
|
<span class="line"><span> [--messages-file <path>] [--url <baseUrl>]</span></span>
|
|
@@ -121,7 +121,17 @@
|
|
|
121
121
|
<span class="line"><span>agent-sdk slack manifest [--dir <path>] [--name <name>]</span></span>
|
|
122
122
|
<span class="line"><span> [--env dev|prod|both] [--channel-posts] [--dry-run]</span></span>
|
|
123
123
|
<span class="line"><span>agent-sdk slack doctor [--dir <path>]</span></span>
|
|
124
|
-
<span class="line"><span> [--prefix <prefix> | --no-prefix] [--channel <id>]... [--json]</span></span></code></pre></div><p><code>slack create</code> opens the <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a> wizard, writes the token pair to <code>.env.local</code>, and runs <code>doctor</code>, which checks both tokens and Socket Mode. It makes the development app unless you pass <code>--env prod</code>. The token prefix defaults to the project directory name in upper snake case. <code>--channel-posts</code> adds the message events that <code>engagement.channelPosts</code> needs. See <a href="./../guides/slack.html">Slack</a> for manual setup.</p><h3 id="
|
|
124
|
+
<span class="line"><span> [--prefix <prefix> | --no-prefix] [--channel <id>]... [--json]</span></span></code></pre></div><p><code>slack create</code> opens the <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a> wizard, writes the token pair to <code>.env.local</code>, and runs <code>doctor</code>, which checks both tokens and Socket Mode. It makes the development app unless you pass <code>--env prod</code>. The token prefix defaults to the project directory name in upper snake case. <code>--channel-posts</code> adds the message events that <code>engagement.channelPosts</code> needs. See <a href="./../guides/slack.html">Slack</a> for manual setup.</p><h3 id="teams" tabindex="-1">Configure Microsoft Teams <a class="header-anchor" href="#teams" aria-label="Permalink to "Configure Microsoft Teams {#teams}""></a></h3><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 channels teams setup</span></span>
|
|
125
|
+
<span class="line"><span>agent-sdk channels teams init --app-id <guid> --tenant-id <guid> [--dir <path>]</span></span>
|
|
126
|
+
<span class="line"><span> [--prefix <prefix>] [--dry-run] [--json]</span></span>
|
|
127
|
+
<span class="line"><span>agent-sdk channels teams doctor [--dir <path>] [--slug <slug>] [--channel <id>]</span></span>
|
|
128
|
+
<span class="line"><span> [--endpoint <url>] [--json]</span></span>
|
|
129
|
+
<span class="line"><span>agent-sdk channels teams package [--dir <path>] [--slug <slug>] [--channel <id>]</span></span>
|
|
130
|
+
<span class="line"><span> [--name <name>] [--icon <png>] [--app-version <x.y.z>] [--endpoint <url>]</span></span>
|
|
131
|
+
<span class="line"><span> [--out <file>] [--dry-run] [--json]</span></span>
|
|
132
|
+
<span class="line"><span>agent-sdk channels teams forward [--dir <path>] [--slug <slug>] [--channel <id>]</span></span>
|
|
133
|
+
<span class="line"><span> [--host <host>] [--port <n>] [--tunnel cloudflared|devtunnel]</span></span>
|
|
134
|
+
<span class="line"><span> [--tunnel-id <id>] [--json]</span></span></code></pre></div><table tabindex="0"><thead><tr><th>Subcommand</th><th>Contract</th></tr></thead><tbody><tr><td><code>setup</code></td><td>Print the Azure Bot setup steps without changing files.</td></tr><tr><td><code>init</code></td><td>Read the bot's client secret from a hidden prompt or stdin, never from an argument. Write <code>bot/channels/teams.ts</code> when it's missing, and write the app id, secret, and tenant id to <code>.env.local</code>. A second <code>init</code> keeps the channel file and replaces the secret.</td></tr><tr><td><code>doctor</code></td><td>Run the checks below and exit <code>1</code> when one fails. A check it can't run is skipped and says why.</td></tr><tr><td><code>package</code></td><td>Write the Teams app package: <code>manifest.json</code>, a 192 by 192 color icon, and a 32 by 32 outline icon. By default it writes <code><slug>-teams-app.zip</code> in the agent folder and adds <code>*-teams-app.zip</code> to <code>.gitignore</code>. <code>--out <file></code> writes it to that path instead. Upload it in Teams under <strong>Apps</strong> > <strong>Manage your apps</strong> > <strong>Upload an app</strong>.</td></tr><tr><td><code>forward</code></td><td>Open a tunnel to a running <code>agent-sdk serve</code> and print the messaging endpoint of each Teams channel. It runs until you stop it.</td></tr></tbody></table><p><code>agent-sdk dev</code> opens the same tunnel by itself. The endpoint is the tunnel origin plus <code>/<slug>/v1/channels/<channel></code>, such as <code>https://<random>.trycloudflare.com/helm/v1/channels/teams</code>. Set it as the Azure Bot's messaging endpoint. The tunnel forwards only <code>POST</code> requests to the Teams messaging paths, so the rest of the agent's API stays local. Every other request on the tunnel host gets a <code>404</code>.</p><p><code>--tunnel</code> picks the tunnel for <code>dev</code> and <code>channels teams forward</code>:</p><table tabindex="0"><thead><tr><th><code>--tunnel</code></th><th>Needs</th><th>Endpoint</th></tr></thead><tbody><tr><td><code>cloudflared</code> (default)</td><td><code>cloudflared</code> on <code>PATH</code>. No account.</td><td>A new <code>trycloudflare.com</code> URL on every start. Set it on the bot again after each restart.</td></tr><tr><td><code>devtunnel</code></td><td>The <code>devtunnel</code> CLI on <code>PATH</code>, logged in with <code>devtunnel user login</code>.</td><td>The same <code>devtunnels.ms</code> URL on every start. Set it on the bot once.</td></tr></tbody></table><p>With <code>devtunnel</code>, the first start creates a dev tunnel that allows anonymous access, adds port <code>3978</code>, and saves the tunnel id as <code>TEAMS_DEVTUNNEL_ID</code> in <code>.env.local</code>. Later starts reuse that tunnel. <code>--tunnel-id <id></code> picks the id. Microsoft deletes a dev tunnel after 30 days without use, and the next start creates it again under the same id. Port <code>3978</code> belongs to the tunnel, so <code>--port 3978</code> with <code>--tunnel devtunnel</code> stops with a usage error. Run the agent on another port. <code>devtunnel host</code> publishes every port on the tunnel, so the tunnel stops when it reports a port other than <code>3978</code>. Remove that port with <code>devtunnel port delete <id> -p <port></code>, or pass another <code>--tunnel-id</code>.</p><p>The package manifest uses Teams manifest version 1.25. It names the bot by its app id and lists the scopes the channel answers in: mentions add <code>team</code> and <code>groupChat</code>, and personal chats add <code>personal</code>. With <code>engagement.channelPosts</code>, it also asks for <code>ChannelMessage.Read.Group</code> consent. <code>--endpoint</code> adds the messaging endpoint's host to <code>validDomains</code>. <code>--app-version</code> sets the app version. It defaults to <code>1.<YYYYMMDD>.<second of the day></code> in UTC, so each new zip is higher than the last, and Teams and the Teams admin center accept it as an update. Teams refuses an update whose version is not higher than the installed one. After you set <code>--app-version 2.0.0</code>, a later default <code>1.x</code> version is lower, so keep passing a higher <code>--app-version</code>. The default's middle part has 8 digits, which is fine for a bot-only app. An app that adds an Office Add-in limits each part to 5 digits.</p><p><code>doctor</code> runs these checks in order:</p><table tabindex="0"><thead><tr><th>Check</th><th>Passes when</th></tr></thead><tbody><tr><td><code>env</code></td><td>The app id, password, and tenant id variables are set.</td></tr><tr><td><code>token</code></td><td>Microsoft Entra issues a Bot Framework token for the app within 10 seconds.</td></tr><tr><td><code>bot-tenant</code></td><td>The Azure Bot is <strong>Single Tenant</strong> and its tenant is the one in the channel's tenant id variable.</td></tr><tr><td><code>bot-endpoint</code></td><td>The Azure Bot's messaging endpoint is <code>--endpoint</code>. Without <code>--endpoint</code>, it reports the bot's endpoint.</td></tr><tr><td><code>teams-channel</code></td><td>The Azure Bot's Microsoft Teams channel is added and on.</td></tr><tr><td><code>endpoint</code></td><td>The endpoint's path names this channel, and an unsigned <code>POST</code> to it gets <code>401</code>.</td></tr></tbody></table><p>The three Azure checks need the Azure CLI, logged in with <code>az login</code>, on any operating system. Without it they are skipped. When no Azure Bot in the current subscription has the app id, they fail. Each <code>az</code> call has a time limit. The endpoint's path must end in <code>/v1/channels/<channel></code> plus the channel's <code>path</code>, after nothing, the agent's slug, or <code>/engine</code> on Cursor-managed hosting. A URL for another channel or agent fails without a probe. The <code>endpoint</code> answers mean:</p><table tabindex="0"><thead><tr><th>Answer</th><th>Meaning</th></tr></thead><tbody><tr><td><code>401</code> with <code>invalid_token</code></td><td>The Teams channel serves this URL and its credentials resolve. Teams signs its requests, so the channel refuses the unsigned probe.</td></tr><tr><td><code>401</code> with <code>Unauthorized</code></td><td>Cursor-managed hosting serves this URL and refuses the unsigned probe before the agent.</td></tr><tr><td><code>503</code> with <code>teams_not_configured</code></td><td>The server has no app id or password for this channel. Check <code>envPrefix</code> and the secrets.</td></tr><tr><td><code>404</code></td><td>No Teams channel at this path. Check the slug, the channel name, and the route path.</td></tr><tr><td>A redirect</td><td>A dev tunnel that needs sign-in. Run <code>devtunnel access create <id> --anonymous</code>.</td></tr></tbody></table><p><code>--endpoint</code> must be the public <code>https</code> URL that <code>dev</code> or <code>channels teams forward</code> prints. <code>agent-sdk dev</code> admits unsigned requests from loopback, so a loopback probe proves nothing. Without <code>--endpoint</code>, <code>doctor</code> probes the Azure Bot's messaging endpoint.</p><p>The channel's <code>envPrefix</code> owns the variable names. A new channel file reads <code>TEAMS_APP_ID</code>, <code>TEAMS_APP_PASSWORD</code>, and <code>TEAMS_TENANT_ID</code>. <code>init --prefix HELM</code> writes <code>envPrefix: "HELM"</code> into the new file and the names <code>HELM_TEAMS_APP_ID</code>, <code>HELM_TEAMS_APP_PASSWORD</code>, and <code>HELM_TEAMS_TENANT_ID</code>. The prefix must start with a letter, and each name must be a valid deployment secret name. When the agent already has a Teams channel, under any file name, <code>init</code> keeps it and writes the names it reads; a <code>--prefix</code> that disagrees with it stops with an error. <code>doctor</code> and <code>package</code> read the names from the loaded channel. Multi-agent servers need one Azure Bot per agent.</p><p>A channel that sets <code>credentials</code> in code has no env names for the CLI to read. <code>doctor</code> then skips the <code>env</code>, <code>token</code>, and Azure checks and says why, <code>package</code> and <code>init</code> stop with an error, and <code>doctor</code> still probes <code>--endpoint</code>.</p><h3 id="github" tabindex="-1">Test GitHub webhooks <a class="header-anchor" href="#github" aria-label="Permalink to "Test GitHub webhooks {#github}""></a></h3><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 github forward [--dir <path>] [--slug <slug>] [--channel <id>]</span></span>
|
|
125
135
|
<span class="line"><span> [--repo owner/repo | --org <org>] [--events a,b,c]</span></span>
|
|
126
136
|
<span class="line"><span> [--url <url>] [--host <host>] [--port <n>]</span></span>
|
|
127
137
|
<span class="line"><span> [--secret <secret>] [--install]</span></span>
|
|
@@ -135,8 +145,8 @@
|
|
|
135
145
|
<span class="line"><span>agent-sdk bitbucket replay <pr-url-or-workspace/repo#N> [replay flags]</span></span>
|
|
136
146
|
<span class="line"><span>agent-sdk pagerduty replay [incident-id] [replay flags]</span></span>
|
|
137
147
|
<span class="line"><span>agent-sdk <gitlab|bitbucket|pagerduty> events [--dir <path>] [--json]</span></span>
|
|
138
|
-
<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-
|
|
139
|
-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"
|
|
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\":\"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>
|
|
140
150
|
|
|
141
151
|
</body>
|
|
142
152
|
</html>
|