Skip to content

Docs alignment + offline demo (v0.14.1) - #15

Merged
scr1p7k177y merged 1 commit into
mainfrom
docs/sample-usage-and-offline-demo
Jun 29, 2026
Merged

scr1p7k177y merged 1 commit into
mainfrom
docs/sample-usage-and-offline-demo

Conversation

@scr1p7k177y

Copy link
Copy Markdown
Member

Docs alignment + a runnable offline demo (v0.14.1)

Makes the project easy to try and reads like a human wrote it.

Added

  • examples/demo.mjs — an offline, end-to-end walkthrough. It spawns the real
    server with the built-in mock provider (CEAUTO_MOCK_LLM=1) and drives
    boot -> delegate -> heartbeat cycle -> metrics -> insights over MCP, with no API
    key and zero spend. State lands in a throwaway workspace (CEAUTO_WORKSPACE),
    never in the repo.

Changed

  • README rewritten in a plainer voice: a "Try it locally (no API key)"
    quickstart, a "Sample usage" section (natural-language requests mapped to tool
    calls, plus a raw ceo_delegate call), an accurate repo layout, and em-dashes
    removed from the prose I touched.
  • eslint flat config now lints **/*.mjs, so the example is covered.
  • .gitignore ignores .demo-workspace/ (the demo's default path).
  • Version bumped to 0.14.1 (package.json, lock, server.js, README badge,
    CHANGELOG dated entry).

Verified

  • node examples/demo.mjs ./.demo-workspace runs clean end-to-end: 19 tools, one
    cycle executes the queued task (ran 1, done 1), metrics show Done 1 / $0 spend
    / self-eval 4/5, and the workspace gets tasks/done.md + reports/tasks/*.md.
  • Dashboard validated against the same workspace (HTTP 200 on 127.0.0.1:8788).
  • npm run lint, npm test (199 pass), npm ci all green on Node 20 (the CI jobs).
  • Manual code review: added a try/finally so the demo always closes the client,
    guarded against a connect-failure masking the real error.

examples/demo.mjs drives the server end-to-end over MCP with the mock provider
(no key, zero spend). README rewritten with a local-test quickstart and a
sample-usage section; eslint now covers .mjs.
@scr1p7k177y
scr1p7k177y merged commit e653378 into main Jun 29, 2026
2 checks passed
@scr1p7k177y
scr1p7k177y deleted the docs/sample-usage-and-offline-demo branch June 29, 2026 14:54
scr1p7k177y added a commit that referenced this pull request Oct 4, 2026
…e-demo

Docs alignment + offline demo (v0.14.1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant