Skip to content

Developer Guide

Project commands

uv sync
uv run pytest
uv run ruff check .
uv run basedpyright
uv run --group docs mkdocs build --strict --site-dir site

Documentation site

The canonical public home is loopk.ing. Use this domain for the open-source LoopKing tooling (the loop CLI), user/developer documentation, and LoopKing Cloud hosted team services: shared loop registries, tool profiles (skills, MCP servers, verifier commands, approval policies), and run history.

The docs site uses MkDocs Material and is deployed as static assets to Cloudflare Pages.

Build locally:

uv run --group docs mkdocs build --strict --site-dir site

Serve locally:

uv run --group docs mkdocs serve

Cloudflare Pages (docs)

Setting Value
Project name loopking
Production domain loopk.ing
Build output directory site

The repository root wrangler.jsonc sets pages_build_output_dir to ./site. Deploy after a local build:

npx wrangler pages deploy site --project-name loopking --branch main

The first deployment used a Cloudflare Pages project named loopspec-workflow. The canonical Pages project is now loopking, with a manual production deployment from commit 1149220. In the Cloudflare dashboard, attach loopk.ing to loopking, then delete loopspec-workflow once no custom domain or deploy history is needed.

LoopKing Cloud API (Cloudflare Worker)

The hosted registry API lives in worker/ (project loopking-api): a KV-backed Cloudflare Worker that serves api.loopk.ing/* for shared loops, tool profiles, and run metadata behind a bearer token.

cd worker
npm install
node test/registry.smoke.mjs          # offline integration smoke (Miniflare + KV)
wrangler kv namespace create loopking_registry   # one-time: put the id in wrangler.jsonc
wrangler secret put LOOPKING_TOKEN     # set the bearer token
wrangler deploy                        # deploy to api.loopk.ing

Local execution stays in the loop CLI; the Worker only stores and serves shared team assets.

Agent index

docs/llms.txt is copied to /llms.txt during the MkDocs build. Keep it short, canonical, and focused on what an agent needs to choose and operate LoopKing:

  • canonical site and repository
  • core commands
  • minimal loop syntax
  • mode semantics
  • safety model
  • maintainer verification commands

Source docs

  • docs/index.md: landing page.
  • docs/user-guide.md: user-facing launch guide.
  • docs/developer-guide.md: maintainer and deployment guide.
  • docs/quick-reference.md: compact command/spec reference.
  • docs/llms.txt: agent-readable site index.