Quickstart

Create your first Ekanos integration and run it in the local dev harness.

Next steps

Learn the structure — Read How integrations are structured
Build a widget — See Widgets for the Widget compound API
Call an API — Use ctx.fetch in handlers to reach your provider’s API
Add OAuth — See OAuth
Fix errors — Check Common errors

Common issues

ERR_PNPM_IGNORED_BUILDS on ekanos dev or ekanos test — The project has no pnpm-workspace.yaml approving esbuild’s build script (projects scaffolded before CLI 0.3.3). Create pnpm-workspace.yaml containing allowBuilds: { esbuild: true } (or add that key to the existing file), then run pnpm install again.

ekanos dev fails its precondition check — Run pnpm install after scaffolding. The harness needs the scaffolded devDependencies (@ekanos/harness, next, tailwindcss, @tailwindcss/postcss) installed.

The CLI is behind — Update the global binary with npm i -g @ekanos/cli@latest. Run ekanos upgrade --check to compare current and target versions (read-only), then ekanos upgrade to move the project’s toolchain, verifying and rolling back automatically on failure. On 0.x semver ^0.3.0 excludes 0.4.0, so a project scaffolded by an older CLI needs ekanos upgrade to reach @ekanos/sdk, @ekanos/ui and @ekanos/harness 0.4.0.

Commands reference

Command	What it does
`ekanos init --slug <name>`	Scaffold a new integration
`ekanos dev --start`	Start the dev harness (port 3100 by default)
`ekanos validate`	Check your integration for errors
`ekanos test`	Run your project’s test script
`ekanos login --host <url>`	Authenticate for publishing
`ekanos publish`	Validate, pack, and submit your integration
`ekanos status`	Show login state and this project’s submissions

See the CLI docs for the full command reference.

Get started

Concepts

Troubleshooting

Quickstart

Quickstart

Next steps

Common issues

Commands reference

​Quickstart

​Next steps

​Common issues

​Commands reference

Quickstart

Next steps

Common issues

Commands reference