Files
dawnline/AGENTS.md
T
Aemeath 29b1d7dfd7
Build packages / Version (push) Waiting to run
Dawnline 0.4.2
- Connections show up at once: the agent looks at the tunnels every
  second and, the moment a device connects or roams, writes it to the
  activity log, updates traffic and the map, and locates the new address
- A device counts as gone when its WireGuard session expires (1-3 min
  after it leaves), so a phone asleep no longer flaps between
  disconnect and connect
- The admin pages follow along within seconds: Overview, People, the
  person page and the device panel refresh when something happens, with
  a light check every 2 s instead of reloading everything every 10 s
- The personal portal no longer refreshes itself in the background:
  every request costs the router a CGI process, so it loads once and
  after the visitor's own changes
- Agent guidance and code standards (backend, frontend, shell, UI) now
  live in the repository: AGENTS.md and rules/
2026-10-16 03:52:21 +03:00

3.2 KiB

AGENTS.md — Dawnline

Guidance for coding agents working in this repository (tickcount/luci-app-dawnline): an AmneziaWG access server for OpenWrt with a LuCI admin UI and a personal portal. CLAUDE.md points here.

Rules

  • rules/code-standards.md — how all code is written: decomposition, one locked writer, fail closed, validation at the boundary, comments and commits.
  • rules/backend.md — ucode on the router: module layers, conventions, what things cost there (CGI portal, rpcd, the agent's watcher).
  • rules/frontend.md — TypeScript admin UI and portal: layout of web/src, pollers and the live revision.
  • rules/shell.md — install, uninstall, init and CI scripts.
  • rules/ui-design.md — how the admin UI and the portal look: modern product quality, mock first from the real CSS and components, verified in the browser.

This repo usually sits inside the router-admin workspace (../AGENTS.md). Its rules apply to anything that touches the router: read-only first, backup before mutating, router shell as a literal stdin heredoc over SSH (../rules/).

Layout

  • package/luci-app-dawnline/root/ — what lands on the router: ucode modules in usr/share/ucode/dawnline/ (rpc/ for the LuCI backend), the agent and updater in usr/libexec/dawnline/, the portal in usr/share/dawnline/portal/, the init script, rpcd ACL.
  • web/ — TypeScript sources of the admin UI (src/admin) and the portal (src/portal), shared code in src/shared; the built bundles are committed under package/.
  • install.sh, uninstall.sh — the standalone installer and uninstaller (both have --dry-run).
  • scripts/ — lint-ucode.py, check-ucode.sh (compiles every module on the router without installing), deploy.sh (dev deploy over SSH), build-packages.sh, build-release.sh, release-notes.sh.

Checks before a commit or deploy

  • python3 scripts/lint-ucode.py and scripts/check-ucode.sh (needs the router); new ucode entry points are added to the compile list there and to the executables list in .github/workflows/ci.yml.
  • In web/: npm run format:check, npm run typecheck, npm test, npm run build — and commit the rebuilt bundles.
  • shellcheck -S warning for the shell scripts (CI runs it).

Releases

  • A release is one commit on main titled Dawnline X.Y.Z; its body is - points, which become the GitHub release notes and the Components "What's new". Work from a branch is squashed into that one commit.
  • Bump the version in package/luci-app-dawnline/Makefile (PKG_VERSION), util.uc (VERSION), web/package.json and web/package-lock.json (CI checks they agree).
  • No Co-Authored-By or other agent attribution in commits.
  • Push main, then an annotated tag vX.Y.Z ("Dawnline X.Y.Z"); the "Build packages" workflow publishes the .ipk, .apk and sha256sums.txt.
  • Re-cutting a release (fixes before anyone installs) rewrites main: force-push, gh release delete vX.Y.Z --cleanup-tag, cancel a running build of the old tag, tag again. Only with the user's go-ahead.
  • On the router, install a release the way Components does: /usr/libexec/dawnline/updater install app@vX.Y.Z (verified against the release's sha256).