Overview Docs
All notes
Notes / Development

Development

Layout

  • cmd/overview — entry point: server, static export, and the CLI commands
  • internal/ — layered Go packages (see Architecture)
  • web/ — Vue 3 + Vite frontend, built into internal/webui/dist and embedded
  • site/notes/ — the notes that generate this documentation site
  • demo/ — a sample vault used by make demo

Common tasks

make demo     # sample vault on :5230
make dev      # backend with the embedded frontend
make build    # frontend + single binary
make docker   # Docker image

make test     # all tests (Go + frontend)
make test-go  # go test ./...
make test-web # vue-tsc + Vitest
make lint     # golangci-lint + vue-tsc
make fmt      # gofmt + prettier

Tests

  • Go: go test ./... — per-package unit tests plus httptest integration tests.
  • Frontend: npm test (Vitest) for pure logic; npm run lint for type-checking.
  • Lint: golangci-lint run (v2.14) and vue-tsc.

CLI

cmd/overview dispatches to internal/cli, which reuses the service layer offline:

go run ./cmd/overview list
go run ./cmd/overview build ./_site --all

See CLI for the full command list and MCP and AI for the agent interface.

Logging

Overview writes structured JSON (or text) logs to stdout. Set OVERVIEW_LOG_FILE to also write to a size-rotated file:

OVERVIEW_LOG_FILE=./data/logs/overview.log OVERVIEW_LOG_FORMAT=text ./bin/overview

See Deployment for the full environment-variable list.

Contributing

See CONTRIBUTING.md.