Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kentcdodds/cursor

src/index.ts

54 lines · 1.7 KB · TypeScript
import * as agents from './agents.ts'
import * as artifacts from './artifacts.ts'
import * as me from './me.ts'
import * as models from './models.ts'
import * as repositories from './repositories.ts'
import * as request from './request.ts'
import * as runs from './runs.ts'
import * as workers from './workers.ts'

export {
	agents,
	artifacts,
	me,
	models,
	repositories,
	request,
	runs,
	workers,
}

/** Describe the @kentcdodds/cursor SDK domains, exports, and required secrets. */
export default async function describeCursorPackage() {
	return {
		packageId: 'cursor',
		name: '@kentcdodds/cursor',
		docs: [
			'https://cursor.com/docs/api',
			'https://cursor.com/docs/background-agent/api/endpoints',
		],
		version: '2.0.0',
		transport: 'compact cursorRequestRaw helper (Bearer {{secret:cursorApiKey}})',
		auth: {
			required: ['cursorApiKey'],
			optional: ['githubPersonalAccessToken'],
			note: 'Save the raw API key from cursor.com/dashboard → API Keys (not an Authorization header). Cursor accepts Basic or Bearer; this package uses Bearer.',
		},
		domains: {
			'.': 'Package overview (this export)',
			'./request': 'Raw api.cursor.com escape hatch',
			'./agents':
				'createAgent, listAgents, getAgent, archive/unarchive/delete, composites',
			'./runs':
				'createRun, listRuns, getRun, cancelRun, getAgentUsage, readRunStream',
			'./artifacts': 'listArtifacts, downloadArtifact',
			'./workers':
				'listWorkers, getFleetSummary, getWorker, listPendingPoolRequests, createWorkerToken',
			'./models': 'listModels',
			'./repositories': 'listRepositories',
			'./me': 'apiKeyInfo',
		},
		enterpriseNote:
			'Enterprise-only Admin, Analytics, AI-Code-Tracking, and Bugbot APIs are not wrapped — use ./request.',
	}
}