nntrivi2001
61cc37ba32
The repo shipped five install/publish surfaces that nothing in the project builds, tests or documents as supported any more. Each one carried its own stale docs, and the Docker/Podman path additionally described a Dockerfile whose COPY of statusline/ would have broken the build the moment that directory went away. Removed: vscode-extension/ (16 files, marketplace extension for an ID we do not own); statusline/ (3 files, standalone CLI statusline); the repo-root landing/wiki PWA assets (sw.js, manifest.json, robots.txt, sitemap.xml, og-image.svg, favicon.svg, fonts/ - 17 files for pages that no longer exist); .superpowers/ (4 files of scratch brainstorm state, already covered by .gitignore:55); and the container publish path (Dockerfile, docker-compose.yml, .dockerignore, 5 Makefile targets, 2 npm scripts). Kept deliberately - these are about the USER's containers, not ours: scripts/install-hooks.js container detection and AGENTHUB_ALLOW_CONTAINER_HOOKS (issue #193), server/lib/lane-detect.js docker-compose service detection, server/data/profile-templates/postgres-compose/, server/lib/stage-detect.js 'docker push' detection, the host.docker.internal Prometheus notes, the Config Explorer's reads of the user's own ~/.claude/statusline.py, and .devcontainer/ (its docker-in-docker feature is dropped since it existed only to build the removed Dockerfile). Docs follow the code: ARCHITECTURE.md loses the VS Code, statusline and container sections plus two dead TOC anchors, and its PWA section is rewritten from three PWAs to one; INSTALL.md, SETUP.md, docs/DEPLOYMENT.md, server/README.md, client/README.md, docs/README.md, docs/HOOKS.md and docs/DATABASE.md drop the same. The Makefile target count in ARCHITECTURE.md is corrected 25 -> 17 (it was already stale).
69 lines
2.8 KiB
Markdown
69 lines
2.8 KiB
Markdown
# Dev Container (optional)
|
|
|
|
A ready-to-use, **opt-in** development environment for AgentHub.
|
|
It is used **only** when you explicitly choose it — it changes nothing about
|
|
host-based development (`npm run dev` / `npm start` still work exactly as before).
|
|
|
|
## When to use it
|
|
|
|
Use it if you want a consistent, batteries-included toolchain without installing
|
|
Node, build tools, or Python on your machine — or if you're on a GitHub Codespace.
|
|
|
|
## How to open it
|
|
|
|
- **VS Code:** install the *Dev Containers* extension, then run
|
|
**"Dev Containers: Reopen in Container"** (Command Palette).
|
|
- **GitHub Codespaces:** *Code → Create codespace on this branch*.
|
|
|
|
The first build runs `.devcontainer/post-create.sh`, which installs all workspace
|
|
dependencies (`npm run setup`).
|
|
|
|
## What's inside
|
|
|
|
| Component | Detail |
|
|
| ---------------- | ------------------------------------------------------------------- |
|
|
| Base image | `mcr.microsoft.com/devcontainers/javascript-node:22` |
|
|
| Native toolchain | `build-essential` + `python3` so `better-sqlite3` compiles |
|
|
| Python | `python3` / `python` for `scripts/expand-ts-module-docs.py` |
|
|
| sqlite3 CLI | inspect the dashboard DB during development |
|
|
| Features | GitHub CLI |
|
|
| Forwarded ports | `4820` (server API + WebSocket), `5173` (Vite client) |
|
|
| Editor | ESLint + Prettier (format on save), Vitest, YAML, Tailwind |
|
|
|
|
## Everyday commands
|
|
|
|
```bash
|
|
npm run dev # server on :4820 + Vite client on :5173
|
|
npm start # production-style server (serves client/dist)
|
|
npm run test:server # node --test
|
|
npm run test:client # vitest
|
|
npm run openapi:yaml # regenerate openapi.yaml from the live spec
|
|
```
|
|
|
|
## Claude Code hooks are HOST-side (important — issue #193)
|
|
|
|
Claude Code runs on your **host**, so its hooks must point at a handler path that
|
|
exists on the host. This container therefore:
|
|
|
|
- does **not** bind-mount `~/.claude`, and
|
|
- does **not** install hooks — `scripts/install-hooks.js` **refuses to run inside
|
|
a container** (it would write a container-internal handler path into your host
|
|
settings and break every host hook with `MODULE_NOT_FOUND`).
|
|
|
|
Install hooks **on your host** instead:
|
|
|
|
```bash
|
|
npm run install-hooks # on the HOST
|
|
```
|
|
|
|
The host hook handler POSTs to `http://localhost:4820`, which this container
|
|
forwards — so a host-installed hook reaches the containerized dashboard.
|
|
|
|
> Escape hatch: if you genuinely run Claude Code *inside* this same container,
|
|
> set `AGENTHUB_ALLOW_CONTAINER_HOOKS=1` before `npm run install-hooks`.
|
|
|
|
## Not supported in the container
|
|
|
|
Electron desktop builds (`npm run desktop:*`) need a host with a display and are
|
|
host-only.
|