Developer Hubcreate-eclips-app

CLI Scaffold

One command writes a starter project that already uses @eclips/sdk to call eClips Workforce. It needs Node.js 18 or newer.

The CLI isn't on the public npm registry yet. Ask us for access.

Create a project

bash

npx create-eclips-app

The CLI asks three questions, then writes the project into a new folder:

text

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

Templates

express-apiExpress 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-dashboardNext.js Dashboard

A small Next.js page that lists run history. A starting point for an internal screen your team can watch.

agent-onlyAgent Only

One TypeScript script that creates a client and runs an agent, with no server. The quickest way to test your API 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

SDK documentation REST API reference