vercel-ai-cursor-provider
v0.1.0
Published
Vercel AI SDK provider for Cursor (using cursor-agent)
Maintainers
Readme
vercel-ai-cursor-provider
A Vercel AI SDK custom provider for Cursor, leveraging the cursor-agent CLI.
Features
- Use any model supported by your Cursor subscription (Claude 3.5 Sonnet, GPT-4o, etc.)
- Supports streaming via
streamText - References logic from
opencode-cursorfor robust Prompt building
Prerequisites
- Cursor installed on your machine.
cursor-agentCLI available in your PATH.- You can usually install it via:
curl -fsS https://cursor.com/install | bash
- You can usually install it via:
- You must be logged into
cursor-agent:cursor-agent login
Installation
npm install vercel-ai-cursor-provider @ai-sdk/provider aiUsage
import { streamText } from 'ai';
import { createCursor } from 'vercel-ai-cursor-provider';
// Create the provider
const cursor = createCursor({
workspace: process.cwd(), // Optional: project workspace for cursor-agent context
});
// Use it with Vercel AI SDK
const { textStream } = await streamText({
model: cursor('claude-3.5-sonnet'),
prompt: 'Write a TypeScript function to calculate fibonacci numbers.',
});
for await (const text of textStream) {
process.stdout.write(text);
}Configuration
createCursor accepts an optional options object:
| Option | Type | Description |
| --- | --- | --- |
| command | string | Path to cursor-agent binary. Defaults to cursor-agent. |
| workspace | string | The directory cursor-agent should treat as the project workspace. |
Credits
Inspired by the opencode-cursor project by Nomadcxx.
License
MIT
