docs: document recent env vars, CLI commands, scopes, and TUI keybindings#436
Merged
Merged
Conversation
- ENGRAM_HTTP_TOKEN: document optional Bearer auth for local HTTP server (requireAuth middleware, protected routes, constant-time compare, zero-config default when unset) - scope=personal cross-project: document that mem_search and mem_context clear the project filter when scope=personal without explicit project - global scope: add 'global' to every scope enum in DOCS.md, ARCHITECTURE.md, and HTTP API docs - ENGRAM_TIMEZONE: document IANA timezone for TUI/dashboard display - engram delete --hard: add row to CLI reference tables in README.md and ARCHITECTURE.md (already in printUsage) - TUI 'c' copy: document copy-to-clipboard (OSC 52) in DOCS.md Navigation and README.md Terminal UI sections - ENGRAM_CLOUD_ALLOWED_PROJECTS '*' wildcard: document in DOCS.md cloud env table, README.md cloud section, and ARCHITECTURE.md - Pi npmCommand mise pinning: document ensurePiNpmCommand auto-pin behavior in plugin/pi/README.md and docs/AGENT-SETUP.md - Prior debt: expand DOCS.md env table from 3 rows to full list synced with printUsage; add doctor, conflicts, delete, projects prune to CLI reference tables in README.md and ARCHITECTURE.md; sync printUsage env block (add ENGRAM_HTTP_TOKEN, ENGRAM_TIMEZONE, ENGRAM_AGENT_CLI, ENGRAM_CLOUD_AUTOSYNC, ENGRAM_CLOUD_SERVER; fix indentation) Closes #435
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the docs up to date after the 2026-05-27 fix/feature batches. Documentation only (plus
printUsage()help text), no runtime behavior changes. All entries were sourced by reading the actual implementation.Today's features documented
ENGRAM_HTTP_TOKEN— optional Bearer auth for destructive HTTP endpoints (DELETE sessions/observations/prompts, GET /export, POST /import, POST /projects/migrate); unset = open (zero-config); constant-time compare.scope=personalwithout an explicit project searches across all projects (mem_search,mem_context).globalis a valid scope value (alongsideproject,personal).ENGRAM_TIMEZONE— timezone for timestamp display (TUI + cloud dashboard). Note: falls back to system local (t.Local()), not UTC.engram delete <id> [--hard]— added to the CLI reference tables.c— copy observation content to clipboard (OSC 52).ENGRAM_CLOUD_ALLOWED_PROJECTSaccepts*to allow all projects.engram setup pipinsnpmCommandvia mise when detected (existing values preserved).Prior debt fixed
DOCS.mdenv-var table expanded from 3 → 17 rows, synced withprintUsage().printUsage()env block: 5 missing vars added, indentation fixed.README.mdanddocs/ARCHITECTURE.mdnow includedoctor,conflicts,delete,projects prune.Files
DOCS.md,README.md,cmd/engram/main.go(printUsage),docs/ARCHITECTURE.md,docs/AGENT-SETUP.md,plugin/pi/README.mdTest plan
go build ./... && go vet ./...cleanCloses #435