Skip to content
Arka Platform

Reference — arka-deck

Audience: developer looking for a precise piece of information: route name, environment variable, CLI option, CI gate.

Contents

Section titled “Contents”
  • api-http.md — every HTTP route exposed by the Fastify server, grouped by functional domain (workspaces, projects, chat, memory, governance, etc.)
  • cli.md — arka-deck command and npm run arka:start|stop|reboot wrappers, flags, signals, priority order
  • variables-env.md — every ARKA_DECK_* environment variable and its scope
  • scripts-ci.md — each scripts/*.mjs and scripts/*.sh; role, trigger, expected output
  • projets-workspaces.md — projects/workspaces data model, disk marker, index, allowlist

How to read the reference

Section titled “How to read the reference”
  • The reference is not a guide. It does not tell you how to do something; it states what exists.
  • To learn how to use a route or a command, see extension/ or workflow/.
  • Numbers quoted (route count, port count, etc.) are verified at each update of this doc — if you find a discrepancy, it is a bug to report.

Documentation status

Section titled “Documentation status”

The skeleton is in place. projets-workspaces.md is migrated from docs/dev/projects-workspaces-guide.md during lot P3. Other files are written during lot P4 from the source code.