Developer Manual

CLI

create-eclips-app scaffolds a production-ready project wired to @eclips/sdk in one command. No global install is needed — it runs through npx and requires Node.js 18 or newer.

Create a project

Run the scaffolder with a project name. The CLI prompts for a template interactively:

bash

npx create-eclips-app my-app

Or skip the prompt and pass a template directly:

bash

# Non-interactive: pass a template directly
npx create-eclips-app my-app --template agent-only

# Templates: express-api | nextjs-dashboard | agent-only

Templates

Three templates ship with the scaffolder, each wired to the API key via .env.example:

•
express-api
An Express server with an HMAC-verified webhook endpoint and a sample route that calls the SDK — best when eClips needs to push events into your backend.
•
nextjs-dashboard
An App Router page that lists runs with live polling — a starter internal ops console your team can watch.
•
agent-only
A single TypeScript file that creates a client and runs an agent run — the fastest way to test your key.

Next steps

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

bash

cd my-app
cp .env.example .env.local   # add your ECLIPS_API_KEY
npm install
npm run dev

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

← PreviousTypeScript SDK Next →Webhooks