CLI Overview
The GuideMode CLI captures your AI coding assistant sessions and syncs them to GuideMode. It installs hooks into your coding agent, so capture happens as you work — there is no extra application to launch or leave running.
Install
Section titled “Install”npm install -g guidemodeguidemode setupguidemode setup does the whole job: it opens your browser to sign in, installs the
session hooks, installs the Claude Code skill, and verifies the result before it finishes.
By default the hooks are installed for your user account, so every project is covered.
Use --project to install them for the current project only.
guidemode setup --project # this project onlyguidemode setup --default-policy deny # sync nothing until you opt a repo inguidemode setup --no-skill # skip the Claude Code skillguidemode setup --server https://your-instance.example.comHow it works
Section titled “How it works”- Your coding agent finishes a turn and fires a hook.
- The CLI reads the session transcript and converts it to GuideMode’s canonical format.
- The transcript is redacted locally.
- It is compressed and uploaded, in a detached worker so your agent is never blocked.
Because every provider is converted to one canonical format, the analytics you get do not depend on which coding tool produced the session.
Privacy
Section titled “Privacy”- Redaction runs on your machine, before anything is uploaded. It is on by default.
- You choose which repositories sync. See Controlling what syncs.
- Nothing syncs from a repository you have denied, and
guidemode disablestops it everywhere at once.
Checking it works
Section titled “Checking it works”guidemode status # is syncing on, and for this repository?guidemode logs # what was uploaded, and anything that failedRemoving it
Section titled “Removing it”guidemode uninstallThis removes the hooks, the skill and your stored credentials.
