Developer Manual

CLI

create-eclips-app writes a starter project that already uses @eclips/sdk. It runs through npx and needs Node.js 18 or newer.

Create a project

Run the CLI. It asks three questions and then writes the project into a new folder:

bash

npx create-eclips-app

text

? Project name            my-eclips-app
? Choose a template       express-api | nextjs-dashboard | agent-only
? eClips API key          optional, press Enter to skip

Note:The CLI is not on the public npm registry yet. Ask us for access.

Templates

There are three templates. Each reads the API key from .env:

•
express-api
An Express server with a /run endpoint that calls the SDK. Use it when another system needs to start agent runs through your backend.
•
nextjs-dashboard
A small Next.js page that lists run history. A starting point for an internal screen your team can watch.
•
agent-only
One TypeScript script that creates a client and starts an agent run, with no server. The quickest way to test your key.

Next steps

Each template includes a .env.example. Add your key and run:

bash

cd my-eclips-app
npm install
cp .env.example .env   # then add your API key (skipped if you gave one)
npm run dev

Tip:Create a key in the dashboard under Settings → API Keys, then put the eck_live_… value in .env as ECLIPS_API_KEY. See Authentication.

← PreviousTypeScript SDK Next →Webhooks