levelup-visual

Local-first visual documentation for humans and AI agents: a canvas UI, a repo-backed .levelup store, a small HTTP API, and a levelup CLI.

Install and run

One command, in any repo:

npx levelup-visual

This auto-creates .levelup/ in your current directory and starts the canvas + API on http://127.0.0.1:4310. Open that URL in your browser.

If you'd rather install it as a dev dependency:

npm install -D levelup-visual
npx levelup

The CLI still exposes init, dev, and docs <list|read|write> for explicit control. levelup with no arguments is equivalent to levelup dev.

The unscoped npm name levelup is already taken by an existing LevelDB wrapper, which is why this project publishes as levelup-visual (the command-line binary is still levelup).

Why not npm install levelup?

levelup on npm is an existing package (LevelDB wrapper). To install this product under another name, use a scoped package you control (for example @your-org/levelup) and set the "name" field accordingly before publishing.

Publish (maintainers)

From the monorepo root:

npm install
npm run build --workspace levelup-visual
npm publish --workspace levelup-visual --access public

prepublishOnly runs a full build (Vite UI into static/ + TypeScript dist/).

API

See the root README.md for endpoints and agent workflow.