@grok/agent-sdk 0.2.29 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/channels/slack/slack-channel.d.ts.map +1 -1
- package/dist/channels/slack/slack-channel.js +27 -14
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DMrZKFjI.js → app.BSH__xV4.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.Bo3ct-rf.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.Bo3ct-rf.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.b6H_ea44.js +1 -0
- package/dist/docs/assets/changelog.md.b6H_ea44.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CiRGcfZg.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.DQvuw1KA.js → VPLocalSearchBox.Cadl7A0k.js} +1 -1
- package/dist/docs/assets/chunks/{arc.ahOG-Qza.js → arc.K7t9nNY6.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.BcgfYNO_.js → architectureDiagram-Q4EWVU46.SlHEknkX.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.DeIYZrWh.js → baseUniq.DJLRMLkz.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.HjJ2goMX.js → blockDiagram-DXYQGD6D.Bs6XxFpe.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.C1QTb9GM.js → c4Diagram-AHTNJAMY.CyLg6Ovc.js} +1 -1
- package/dist/docs/assets/chunks/channel.CVTdqYx0.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.UuZiDiVp.js → chunk-4BX2VUAB.DTQ4TinT.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.5A3YmkhI.js → chunk-4TB4RGXK.Es84IgcH.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.B4uf1yYV.js → chunk-55IACEB6.Clm3cGPQ.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CoXBce8t.js → chunk-EDXVE4YY.DE4CRkS5.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DnC5NO4e.js → chunk-FMBD7UC4.Bf8HCvqp.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CzfHCeIi.js → chunk-OYMX7WX6.eub-7nSx.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.C6tcwkVd.js → chunk-QZHKN3VN.WyP9VAS_.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM._oboyZ1A.js → chunk-YZCP3GAM.LO9ohhDE.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/clone.Dk8KvtOB.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.BfPVKeId.js → cose-bilkent-S5V4N54A.D5za6aH0.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CLMLc0lD.js → dagre-KV5264BT.Dq1daUru.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.C7OF7UfH.js → diagram-5BDNPKRD.j1YL5BKS.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Dpao0Bl1.js → diagram-G4DWMVQ6.Bi1aLdhC.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.DLnM9eLp.js → diagram-MMDJMWI5.BOzMEkAr.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.BcpVgA_M.js → diagram-TYMM5635.Dx2FVhCr.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.CsL5JuCV.js → erDiagram-SMLLAGMA.DI4TNkye.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.MFihq9AF.js → flowDiagram-DWJPFMVM.C58Z9uPK.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CJeLodyG.js → ganttDiagram-T4ZO3ILL.DXSpW809.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.1HhlE45Z.js → gitGraphDiagram-UUTBAWPF.B955oaFl.js} +1 -1
- package/dist/docs/assets/chunks/{graph.BS02KkWA.js → graph.BQXhKtxS.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.fp5gvytQ.js → infoDiagram-42DDH7IO.Dozj_-Gm.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6Wk1V4I.js → ishikawaDiagram-UXIWVN3A.D2140OzH.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.qJt4uJ_H.js → journeyDiagram-VCZTEJTY.DrqrMhCk.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.z2tG9kly.js → kanban-definition-6JOO6SKY.Dv-LTrlw.js} +1 -1
- package/dist/docs/assets/chunks/{layout.BPCkdejr.js → layout.CGtHp49X.js} +1 -1
- package/dist/docs/assets/chunks/{linear.CL3TC3u7.js → linear.CHZLYB52.js} +1 -1
- package/dist/docs/assets/chunks/{min.SPrSp704.js → min.D4Vt3eIy.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.DgrQRFZW.js → mindmap-definition-QFDTVHPH.BBfpYTea.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Ba7yxiW2.js → pieDiagram-DEJITSTG.BVYvElmY.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.Bvskad4p.js → quadrantDiagram-34T5L4WZ.C6Gc2mdY.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.Ce70ugV9.js → requirementDiagram-MS252O5E.DWa8b4cn.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BJ5OEULO.js → sankeyDiagram-XADWPNL6.Bi-g4ajv.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.C8a1hDs6.js → sequenceDiagram-FGHM5R23.DlU3vVN9.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.D2D8A5CK.js → stateDiagram-FHFEXIEX.CeqJRqnU.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.DE0BnUZh.js +1 -0
- package/dist/docs/assets/chunks/{theme.DRciHmS1.js → theme.DGq7D4tt.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C4ePrY8-.js → timeline-definition-GMOUNBTQ.Cqf2kjq9.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Dzso6dEA.js → vennDiagram-DHZGUBPP.BeOpE_lM.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.djgXR0ar.js → wardley-RL74JXVD.FMQXA-6q.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.Bf2ICxjh.js → wardleyDiagram-NUSXRM2D.BXS65dAC.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DEH4BcVJ.js → xychartDiagram-5P7HB3ND.haEiSxqc.js} +1 -1
- package/dist/docs/assets/deployment.md.DJtuDVLh.js +31 -0
- package/dist/docs/assets/{deployment.md.KW0Ni_rY.lean.js → deployment.md.DJtuDVLh.lean.js} +1 -1
- package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
- package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.DcB3nhOz.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.DcB3nhOz.lean.js +1 -0
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
- package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
- package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
- package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.CcuZ7keS.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.CcuZ7keS.lean.js} +1 -1
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
- package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
- package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.js → guides_mcp-oauth.md.GVPMKcYl.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.lean.js → guides_mcp-oauth.md.GVPMKcYl.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.B8CZxnnX.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.B8CZxnnX.lean.js} +1 -1
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.D7Rwyva4.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BwXHURvY.lean.js → guides_slack.md.D7Rwyva4.lean.js} +1 -1
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.js +5 -0
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.lean.js +1 -0
- package/dist/docs/assets/index.md.DnJPj_B6.js +14 -0
- package/dist/docs/assets/index.md.DnJPj_B6.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.CljDaJBi.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
- package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
- package/dist/docs/assets/reference_access.md.C5lblfUC.lean.js +1 -0
- package/dist/docs/assets/reference_agent-config.md.BSNp2uJ7.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.Ck29qYNj.lean.js → reference_agent-config.md.BSNp2uJ7.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
- package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
- package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
- package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.js +83 -0
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.lean.js +1 -0
- package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
- package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
- package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
- package/dist/docs/assets/{reference_evals.md.2BXeMiO2.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.vbIM394-.js +39 -0
- package/dist/docs/assets/reference_hooks.md.vbIM394-.lean.js +1 -0
- package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
- package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
- package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
- package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
- package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
- package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.Dd8_d0WG.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +1 -1
- package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
- package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
- package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
- package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
- package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
- package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.CGOdNVAL.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +41 -44
- package/dist/docs/building-with-agents.md +11 -104
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +14 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +97 -270
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -129
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +29 -64
- package/dist/docs/guides/bitbucket.html +62 -62
- package/dist/docs/guides/bitbucket.md +73 -134
- package/dist/docs/guides/cloud-agents.html +37 -37
- package/dist/docs/guides/cloud-agents.md +23 -53
- package/dist/docs/guides/convert-automation.html +39 -56
- package/dist/docs/guides/convert-automation.md +31 -115
- package/dist/docs/guides/github.html +46 -54
- package/dist/docs/guides/github.md +49 -131
- package/dist/docs/guides/gitlab.html +98 -108
- package/dist/docs/guides/gitlab.md +104 -184
- package/dist/docs/guides/improve.html +38 -43
- package/dist/docs/guides/improve.md +24 -90
- package/dist/docs/guides/jev.html +55 -95
- package/dist/docs/guides/jev.md +53 -160
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +33 -67
- package/dist/docs/guides/migrate.html +38 -43
- package/dist/docs/guides/migrate.md +56 -130
- package/dist/docs/guides/opentelemetry.html +41 -43
- package/dist/docs/guides/opentelemetry.md +32 -27
- package/dist/docs/guides/pagerduty.html +50 -49
- package/dist/docs/guides/pagerduty.md +65 -199
- package/dist/docs/guides/slack.html +51 -57
- package/dist/docs/guides/slack.md +76 -204
- package/dist/docs/guides/webhooks.html +42 -42
- package/dist/docs/guides/webhooks.md +64 -146
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +40 -42
- package/dist/docs/hillclimbing.md +40 -102
- package/dist/docs/index.html +49 -61
- package/dist/docs/index.md +42 -82
- package/dist/docs/llms-full.txt +2272 -5711
- package/dist/docs/llms.txt +9 -14
- package/dist/docs/quickstart.html +95 -152
- package/dist/docs/quickstart.md +91 -180
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +45 -58
- package/dist/docs/reference/agent-config.md +92 -176
- package/dist/docs/reference/artifacts.html +38 -39
- package/dist/docs/reference/artifacts.md +38 -62
- package/dist/docs/reference/channels.html +38 -39
- package/dist/docs/reference/channels.md +102 -151
- package/dist/docs/reference/cli.html +68 -84
- package/dist/docs/reference/cli.md +232 -697
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +47 -54
- package/dist/docs/reference/evals.md +75 -141
- package/dist/docs/reference/extensions.html +41 -43
- package/dist/docs/reference/extensions.md +37 -70
- package/dist/docs/reference/hooks.html +40 -52
- package/dist/docs/reference/hooks.md +62 -133
- package/dist/docs/reference/http-api.html +38 -42
- package/dist/docs/reference/http-api.md +66 -118
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +19 -29
- package/dist/docs/reference/limits.html +38 -38
- package/dist/docs/reference/limits.md +9 -21
- package/dist/docs/reference/memory.html +37 -38
- package/dist/docs/reference/memory.md +38 -75
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +14 -22
- package/dist/docs/reference/project-layout.html +49 -48
- package/dist/docs/reference/project-layout.md +38 -84
- package/dist/docs/reference/schedules.html +44 -46
- package/dist/docs/reference/schedules.md +59 -90
- package/dist/docs/reference/sessions.html +37 -37
- package/dist/docs/reference/sessions.md +66 -113
- package/dist/docs/reference/skills.html +39 -39
- package/dist/docs/reference/skills.md +11 -31
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/subagents.md +17 -31
- package/dist/docs/reference/tools.html +47 -64
- package/dist/docs/reference/tools.md +48 -130
- package/dist/docs/templates/agentic-owners.html +38 -38
- package/dist/docs/templates/agentic-owners.md +50 -74
- package/dist/docs/templates/reviews.html +69 -0
- package/dist/docs/templates/reviews.md +71 -0
- package/dist/docs/troubleshooting.html +38 -36
- package/dist/docs/troubleshooting.md +48 -101
- package/dist/filesystem.d.ts +7 -320
- package/dist/filesystem.d.ts.map +1 -1
- package/dist/filesystem.js +10 -691
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/internal/authored-alias-hooks.d.ts +6 -0
- package/dist/internal/authored-alias-hooks.d.ts.map +1 -1
- package/dist/internal/authored-alias-hooks.js +12 -0
- package/dist/internal/authored-loaders.js +10 -1
- package/dist/internal/cli/commands/scaffold.js +1 -1
- package/dist/internal/cli-deploy.js +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-images.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/continuation-session-ids.d.ts +15 -0
- package/dist/internal/continuation-session-ids.d.ts.map +1 -0
- package/dist/internal/continuation-session-ids.js +43 -0
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-manifest.d.ts +1 -0
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +0 -1
- package/dist/internal/discovery/agent-config.d.ts +2 -6
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +8 -25
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -3
- package/dist/internal/discovery/project.d.ts.map +1 -1
- package/dist/internal/discovery/project.js +15 -0
- package/dist/internal/filesystem/walk.d.ts +1 -5
- package/dist/internal/filesystem/walk.d.ts.map +1 -1
- package/dist/internal/filesystem/walk.js +1 -9
- package/dist/internal/hosted-catch-protocol.d.ts +3 -3
- package/dist/internal/hosted-catch-protocol.js +3 -3
- package/dist/internal/hosted-fetch.d.ts +7 -0
- package/dist/internal/hosted-fetch.d.ts.map +1 -0
- package/dist/internal/hosted-fetch.js +26 -0
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +7 -5
- package/dist/internal/install-cursor-skills.d.ts +5 -6
- package/dist/internal/install-cursor-skills.d.ts.map +1 -1
- package/dist/internal/install-cursor-skills.js +19 -4
- package/dist/internal/mcp-endpoint.js +4 -4
- package/dist/internal/model-config.d.ts.map +1 -1
- package/dist/internal/model-config.js +11 -4
- package/dist/internal/platform-timers.d.ts +3 -7
- package/dist/internal/platform-timers.d.ts.map +1 -1
- package/dist/internal/platform-timers.js +10 -51
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +6 -1
- package/dist/internal/session-engine.d.ts +3 -0
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +13 -4
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-Bno25Cg0.css +1 -0
- package/dist/playground/assets/index-SGKsaznh.js +62 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +6 -17
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +2 -2
- package/docs/README.md +42 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +15 -146
- package/docs/deployment.md +97 -270
- package/docs/evals.md +34 -130
- package/docs/guides/agent-to-agent.md +29 -64
- package/docs/guides/bitbucket.md +73 -134
- package/docs/guides/cloud-agents.md +23 -53
- package/docs/guides/convert-automation.md +31 -115
- package/docs/guides/github.md +49 -131
- package/docs/guides/gitlab.md +104 -184
- package/docs/guides/improve.md +24 -90
- package/docs/guides/jev.md +53 -160
- package/docs/guides/mcp-oauth.md +33 -67
- package/docs/guides/migrate.md +56 -130
- package/docs/guides/opentelemetry.md +37 -27
- package/docs/guides/pagerduty.md +68 -200
- package/docs/guides/slack.md +76 -204
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +91 -180
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +92 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +232 -697
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +75 -141
- package/docs/reference/extensions.md +37 -70
- package/docs/reference/hooks.md +61 -132
- package/docs/reference/http-api.md +66 -118
- package/docs/reference/instructions.md +20 -30
- package/docs/reference/limits.md +10 -22
- package/docs/reference/memory.md +38 -75
- package/docs/reference/playground.md +14 -22
- package/docs/reference/project-layout.md +38 -84
- package/docs/reference/schedules.md +59 -90
- package/docs/reference/sessions.md +66 -113
- package/docs/reference/skills.md +12 -32
- package/docs/reference/subagents.md +17 -31
- package/docs/reference/tools.md +48 -130
- package/docs/templates/agentic-owners.md +50 -74
- package/docs/templates/reviews.md +76 -0
- package/docs/troubleshooting.md +48 -101
- package/package.json +4 -4
- package/skills/cli/SKILL.md +1 -1
- package/skills/create-agent/SKILL.md +61 -7
- package/skills/debug/SKILL.md +1 -1
- package/skills/deploy/SKILL.md +3 -3
- package/skills/evals/SKILL.md +1 -1
- package/skills/framework-map/SKILL.md +2 -2
- package/skills/github/SKILL.md +1 -1
- package/skills/hillclimb/SKILL.md +1 -1
- package/skills/mcp-auth/SKILL.md +1 -1
- package/skills/migrate-v2/SKILL.md +2 -3
- package/skills/otel/SKILL.md +1 -1
- package/skills/setup-slack/SKILL.md +2 -2
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.DrLFQUlu.js +0 -1
- package/dist/docs/assets/changelog.md.DrLFQUlu.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.Dpd_wxVU.js +0 -1
- package/dist/docs/assets/chunks/channel._fZX_hvU.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/clone.W1Phdw9P.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.77yf4kRr.js +0 -1
- package/dist/docs/assets/deployment.md.KW0Ni_rY.js +0 -31
- package/dist/docs/assets/evals.md.DiljU__Z.js +0 -68
- package/dist/docs/assets/evals.md.DiljU__Z.lean.js +0 -1
- package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
- package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
- package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
- package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.BwXHURvY.js +0 -88
- package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
- package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
- package/dist/docs/assets/index.md.CAruw_rp.js +0 -26
- package/dist/docs/assets/index.md.CAruw_rp.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.CljDaJBi.js +0 -170
- package/dist/docs/assets/reference_access.md.CEtibb4i.js +0 -1
- package/dist/docs/assets/reference_access.md.CEtibb4i.lean.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.Ck29qYNj.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
- package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.js +0 -99
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.2BXeMiO2.js +0 -76
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
- package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.js +0 -8
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.lean.js +0 -1
- package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
- package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
- package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
- package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
- package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
- package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
- package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
- package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.CGOdNVAL.js +0 -1
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- package/dist/docs/package/skills/create-agent/SKILL.md +0 -178
- package/dist/docs/package/skills/evals/SKILL.md +0 -145
- package/dist/docs/package/skills/github/SKILL.md +0 -133
- package/dist/docs/package/skills/hillclimb/SKILL.md +0 -63
- package/dist/docs/package/skills/mcp-auth/SKILL.md +0 -60
- package/dist/docs/package/skills/migrate-v2/SKILL.md +0 -394
- package/dist/docs/package/skills/setup-slack/SKILL.md +0 -136
- package/dist/docs/reference/prompt.html +0 -68
- package/dist/docs/reference/prompt.md +0 -47
- package/dist/docs/templates/security-reviewer.html +0 -62
- package/dist/docs/templates/security-reviewer.md +0 -81
- package/dist/docs/templates/thermo-quality-review.html +0 -62
- package/dist/docs/templates/thermo-quality-review.md +0 -75
- package/dist/docs/templates/thermo-review.html +0 -62
- package/dist/docs/templates/thermo-review.md +0 -75
- package/dist/docs/templates/triage.html +0 -68
- package/dist/docs/templates/triage.md +0 -101
- package/dist/internal/filesystem/errors.d.ts +0 -64
- package/dist/internal/filesystem/errors.d.ts.map +0 -1
- package/dist/internal/filesystem/errors.js +0 -180
- package/dist/internal/filesystem/merge.d.ts +0 -34
- package/dist/internal/filesystem/merge.d.ts.map +0 -1
- package/dist/internal/filesystem/merge.js +0 -154
- package/dist/playground/assets/index-Cl9zvmmf.js +0 -62
- package/dist/playground/assets/index-F8b5WvWi.css +0 -1
- package/docs/guides/hooks.md +0 -121
- package/docs/reference/prompt.md +0 -52
- package/docs/templates/security-reviewer.md +0 -86
- package/docs/templates/thermo-quality-review.md +0 -80
- package/docs/templates/thermo-review.md +0 -80
- package/docs/templates/triage.md +0 -106
|
@@ -5,147 +5,94 @@ Start with three checks:
|
|
|
5
5
|
1. Run `agent-sdk validate --dir .`.
|
|
6
6
|
2. Confirm the expected agent and connections in
|
|
7
7
|
`agent-sdk info --dir . --json`.
|
|
8
|
-
3. Reproduce once, then
|
|
8
|
+
3. Reproduce the problem once, then read the serve log or the
|
|
9
|
+
[session trace](#read-the-session-trace).
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
## Serve or the playground will not work
|
|
13
|
-
|
|
14
|
-
| What you see | What to do |
|
|
15
|
-
| --- | --- |
|
|
16
|
-
| `serve` exits before listening | Fix the errors from `agent-sdk validate --dir .`, then start it again. |
|
|
17
|
-
| Playground is blank or says there are no agents | Start `agent-sdk serve`; built playground assets have no agent data without the server. |
|
|
18
|
-
| Agent-file edits do not appear | Open the URL printed by `serve --dev`, then press Enter in its TTY to reload after file changes. |
|
|
19
|
-
| Sessions exist but the list is empty | The list is scoped to the authenticated principal. Use the same identity that created the session; a `?sessionId=` deep link does not bypass authorization. |
|
|
20
|
-
| The preferred port is busy | Use the next port printed by the CLI, pass `--port <number>`, or pass `--port 0` for any free port. |
|
|
21
|
-
|
|
22
|
-
## A model turn fails
|
|
11
|
+
## Serve or the playground won't work
|
|
23
12
|
|
|
24
13
|
| What you see | What to do |
|
|
25
14
|
| --- | --- |
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
| Login succeeds but the model host rejects the key | Point login and model traffic at the same API host; check `CURSOR_API_BASE_URL` and `CURSOR_BACKEND_URL`. |
|
|
30
|
-
| The first turn reports `[resource_exhausted]` | Treat it as a capacity-shaped error. For a GitHub wake, also check the connected GitHub credential and any GitHub `429` rate limit before assuming the model quota is exhausted. |
|
|
15
|
+
| The playground is blank or lists no agents | Start `agent-sdk serve`, because the playground gets its agents from the server. |
|
|
16
|
+
| Agent-file edits don't appear | Open the URL that `serve --dev` prints, and press Enter in its terminal to reload. |
|
|
17
|
+
| Sessions exist but the list is empty | The list shows only your own sessions, so use the identity that created them. |
|
|
31
18
|
|
|
32
|
-
## A turn
|
|
19
|
+
## A turn fails or misbehaves
|
|
33
20
|
|
|
34
21
|
| What you see | What to do |
|
|
35
22
|
| --- | --- |
|
|
36
|
-
|
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
23
|
+
| Reads and greps keep failing with `NGHTTP2_FRAME_SIZE_ERROR` | Run the agent under Node 22.13 or newer, never Bun. |
|
|
24
|
+
| `Semantic search has been removed. Use Grep.` | Delete `search` from a custom `fs`, drop `SearchQuery` and `SearchResult`, and remove `SemanticSearch` or `semSearch` from `tools` and `bot/tools/`. |
|
|
25
|
+
| The turn reports a missing API key | Set `CURSOR_API_KEY`, `CURSOR_API_KEY_FILE`, or `CURSOR_SERVICE_ACCOUNT_KEY`, or run `agent-sdk login`. |
|
|
26
|
+
| Login works but the model host rejects the key | Point `CURSOR_API_BASE_URL` and `CURSOR_BACKEND_URL` at the same API host. |
|
|
27
|
+
| The first turn reports `[resource_exhausted]` | The model is usually out of capacity. If a GitHub event started the turn, check for a GitHub `429` rate-limit response first. |
|
|
28
|
+
| Replies quote an ancestor `AGENTS.md` or unrelated repository rules | Set `defineAgent({ local: { cwd } })` so the agent doesn't inherit the parent checkout. `/v1/info` shows the current `local.cwd`. |
|
|
29
|
+
| The model lists IDE meta-tools but never calls named MCP tools | Set `advertiseTools: true` on the local connection. |
|
|
30
|
+
| Server tools, skills, or seed files are missing | Check the discovered project in `/v1/info`, and follow the warning from `validate`. |
|
|
31
|
+
| `validate` and `run` pass but CI type-checking fails | Return JSON-shaped tool results, such as object literals or `type` aliases, instead of `interface` types. |
|
|
40
32
|
|
|
41
33
|
## HTTP returns 401, 403, or 409
|
|
42
34
|
|
|
43
35
|
| What you see | What to do |
|
|
44
36
|
| --- | --- |
|
|
45
|
-
| `401` outside local development | Send the
|
|
46
|
-
| `403` on a stream or follow-up | Use the
|
|
47
|
-
| A custom
|
|
48
|
-
| `409` on a follow-up | Refresh the rotating `continuationToken
|
|
49
|
-
| `409 session_busy` from `call --session` | Wait for the turn, omit `--session`, or mark a read-only tool
|
|
50
|
-
| A custom route fails schema type-checking | Add the required Zod `querySchema` for `GET`, or `bodySchema` for `POST`, `PUT`, and `PATCH`. See [Channels](/docs/reference/channels.md). |
|
|
37
|
+
| `401` outside local development | Send the bearer token, alias token, or channel credential. Default custom routes accept only direct loopback calls. |
|
|
38
|
+
| `403` on a stream or follow-up | Use the identity that created the session. |
|
|
39
|
+
| A custom route fails through a tunnel or LAN | Protect the host with `--bearer-token` or channel auth. Use `--allow-anonymous` only behind a proxy that authenticates every caller. |
|
|
40
|
+
| `409` on a follow-up | Refresh the rotating `continuationToken`. Task sessions don't accept follow-ups. |
|
|
41
|
+
| `409 session_busy` from `call --session` | Wait for the turn, omit `--session`, or mark a read-only tool `effect: "read"` so it can run alongside the turn. |
|
|
51
42
|
|
|
52
43
|
## A hosted deployment fails or looks stale
|
|
53
44
|
|
|
54
45
|
| What you see | What to do |
|
|
55
46
|
| --- | --- |
|
|
56
|
-
| `validate` or `deploy` reports `architecture "v2" requires a named secret` |
|
|
57
|
-
| Local changes
|
|
58
|
-
| The deployment never
|
|
59
|
-
| A secret or egress change has no effect | Confirm the name with `secret list`,
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
| `session create` prints a `deliveryId` but no `sessionId` | Expected without `--wait`: the session is created when the turn starts. Pass `--wait`, or find it with `agent-sdk logs --prod --once --slug <slug>`, then follow [Verify a hosted turn](/docs/deployment.md#verify-a-hosted-turn). |
|
|
63
|
-
| `session get <sessionId> --prod` shows a `running` run with no logs | Runs lag behind events, and a high-effort turn can take several minutes. Rerun the command; a growing event count means the turn is still working. |
|
|
64
|
-
| A [Deployed Agents](https://cursor.com/dashboard/deployed-agents) link to a single session doesn't open | Check the session with `agent-sdk session get <sessionId> --prod --slug <slug>`. |
|
|
65
|
-
| `chat`, `tool call`, `skill`, `session get --view cost`, or `mcp` with `--prod` exits with a usage error | Hosted deployments take `--prod` only on `session list`, `session get`, and `logs`; `session create` is always hosted. See [Verify a hosted turn](/docs/deployment.md#verify-a-hosted-turn). |
|
|
66
|
-
| `session create --session <sessionId>` reports the session belongs to another channel | `--session` continues only sessions that `session create` started. Reach Slack, SCM, and custom-route sessions through their own channel. |
|
|
67
|
-
| A custom route returns `202` with no body | Expected on managed hosting. The handler runs after the response, so deliver results from the channel. See [Route responses](/docs/reference/channels.md#route-responses). |
|
|
68
|
-
| External HTTP rejects the alias token | Update the caller with the current token. If the token is lost or exposed, run `agent-sdk deployment rotate-token <slug>` and replace it everywhere. |
|
|
69
|
-
| `deploy`, a hosted session, or an eval run says it is not available with Privacy Mode (Legacy) | Switch to Privacy Mode, or ask a team admin if your team enforces this setting. A refused session does not store the message. See [Privacy Mode](/docs/deployment.md#privacy-mode). |
|
|
70
|
-
| `deploy` says persistent deployments are limited to 1 per team | Another deployment of the team already sets `persistent: true`. Remove the setting from one agent, or delete that deployment. |
|
|
71
|
-
| A schedule does not fire on the hosted deployment | Make sure the deployment is running and its release has the schedule. Deploy again with `@grok/agent-sdk` 0.2.14 or newer. |
|
|
72
|
-
| A request to a custom route gets `429` | The deployment received more requests than its limit. Wait for the time in `Retry-After`, then send the request again. |
|
|
73
|
-
|
|
74
|
-
See [Deployment](/docs/deployment.md) for source, credential, and
|
|
75
|
-
redeployment boundaries.
|
|
47
|
+
| `validate` or `deploy` reports `architecture "v2" requires a named secret` | Replace the literal or getter with a [named secret](/docs/deployment.md#add-egress-and-secrets), and set its value with `agent-sdk secret set <slug> NAME`. |
|
|
48
|
+
| Local changes don't appear after deploy | `deploy` builds the pushed ref, so commit and push your changes, then deploy again. |
|
|
49
|
+
| The deployment never reaches `running` | Run `agent-sdk deployment get <slug>`, and fix the error it reports. |
|
|
50
|
+
| A secret or egress change has no effect | Confirm the name with `secret list`, check that the `hosting` block is on the pushed ref, and redeploy. |
|
|
51
|
+
| A hosted schedule doesn't fire | Check that the deployment is running and that the schedule is in `bot/schedules/` on the deployed ref. |
|
|
52
|
+
| A custom route returns `429` | Wait for the time in `Retry-After`, then send it again. |
|
|
76
53
|
|
|
77
54
|
## GitHub deliveries fail
|
|
78
55
|
|
|
79
56
|
| What you see | What to do |
|
|
80
57
|
| --- | --- |
|
|
81
|
-
| `github forward`
|
|
82
|
-
| `Hook already exists` |
|
|
83
|
-
| Direct
|
|
84
|
-
| You
|
|
58
|
+
| `github forward` gets `401` on every delivery | Clear the token variables so the forwarder uses your `gh` login, as in `GITHUB_TOKEN= GH_TOKEN= agent-sdk github forward`. |
|
|
59
|
+
| `Hook already exists` | Stop the stale forwarder. GitHub allows one per repository. |
|
|
60
|
+
| Direct webhooks are rejected outside `--dev` | Set the same `GITHUB_WEBHOOK_SECRET` on the signer and the server. |
|
|
61
|
+
| You can't create a forwarder | Use `agent-sdk github replay <pr-url>`, which needs only pull access. |
|
|
85
62
|
|
|
86
|
-
|
|
87
|
-
direct webhooks.
|
|
88
|
-
|
|
89
|
-
## Slack does not respond
|
|
63
|
+
## Slack doesn't respond
|
|
90
64
|
|
|
91
65
|
| What you see | What to do |
|
|
92
66
|
| --- | --- |
|
|
93
|
-
| Logs say `channel idle ... missing credentials` | Run `agent-sdk slack create --dir <agent>`, then check the
|
|
94
|
-
| `slack create`
|
|
95
|
-
| The bot ignores ordinary channel posts | Configure `engagement.channelPosts`, create the app with `--channel-posts`, and invite it to
|
|
96
|
-
|
|
97
|
-
See the [Slack guide](/docs/guides/slack.md) for app setup and engagement
|
|
98
|
-
choices.
|
|
67
|
+
| Logs say `channel idle ... missing credentials` | Run `agent-sdk slack create --dir <agent>`, then check the prefix with `agent-sdk slack doctor`. |
|
|
68
|
+
| `slack create` waits for workspace approval | Keep the CLI running and open the **Request approval** link it prints. After an admin approves, select **Retry** in the [Deployed Agents](https://cursor.com/dashboard/deployed-agents) **Add Slack** wizard. |
|
|
69
|
+
| The bot ignores ordinary channel posts | Configure `engagement.channelPosts`, create the app with `--channel-posts`, and invite it to each allowed channel. |
|
|
99
70
|
|
|
100
71
|
## MCP authorization fails
|
|
101
72
|
|
|
102
73
|
| What you see | What to do |
|
|
103
74
|
| --- | --- |
|
|
104
|
-
| `must be defineConnection({ url, oauth: true })` | Add `oauth: true` to the
|
|
105
|
-
| Local auth works but hosted calls return unauthorized |
|
|
106
|
-
| The model invents `mcp_auth` instead of calling the server | Set `advertiseTools: true` for named local tools, or expose a
|
|
107
|
-
|
|
108
|
-
See [Host MCP OAuth](/docs/guides/mcp-oauth.md) for the credential lifecycle.
|
|
75
|
+
| `must be defineConnection({ url, oauth: true })` | Add `oauth: true` to the connection, or fix the filename you passed to `mcp oauth`. |
|
|
76
|
+
| Local auth works but hosted calls return unauthorized | Your local OAuth tokens don't reach a deployment. Use a `cursorAccount: true` connection, as described in [Host MCP OAuth](/docs/guides/mcp-oauth.md#use-an-oauth-server-from-a-hosted-agent). |
|
|
77
|
+
| The model invents `mcp_auth` instead of calling the server | Set `advertiseTools: true` for named local tools, or expose a wrapper through `ctx.host.mcp`. |
|
|
109
78
|
|
|
110
79
|
## Schedules or reminders stall
|
|
111
80
|
|
|
112
81
|
| What you see | What to do |
|
|
113
82
|
| --- | --- |
|
|
114
|
-
| A schedule or reminder never fires under `--dev` |
|
|
115
|
-
| A reminder is disarmed with `handler_lost_on_restart` | Recreate handler-form reminders after restart, or use a prompt-form reminder. |
|
|
116
|
-
|
|
|
117
|
-
|
|
118
|
-
## A credential was exposed
|
|
119
|
-
|
|
120
|
-
| What you see | What to do |
|
|
121
|
-
| --- | --- |
|
|
122
|
-
| A secret value appears in a command, transcript, or shell history | Rotate it at the provider, set it again through hidden input or stdin, and test the feature. |
|
|
123
|
-
| An alias token appears outside its secure destination | Run `agent-sdk deployment rotate-token <slug>`, store the new value outside transcripts, and update every caller. |
|
|
124
|
-
| Someone printed a secret to verify it | Rotate it. Confirm only the name with `agent-sdk secret list <slug>`, then redeploy and exercise the feature. |
|
|
83
|
+
| A schedule or reminder never fires under `--dev` | `--dev` doesn't fire them on its own, so trigger one through its `/v1/dev/schedules/<id>` or `/v1/dev/reminders/<id>` route. |
|
|
84
|
+
| A reminder is disarmed with `handler_lost_on_restart` | Recreate handler-form reminders after a restart, or use a prompt-form reminder. |
|
|
85
|
+
| One schedule fires on several self-hosted processes | Pass `--no-schedules` to every serving process but one. |
|
|
125
86
|
|
|
126
87
|
## Read the session trace
|
|
127
88
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
`turn.failed` with `turn interrupted` usually means a follow-up or stop
|
|
133
|
-
ended the turn deliberately. Other failures should have an error event
|
|
134
|
-
near the tool or model boundary that produced them.
|
|
135
|
-
|
|
136
|
-
Use the trace path printed by `agent-sdk run`:
|
|
137
|
-
|
|
138
|
-
```text
|
|
89
|
+
```bash
|
|
90
|
+
agent-sdk session list --prod --slug <slug>
|
|
91
|
+
agent-sdk session get <sessionId> --prod --slug <slug> --view events
|
|
139
92
|
agent-sdk session get --file <trace-path>
|
|
140
93
|
```
|
|
141
94
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
## Related
|
|
147
|
-
|
|
148
|
-
- [Deployment](/docs/deployment.md): hosted and self-hosted boundaries
|
|
149
|
-
- [Sessions](/docs/reference/sessions.md): session ownership and event
|
|
150
|
-
vocabulary
|
|
151
|
-
- [CLI reference](/docs/reference/cli.md): command flags and exit behavior
|
|
95
|
+
Find a hosted session with `session list`, then print its events with
|
|
96
|
+
`--view events`. For a local run, pass the trace path from `agent-sdk run`
|
|
97
|
+
to `--file`. Pair each `actions.requested` event with its `action.result`
|
|
98
|
+
to find the call that failed.
|
package/dist/filesystem.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import type
|
|
2
|
-
export { DeleteNotSupportedError, EditError, FileNotFoundError, InvalidGrepPatternError, isFileNotFoundError, isInvalidGrepPatternError, NoMountError, PathError, ReadOnlyMountError, WriteFailedError, } from "./internal/filesystem/errors.js";
|
|
1
|
+
import { type FileSystem, type FSGrepQuery, type FSGrepResult, type ToolName } from "@cursor/sdk";
|
|
3
2
|
import type { HostFilesApi, HostFilesScope } from "./types.js";
|
|
3
|
+
export type { DirEntry, FileInfo, FileSystem, FSEditQuery as EditQuery, FSEditResult as EditResult, FSGrepQuery as GrepQuery, FSGrepResult as GrepResult, GlobOptions, ListOptions, } from "@cursor/sdk";
|
|
4
|
+
export { childOverlayFs, DeleteNotSupportedError, EditError, emptyFs, FILE_SYSTEM_SCAN_LIMIT, FileNotFoundError, InvalidGrepPatternError, isFileNotFoundError, isInvalidGrepPatternError, NoMountError, overlayFs, PathError, ReadOnlyMountError, readOnlyFs, remapPathError, strReplaceOnFileSystem, tempFs, unionFs, WriteFailedError, } from "@cursor/sdk";
|
|
4
5
|
/**
|
|
5
6
|
* Status envelope used by walk helpers such as `lsFromList`.
|
|
6
7
|
* FileSystem methods throw; they do not return this.
|
|
@@ -15,31 +16,9 @@ export type FileSystemResult<T> = {
|
|
|
15
16
|
message: string;
|
|
16
17
|
};
|
|
17
18
|
};
|
|
18
|
-
/**
|
|
19
|
-
* One file in a `list` / `glob` stream.
|
|
20
|
-
*
|
|
21
|
-
* `path` is an absolute posix path (`/src/a.ts`). No trailing slash
|
|
22
|
-
* except `/`. `size` is optional byte length of the file contents.
|
|
23
|
-
*/
|
|
24
|
-
export interface DirEntry {
|
|
25
|
-
path: string;
|
|
26
|
-
size?: number;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Existence probe. `directory` means this path is a prefix of at
|
|
30
|
-
* least one file (virtual trees infer directories) or a real
|
|
31
|
-
* directory on disk. `missing` is a value, not an error.
|
|
32
|
-
*/
|
|
33
|
-
export type FileInfo = {
|
|
34
|
-
kind: "file";
|
|
35
|
-
} | {
|
|
36
|
-
kind: "directory";
|
|
37
|
-
} | {
|
|
38
|
-
kind: "missing";
|
|
39
|
-
};
|
|
40
19
|
/**
|
|
41
20
|
* Native Grep `output_mode` envelope. Not a FileSystem method
|
|
42
|
-
* result. The `grep` verb yields {@link
|
|
21
|
+
* result. The `grep` verb yields {@link FSGrepResult}; synthesis
|
|
43
22
|
* shapes this union after draining the stream.
|
|
44
23
|
*/
|
|
45
24
|
export type GrepUnionResult = {
|
|
@@ -70,230 +49,6 @@ export type GrepUnionResult = {
|
|
|
70
49
|
total: number;
|
|
71
50
|
};
|
|
72
51
|
};
|
|
73
|
-
/**
|
|
74
|
-
* One content hit from `grep`. `path` is absolute posix.
|
|
75
|
-
* `lineNumber` is 1-indexed. `line` is the full matching line,
|
|
76
|
-
* without the trailing newline.
|
|
77
|
-
*/
|
|
78
|
-
export interface GrepResult {
|
|
79
|
-
path: string;
|
|
80
|
-
lineNumber: number;
|
|
81
|
-
line: string;
|
|
82
|
-
}
|
|
83
|
-
/**
|
|
84
|
-
* Optional filters for {@link FileSystem.list}.
|
|
85
|
-
*
|
|
86
|
-
* `excludes` are ignore globs in the same language as native LS
|
|
87
|
-
* `ignore`: a slash-free pattern matches at any depth, and a
|
|
88
|
-
* directory match drops that tree. Implementations that can push
|
|
89
|
-
* them to a backend should; others filter the yielded files.
|
|
90
|
-
* Native LS still applies `ignore` after `list` so a mount that
|
|
91
|
-
* ignores this argument still honors it.
|
|
92
|
-
*/
|
|
93
|
-
export interface ListOptions {
|
|
94
|
-
excludes?: readonly string[];
|
|
95
|
-
/**
|
|
96
|
-
* Optional result cap, lexicographic. Omitted means no
|
|
97
|
-
* FileSystem-level cap. `0` yields nothing.
|
|
98
|
-
*/
|
|
99
|
-
limit?: number;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Optional filters for {@link FileSystem.glob}.
|
|
103
|
-
*
|
|
104
|
-
* `limit` is the same lexicographic cap as {@link ListOptions.limit}.
|
|
105
|
-
*/
|
|
106
|
-
export interface GlobOptions {
|
|
107
|
-
limit?: number;
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* Default scan cap for synthesized LS / Glob and for Origin
|
|
111
|
-
* `ListRepoPaths` from `/repo`. Smaller than Origin's 10k default
|
|
112
|
-
* so a recursive listing does not materialize a huge response.
|
|
113
|
-
*/
|
|
114
|
-
export declare const FILE_SYSTEM_SCAN_LIMIT = 1000;
|
|
115
|
-
/**
|
|
116
|
-
* Content-search query. No `output_mode` or `offset` (those
|
|
117
|
-
* belong to the native Grep tool).
|
|
118
|
-
*
|
|
119
|
-
* `pattern` is a JavaScript regular expression source. Invalid
|
|
120
|
-
* source must throw {@link InvalidGrepPatternError} with message
|
|
121
|
-
* `invalid grep pattern: ${pattern}`. `path` omitted / `""` /
|
|
122
|
-
* `"/"` searches the whole tree; a file path searches that file
|
|
123
|
-
* only. A slash-free `glob` (`*.ts`) matches the basename at any
|
|
124
|
-
* depth under `path`.
|
|
125
|
-
*
|
|
126
|
-
* `excludes` are optional ignore globs (same language as
|
|
127
|
-
* {@link ListOptions.excludes}). Implementations that can push
|
|
128
|
-
* them to a backend should; others skip matching files. Native
|
|
129
|
-
* Grep has no ignore field; this is FileSystem-only pushdown.
|
|
130
|
-
*
|
|
131
|
-
* `maxResults` is optional predicate pushdown: stop after this
|
|
132
|
-
* many hits so a remote or large tree does not materialize a
|
|
133
|
-
* full scan. Native Grep still applies `head_limit` / `offset`
|
|
134
|
-
* after the merge. Omitted means no FileSystem-level cap.
|
|
135
|
-
*/
|
|
136
|
-
export interface GrepQuery {
|
|
137
|
-
pattern: string;
|
|
138
|
-
path?: string;
|
|
139
|
-
glob?: string;
|
|
140
|
-
excludes?: readonly string[];
|
|
141
|
-
caseInsensitive?: boolean;
|
|
142
|
-
maxResults?: number;
|
|
143
|
-
}
|
|
144
|
-
/**
|
|
145
|
-
* Exact, non-overlapping str-replace. `oldText` / `newText` are
|
|
146
|
-
* literal strings, not regex. Splice must keep `$`, `$&`, `$1`
|
|
147
|
-
* in `newText` as written (`String.prototype.replace` must not
|
|
148
|
-
* be used).
|
|
149
|
-
*/
|
|
150
|
-
export interface EditQuery {
|
|
151
|
-
path: string;
|
|
152
|
-
oldText: string;
|
|
153
|
-
newText: string;
|
|
154
|
-
replaceAll?: boolean;
|
|
155
|
-
}
|
|
156
|
-
/**
|
|
157
|
-
* StrReplace success. `occurrencesModified` is the number of
|
|
158
|
-
* non-overlapping replacements (1 unless `replaceAll`).
|
|
159
|
-
*/
|
|
160
|
-
export interface EditResult {
|
|
161
|
-
occurrencesModified: number;
|
|
162
|
-
}
|
|
163
|
-
/**
|
|
164
|
-
* Path verbs for the tree the agent runs on.
|
|
165
|
-
*
|
|
166
|
-
* Every method is required. Methods do not fall back to the
|
|
167
|
-
* host tree. Diagnostics are not a FileSystem concern.
|
|
168
|
-
*
|
|
169
|
-
* Paths are a single posix namespace rooted at `/`. Query paths
|
|
170
|
-
* and yielded paths are absolute (`/src/a.ts`). No trailing
|
|
171
|
-
* slash except `/`. `""`, `"/"`, and an omitted `prefix` / `dir`
|
|
172
|
-
* / `path` (where optional) mean the root. Prefix tests are
|
|
173
|
-
* path-segment: `/agent` matches `/agent/skills`, not
|
|
174
|
-
* `/agent-tools`.
|
|
175
|
-
*
|
|
176
|
-
* Async iterators are already sorted. `unionFs` k-way merges
|
|
177
|
-
* them and does not re-sort a source.
|
|
178
|
-
*
|
|
179
|
-
* - `list` / `glob`: lexicographic by `path`. Paths are unique.
|
|
180
|
-
* - `grep`: by `path`, then `lineNumber` ascending. Keep every hit.
|
|
181
|
-
*
|
|
182
|
-
* Native-tool pagination (`head_limit`, `offset`, `output_mode`)
|
|
183
|
-
* stays on the synthesized tools. `grep` takes optional
|
|
184
|
-
* `maxResults` as predicate pushdown so a tree can stop
|
|
185
|
-
* retrieving once the tool's cap is known.
|
|
186
|
-
* Native `LS` is built from `list` + `stat`; there is no `ls`
|
|
187
|
-
* method.
|
|
188
|
-
*
|
|
189
|
-
* Errors (authors must follow these, not invent parallel
|
|
190
|
-
* spellings):
|
|
191
|
-
*
|
|
192
|
-
* - `list` / `stat` / `glob` must not throw for a missing path.
|
|
193
|
-
* Missing is an empty iterator or `{ kind: "missing" }`.
|
|
194
|
-
* - `read` / `write` / `delete` throw {@link PathError}
|
|
195
|
-
* for recoverable failures. `error.message` is the string the
|
|
196
|
-
* synthesized native tool shows the model. `error.path` is the
|
|
197
|
-
* absolute posix path the composer remaps.
|
|
198
|
-
* - `grep` throws for an invalid regex (and a missing host
|
|
199
|
-
* search root). A missing virtual path yields nothing.
|
|
200
|
-
* - Missing-file message on `read` / `delete` is
|
|
201
|
-
* `not found: ${path}` (normalized absolute posix).
|
|
202
|
-
*/
|
|
203
|
-
export interface FileSystem {
|
|
204
|
-
/**
|
|
205
|
-
* Recursive file scan under `prefix`. Files only; directories
|
|
206
|
-
* are inferred from path prefixes. A file is not under itself,
|
|
207
|
-
* so listing a file path is empty. Empty is not "missing"
|
|
208
|
-
* (`stat` answers that). Yields lexicographic unique
|
|
209
|
-
* {@link DirEntry} rows. Omitted / `""` / `"/"` means the root.
|
|
210
|
-
*
|
|
211
|
-
* Errors: none. A missing or file-path prefix yields an empty
|
|
212
|
-
* iterator. Do not throw.
|
|
213
|
-
*
|
|
214
|
-
* `options.excludes` / `options.limit` are optional pushdown.
|
|
215
|
-
* See {@link ListOptions}.
|
|
216
|
-
*/
|
|
217
|
-
list(prefix?: string, options?: ListOptions): AsyncIterable<DirEntry>;
|
|
218
|
-
/**
|
|
219
|
-
* Existence probe: exact file, a prefix that has files, or
|
|
220
|
-
* missing. Does not throw. Native LS lists first and calls
|
|
221
|
-
* this only when the iterator is empty.
|
|
222
|
-
*
|
|
223
|
-
* Errors: none. Unknown paths are `{ kind: "missing" }`.
|
|
224
|
-
*/
|
|
225
|
-
stat(path: string): Promise<FileInfo>;
|
|
226
|
-
/**
|
|
227
|
-
* Same scan as `list`, filtered by `pattern` relative to
|
|
228
|
-
* `dir`. Yields lexicographic unique {@link DirEntry} rows.
|
|
229
|
-
* `dir` omitted / `""` / `"/"` means the tree root. Matching
|
|
230
|
-
* is relative to `dir`, not basename-anywhere (`*.ts` under
|
|
231
|
-
* `/src` is `/src/a.ts`, not `/src/nested/c.ts`).
|
|
232
|
-
*
|
|
233
|
-
* Errors: none. A missing `dir` or a pattern that matches
|
|
234
|
-
* nothing yields an empty iterator. Do not throw for a bad
|
|
235
|
-
* glob (it matches nothing).
|
|
236
|
-
*
|
|
237
|
-
* `options.limit` is optional result-cap pushdown. See
|
|
238
|
-
* {@link GlobOptions}.
|
|
239
|
-
*/
|
|
240
|
-
glob(pattern: string, dir?: string, options?: GlobOptions): AsyncIterable<DirEntry>;
|
|
241
|
-
/**
|
|
242
|
-
* Read the whole file. Text files return a string. Image
|
|
243
|
-
* bytes (`jpeg` / `png` / `gif` / `webp`) return a
|
|
244
|
-
* `Uint8Array` so native Read can base64 them into an image
|
|
245
|
-
* content part. Native Read applies `offset` / `limit` and
|
|
246
|
-
* numbers lines on text only.
|
|
247
|
-
*
|
|
248
|
-
* Errors (throw `Error`):
|
|
249
|
-
* - Missing file, or a virtual directory with no file inode:
|
|
250
|
-
* `not found: ${path}`.
|
|
251
|
-
* - Host I/O (EISDIR, EACCES, …): the OS message, or the same
|
|
252
|
-
* `not found: ${path}` fallback.
|
|
253
|
-
* - `unionFs` with no mount: `no mount for path: ${path}`.
|
|
254
|
-
*/
|
|
255
|
-
read(path: string): Promise<string | Uint8Array>;
|
|
256
|
-
/**
|
|
257
|
-
* Content matches. No output-mode or offset. Honor
|
|
258
|
-
* `maxResults` when set. Yields {@link GrepResult} ordered
|
|
259
|
-
* by path, then line number.
|
|
260
|
-
*
|
|
261
|
-
* Errors (throw `Error`):
|
|
262
|
-
* - Invalid `pattern`: `invalid grep pattern: ${pattern}`.
|
|
263
|
-
* - Host search root does not exist: the OS message, or
|
|
264
|
-
* `not found: ${searchRoot}`. Native Grep turns the throw
|
|
265
|
-
* into `{ status: "error" }`.
|
|
266
|
-
*
|
|
267
|
-
* A missing virtual `path` yields nothing (not an error).
|
|
268
|
-
*/
|
|
269
|
-
grep(query: GrepQuery): AsyncIterable<GrepResult>;
|
|
270
|
-
/**
|
|
271
|
-
* Create or overwrite a file. Parents are created as needed.
|
|
272
|
-
* Native Write formats `Wrote contents to ${path}` from the
|
|
273
|
-
* path. The Write tool maps native `fileText` onto `contents`.
|
|
274
|
-
*
|
|
275
|
-
* Errors (throw `Error`):
|
|
276
|
-
* - Host I/O: the OS message, or `write failed: ${path}`.
|
|
277
|
-
* - `unionFs` with no mount: `no mount for path: ${path}`.
|
|
278
|
-
* - A read-only mount may use `read-only mount` or
|
|
279
|
-
* `read-only mount: ${path}`.
|
|
280
|
-
*
|
|
281
|
-
* Missing parents are not an error; create them. There is no
|
|
282
|
-
* `not found` for `write`.
|
|
283
|
-
*/
|
|
284
|
-
write(path: string, contents: string): Promise<void>;
|
|
285
|
-
/**
|
|
286
|
-
* Remove one file. Directories are not deleted; listing them
|
|
287
|
-
* is empty and they have no inode of their own on a virtual
|
|
288
|
-
* tree.
|
|
289
|
-
*
|
|
290
|
-
* Errors (throw `Error`):
|
|
291
|
-
* - Missing file, or a virtual directory: `not found: ${path}`.
|
|
292
|
-
* - Host I/O: the OS message, or `not found: ${path}`.
|
|
293
|
-
* - `unionFs` with no mount: `no mount for path: ${path}`.
|
|
294
|
-
*/
|
|
295
|
-
delete(path: string): Promise<void>;
|
|
296
|
-
}
|
|
297
52
|
export declare const FILE_SYSTEM_TOOL_NAMES: readonly ["Read", "LS", "Glob", "Grep", "Write", "StrReplace", "Delete"];
|
|
298
53
|
export type FileSystemToolName = (typeof FILE_SYSTEM_TOOL_NAMES)[number];
|
|
299
54
|
export declare function canonicalizeFileSystemToolName(name: string): FileSystemToolName | undefined;
|
|
@@ -344,12 +99,12 @@ export declare function fileSystemImage(content: string | Uint8Array, path: stri
|
|
|
344
99
|
mimeType: string;
|
|
345
100
|
bytes: Uint8Array;
|
|
346
101
|
} | undefined;
|
|
347
|
-
export declare function collectGrepMatches(root: FileSystem, query:
|
|
102
|
+
export declare function collectGrepMatches(root: FileSystem, query: FSGrepQuery, opts: {
|
|
348
103
|
outputMode: GrepOutputMode;
|
|
349
104
|
headLimit?: number;
|
|
350
105
|
offset?: number;
|
|
351
|
-
}): Promise<
|
|
352
|
-
export type GrepContentHit =
|
|
106
|
+
}): Promise<FSGrepResult[]>;
|
|
107
|
+
export type GrepContentHit = FSGrepResult & {
|
|
353
108
|
beforeContext?: string[];
|
|
354
109
|
afterContext?: string[];
|
|
355
110
|
};
|
|
@@ -372,29 +127,8 @@ export declare function writeWorkspaceFilesToRoot(root: FileSystem, files: Recor
|
|
|
372
127
|
data: string;
|
|
373
128
|
mimeType?: string;
|
|
374
129
|
}>): Promise<void>;
|
|
375
|
-
/**
|
|
376
|
-
* Exact str-replace as `read` + apply + `write`. Uniqueness is
|
|
377
|
-
* this helper's contract; FileSystem implementations do not
|
|
378
|
-
* implement edit. Native StrReplace calls this.
|
|
379
|
-
*/
|
|
380
|
-
export declare function strReplaceOnFileSystem(root: Pick<FileSystem, "read" | "write">, query: EditQuery): Promise<EditResult>;
|
|
381
130
|
/** Native Read offset/limit: 1-indexed, negative offset counts from the end. */
|
|
382
131
|
export declare function sliceReadContent(content: string, offset?: number, limit?: number): string;
|
|
383
|
-
/**
|
|
384
|
-
* A FileSystem with no files. Use as an overlay leaf or a missing
|
|
385
|
-
* catalog so a miss stays {@link FileNotFoundError} instead of
|
|
386
|
-
* {@link NoMountError}. Writes and deletes throw
|
|
387
|
-
* {@link ReadOnlyMountError} — an empty tree is never a sink.
|
|
388
|
-
*/
|
|
389
|
-
export declare function emptyFs(): FileSystem;
|
|
390
|
-
/**
|
|
391
|
-
* In-memory FileSystem for tests and fixtures. Keys are absolute
|
|
392
|
-
* posix paths (`/a.txt`) and are normalized on ingest. Honors the
|
|
393
|
-
* {@link FileSystem} order and path contracts.
|
|
394
|
-
* Creates `/agent-tools` on first scratch
|
|
395
|
-
* write the same way any other path is created.
|
|
396
|
-
*/
|
|
397
|
-
export declare function tempFs(files?: Record<string, string | Uint8Array>): FileSystem;
|
|
398
132
|
/**
|
|
399
133
|
* Host-disk FileSystem. Relative paths resolve against `cwd`. Absolute
|
|
400
134
|
* paths are used as given, matching Cursor SDK native file tools, unless
|
|
@@ -427,53 +161,6 @@ export declare function sessionFileSystem(options: {
|
|
|
427
161
|
};
|
|
428
162
|
scratch?: FileSystem;
|
|
429
163
|
}): FileSystem;
|
|
430
|
-
/** Forwards reads. `write` and `delete` throw `read-only mount`. */
|
|
431
|
-
export declare function readOnlyFs(inner: FileSystem): FileSystem;
|
|
432
|
-
/**
|
|
433
|
-
* Longest-prefix compose, path-segment match. Every verb is
|
|
434
|
-
* defined. Does not synthesize `shell`. `/agent` is not a
|
|
435
|
-
* prefix of `/agent-tools`.
|
|
436
|
-
*
|
|
437
|
-
* The record keys are mount points. Each child is a FileSystem
|
|
438
|
-
* rooted at `/`. `unionFs` strips the prefix on the way in and
|
|
439
|
-
* re-prefixes yields (and error paths) on the way out:
|
|
440
|
-
* `unionFs({ "/host": hostFs(...) })` — the child never sees
|
|
441
|
-
* `/host`.
|
|
442
|
-
*
|
|
443
|
-
* A path with no mount:
|
|
444
|
-
* - `read` / `write` / `delete`: throw
|
|
445
|
-
* `no mount for path: ${path}`
|
|
446
|
-
* - `list` / `glob` / `grep`: empty iterator
|
|
447
|
-
* - `stat`: `{ kind: "missing" }` (`/`, exact mount prefixes, and
|
|
448
|
-
* their parents are `{ kind: "directory" }`)
|
|
449
|
-
*
|
|
450
|
-
* `list` and `glob` below `/` also yield the files of each mount nested
|
|
451
|
-
* under that directory, as `list` and `glob` of `/` do. A nested glob
|
|
452
|
-
* lists that mount and matches each path against the pattern. `grep`
|
|
453
|
-
* stays on the mount that covers the path.
|
|
454
|
-
*
|
|
455
|
-
* Sources are already sorted longest prefix first. List and glob use
|
|
456
|
-
* `unique` so that earlier source wins a tie.
|
|
457
|
-
*/
|
|
458
|
-
export declare function unionFs(mounts: Record<string, FileSystem>): FileSystem;
|
|
459
|
-
/**
|
|
460
|
-
* Same-root overlay: earlier layers win. Read-only.
|
|
461
|
-
*
|
|
462
|
-
* A downed layer costs its own files, not the overlay. Mutations
|
|
463
|
-
* throw `read-only mount` / `read-only mount: ${path}`. Empty
|
|
464
|
-
* `layers` throws `overlayFs needs at least one layer.`
|
|
465
|
-
*/
|
|
466
|
-
export declare function overlayFs(layers: readonly FileSystem[]): FileSystem;
|
|
467
|
-
/**
|
|
468
|
-
* Writable child view over `parent`. Reads use `overlayFs` order:
|
|
469
|
-
* a private `tempFs` scratch, then `parent`. Writes and deletes land
|
|
470
|
-
* on that scratch. A delete of a parent file is a whiteout, so the
|
|
471
|
-
* child stops seeing it. `parent` is never mutated.
|
|
472
|
-
*
|
|
473
|
-
* FileSystem has no shell. Callers that bind executors to this handle
|
|
474
|
-
* omit shell.
|
|
475
|
-
*/
|
|
476
|
-
export declare function childOverlayFs(parent: FileSystem): FileSystem;
|
|
477
164
|
/**
|
|
478
165
|
* `HostFilesApi` as a FileSystem rooted at `/`.
|
|
479
166
|
*
|
package/dist/filesystem.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"filesystem.d.ts","sourceRoot":"","sources":["../src/filesystem.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"filesystem.d.ts","sourceRoot":"","sources":["../src/filesystem.ts"],"names":[],"mappings":"AAaA,OAAO,EAGL,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,YAAY,EAIjB,KAAK,QAAQ,EAId,MAAM,aAAa,CAAC;AASrB,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE/D,YAAY,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,WAAW,IAAI,SAAS,EACxB,YAAY,IAAI,UAAU,EAC1B,WAAW,IAAI,SAAS,EACxB,YAAY,IAAI,UAAU,EAC1B,WAAW,EACX,WAAW,GACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,SAAS,EACT,OAAO,EACP,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EACzB,YAAY,EACZ,SAAS,EACT,SAAS,EACT,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,sBAAsB,EACtB,MAAM,EACN,OAAO,EACP,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC/B;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAEpD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE;QACN,OAAO,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,IAAI,EAAE,MAAM,CAAC;YACb,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;YACzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;SACzB,CAAC,CAAC;QACH,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,GACD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC7D;IACE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,MAAM,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC/C,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEN,eAAO,MAAM,sBAAsB,YACjC,MAAM,EACN,IAAI,EACJ,MAAM,EACN,MAAM,EACN,OAAO,EACP,YAAY,EACZ,QAAQ,CACA,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAqBzE,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAE3F;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,kBAAkB,CAE7E;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED,iFAAiF;AACjF,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG9D;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,UAAU,GAAG,OAAO,CAE7F;AAYD,wBAAgB,mBAAmB,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,kBAAkB,EAAE,CAE5E;AAiCD,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAoBD,oEAAoE;AACpE,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG7D;AAED,wBAAgB,8BAA8B,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAW9E;AAED,wBAAgB,2BAA2B,CAAC,KAAK,CAAC,EAAE,SAAS,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAuBnF;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE;IAC9C,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC7B,GAAG,QAAQ,EAAE,CAmBb;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAEnE;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,QAAQ,EAQhD,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,CAAC,EAAE,SAAS,QAAQ,EAAE,GAAG;IAC1E,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC9B,CAWA;AAOD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,oBAAoB,GAAG,OAAO,CAAC;AAExE,6DAA6D;AAC7D,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAEnE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CA8C5F;AAED,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,GAAG,UAAU,EAC5B,IAAI,EAAE,MAAM,GACX;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GAAG,SAAS,CASrD;AA0ED,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE;IAAE,UAAU,EAAE,cAAc,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE,OAAO,CAAC,YAAY,EAAE,CAAC,CA6CzB;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG;IAC1C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,wBAAgB,cAAc,CAC5B,OAAO,EAAE,cAAc,EAAE,EACzB,UAAU,EAAE,cAAc,GACzB,eAAe,CA+BjB;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAWrD;AAED,iFAAiF;AACjF,wBAAgB,oBAAoB,CAAC,IAAI,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAOpF;AAiCD;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAuBtE;AAED,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GACtF,OAAO,CAAC,IAAI,CAAC,CAwBf;AAED,gFAAgF;AAChF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAYzF;AAwJD;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC,GAAG,UAAU,CAkIb;AAMD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE;IACzC,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,UAAU,CAAA;KAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB,GAAG,UAAU,CAqBb;AAeD;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,GAAG,UAAU,CA6J7E"}
|