Get started

Use this guide to quickly install, configure, and run a simple agent using the @cursor-ai/january package.

⚠️ Please don’t rely on this for production use-cases, as it may change!

Prerequisites

Installation

npm i @cursor-ai/january

Configure environment

Set your API key in the environment before running examples or tests.

export CURSOR_API_KEY="your_api_key"
$env:CURSOR_API_KEY="your_api_key"

Example

You can use this example project to see how it works.

test-january.zip