← HomeGitHub

Commands

Nine commands. You'll mostly use two.

beacon init

Guided setup. Asks only for the essentials — provider and API key — and defaults the rest; voice and language are one optional step. Picking Ollama auto-detects the running daemon and lists your pulled models. Installs the post-commit hook, and drafts from your latest commit before setup even finishes.

beacon init

beacon install

Installs the post-commit hook in the current repo — for repos you add after init.

cd your-repo
beacon install

beacon draft

Manual draft from the latest commit — or a digest across many.

beacon draft                        # latest commit
beacon draft --message "shipped v2" # from freeform text
beacon draft --file notes.md        # from a file
beacon draft --today                # digest of today
beacon draft --week                 # "here's what I shipped"
beacon draft --since "3 days ago"   # anything git log --since accepts

beacon review

Interactive queue in the terminal. Shows the significance score and every drafted platform for each entry.

  • approve — copies the draft to your clipboard
  • edit — opens $EDITOR on plain text, validated on save
  • discard — removes it from the queue
  • skip — leaves it for later

beacon ui

The same review queue, in your browser. Platform drafts side by side, inline editing, copy to clipboard — and live updates: commit in another terminal and the draft appears in the open tab.

beacon ui

beacon ui: inline-editing a tweet thread, a new commit's draft arriving live, then copy and approve

The page is served from 127.0.0.1 only and every data request carries a per-session token, so nothing on the network — and no other website in your browser — can reach your drafts. The terminal and the browser share one queue; approve in either.

beacon serve

The local API behind beacon ui, headless. Prints the routes and the session token — for scripting the queue or building your own client.

beacon serve
beacon serve --port 4000   # default is 2322

beacon config set

Set any config key. See Configuration for the full list.

beacon config set significance-threshold 5
beacon config set platform reddit on

beacon config show

The effective config as an aligned key/value view — including which API key is in effect and whether an env var is overriding the stored one. --json prints the raw (masked) config for scripts.

beacon config show
beacon config show --json

beacon doctor

Health check: node, git, config, hook, PATH, and a live provider ping. Run this first when anything misbehaves.

beacon doctor
← How it worksConfiguration →