Skip to content

docs: fix no-journal guidance #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brannn merged 2 commits into from
May 21, 2026
Merged

docs: fix no-journal guidance #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fca33ac
docs: fix no-journal guidance
hermes-agent May 21, 2026
72014fe
docs: clarify quickstart binaries
hermes-agent May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,10 +451,9 @@ threadmark daemon restart

## Limits

- Threadmark is distributed as Go commands; install with Homebrew, `go install`,
or build from source.
- Threadmark is distributed as two command-line binaries, `threadmark` and `threadmarkd`; install with Homebrew, `go install`, or build from source.
- The reflector backend is Claude CLI only.
- Journal mode sends a best-effort redacted checkpoint excerpt to the configured reflector model; use `--no-journal` for sensitive sessions.
- Journal mode sends a best-effort redacted checkpoint excerpt to the configured reflector model; launch the agent with `THREADMARK_NO_JOURNAL=true` for sensitive sessions.
- Codex hooks require explicit `/hooks` trust for project-local hooks.
- OpenCode and Pi adapters are not included.
- Cross-machine journal sync is not implemented.
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ mattered, and what should be checked before moving again?

You still keep control. `threadmark doctor` and `threadmark status` explain what
the sidecar sees, daemon lifecycle commands are available for troubleshooting
and upgrades, `--no-journal` supports testing or sensitive sessions, and project
disable/enable plus purge commands let you stop or remove local Threadmark
state.
and upgrades, `THREADMARK_NO_JOURNAL=true` supports testing or sensitive sessions,
and project disable/enable plus purge commands let you stop or remove local
Threadmark state.

## Limits

- Threadmark is distributed as two command-line binaries, `threadmark` and `threadmarkd`; install with Homebrew, `go install`, or build from source.
- The reflector backend is the Claude CLI (`claude -p`) in convenience or bare mode.
- Journal mode sends a best-effort redacted checkpoint excerpt to the configured reflector model; use `--no-journal` for sensitive sessions.
- Journal mode sends a best-effort redacted checkpoint excerpt to the configured reflector model; launch the agent with `THREADMARK_NO_JOURNAL=true` for sensitive sessions.
- Redaction is not a security guarantee.
- OpenCode and Pi adapters are not included.
- Threadmark does not sync journals across machines.
Expand Down