cursor-sdk
Map of Content for the Cursor TypeScript SDK. Start here, then follow [[wikilinks]] to the atomic concept you need. Sibling skills (cursor-runs, cursor-cloud, cursor-mcp, cursor-subagents, cursor-models, cursor-hooks, cursor-errors) are part of the same graph — link across with [[../cursor-runs/references/stream]].
When to use
- Bootstrapping any program that imports
@cursor/sdk
- Choosing between local execution, cloud execution, or pool/machine envs
- Standing up durable agent IDs that survive process restarts
- Resuming an existing agent rather than creating a new one
Install & auth
- [[references/install]] —
npm install @cursor/sdk, Node 20+, CURSOR_API_KEY
- [[references/authentication]] — env var, explicit
apiKey, service account keys, Team Admin caveat
- [[references/account]] —
Cursor.me(), Cursor.repositories.list()
Lifecycle
- [[references/agent-create]] —
Agent.create(options) full option surface
- [[references/agent-resume]] —
Agent.resume(agentId, partialOptions) and what is not persisted
- [[references/agent-prompt]] —
Agent.prompt(message, options) one-shot helper
- [[references/agent-management]] —
Agent.list, Agent.get, Agent.archive, Agent.unarchive, Agent.delete
- [[references/disposal]] —
await using, Symbol.asyncDispose, agent.close()
Local vs cloud
- [[references/local-options]] —
local.cwd, settingSources, sandboxOptions
- [[../cursor-cloud/SKILL]] — cloud runtime, repos, PR auto, artifacts
Where to go next
- Streaming and run control → [[../cursor-runs/SKILL]]
- Adding tools via MCP → [[../cursor-mcp/SKILL]]
- Picking and tuning models → [[../cursor-models/SKILL]]
- Delegated subagents → [[../cursor-subagents/SKILL]]
- Hook-based governance → [[../cursor-hooks/SKILL]]
- Project rules and AGENTS.md → [[../cursor-rules/SKILL]]
- Project skill packs → [[../cursor-skills-system/SKILL]]
- Shell / CI alternative → [[../cursor-cli/SKILL]]
- Error handling and retries → [[../cursor-errors/SKILL]]
1---2name: cursor-sdk3description: Entry point for the Cursor TypeScript SDK — install, auth, and the Agent.create / Agent.resume / Agent.prompt lifecycle. Use when starting any Cursor SDK integration or wiring durable agent IDs.4---56# cursor-sdk78Map of Content for the Cursor TypeScript SDK. Start here, then follow `[[wikilinks]]` to the atomic concept you need. Sibling skills (`cursor-runs`, `cursor-cloud`, `cursor-mcp`, `cursor-subagents`, `cursor-models`, `cursor-hooks`, `cursor-errors`) are part of the same graph — link across with `[[../cursor-runs/references/stream]]`.910## When to use1112- Bootstrapping any program that imports `@cursor/sdk`13- Choosing between local execution, cloud execution, or pool/machine envs14- Standing up durable agent IDs that survive process restarts15- Resuming an existing agent rather than creating a new one1617## Install & auth1819- [[references/install]] — `npm install @cursor/sdk`, Node 20+, `CURSOR_API_KEY`20- [[references/authentication]] — env var, explicit `apiKey`, service account keys, Team Admin caveat21- [[references/account]] — `Cursor.me()`, `Cursor.repositories.list()`2223## Lifecycle2425- [[references/agent-create]] — `Agent.create(options)` full option surface26- [[references/agent-resume]] — `Agent.resume(agentId, partialOptions)` and what is *not* persisted27- [[references/agent-prompt]] — `Agent.prompt(message, options)` one-shot helper28- [[references/agent-management]] — `Agent.list`, `Agent.get`, `Agent.archive`, `Agent.unarchive`, `Agent.delete`29- [[references/disposal]] — `await using`, `Symbol.asyncDispose`, `agent.close()`3031## Local vs cloud3233- [[references/local-options]] — `local.cwd`, `settingSources`, `sandboxOptions`34- [[../cursor-cloud/SKILL]] — cloud runtime, repos, PR auto, artifacts3536## Where to go next3738- Streaming and run control → [[../cursor-runs/SKILL]]39- Adding tools via MCP → [[../cursor-mcp/SKILL]]40- Picking and tuning models → [[../cursor-models/SKILL]]41- Delegated subagents → [[../cursor-subagents/SKILL]]42- Hook-based governance → [[../cursor-hooks/SKILL]]43- Project rules and AGENTS.md → [[../cursor-rules/SKILL]]44- Project skill packs → [[../cursor-skills-system/SKILL]]45- Shell / CI alternative → [[../cursor-cli/SKILL]]46- Error handling and retries → [[../cursor-errors/SKILL]]
HKTITAN