Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (40 loc) · 2.34 KB

AGENTS.md

File metadata and controls

49 lines (40 loc) · 2.34 KB

AGENTS.md — DemoIt

Go CLI tool for live-coding presentations. Serves an HTML slide deck with web terminals, syntax-highlighted code, QR codes, and live reload. Slides defined in demoit.html separated by ---.

Commands

go install                                # build and install
go build -o demoit                        # build locally
./demoit                                  # run on http://localhost:8888
./demoit -dev                             # live reload mode
./demoit -port 9000 -host 0.0.0.0        # custom bind
golangci-lint run                         # lint (or: task lint)
task lint                                 # lint via Taskfile
task format                               # format code
docker buildx bake                        # cross-compile (darwin/linux, amd64/arm64)
# No tests exist in this project.

Architecture

main.go            CLI flags, gorilla/mux router, starts web server
├── files/         File I/O helpers rooted at configurable Root path
├── flags/         Global CLI flag variables
├── handlers/      HTTP handlers (all routes)
│   ├── step.go        Slide parsing/rendering; VerifyConfiguration() validates setup
│   ├── code.go        Syntax-highlighted source viewer (chroma)
│   ├── shell.go       Terminal page (ghostty-web) + WebSocket PTY bridge
│   ├── static.go      Static files from .demoit/
│   ├── ping.go        HTTP HEAD proxy
│   ├── qrcode.go      QR code generation
│   ├── grid.go        Grid view of all slides
│   └── resources/     Embedded HTML templates (//go:embed)
├── livereload/    WebSocket live reload (LiveReload protocol)
├── shell/         WebSocket PTY server using creack/pty

Code Conventions

  • Go 1.26. Dependencies vendored (go mod vendor after changes).
  • Templates embedded via //go:embed. Global state: files.Root, flags.*.
  • Error handling: http.Error() in handlers, log.Fatal() at startup, fmt.Errorf("…: %w", err) for wrapping.
  • Standard Go naming; no interfaces or DI.

Important Notes

  • Web terminal uses ghostty-web (PR #136) with a Go WebSocket PTY backend.
  • Presentations need demoit.html + .demoit/ dir (with style.css, js/demoit.js; optional: .bashrc, .bash_history, fonts/, images/).