Skip to content

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.

Terminal window
npm install -g guidemode
guidemode setup

guidemode 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.

Terminal window
guidemode setup --project # this project only
guidemode setup --default-policy deny # sync nothing until you opt a repo in
guidemode setup --no-skill # skip the Claude Code skill
guidemode setup --server https://your-instance.example.com
  1. Your coding agent finishes a turn and fires a hook.
  2. The CLI reads the session transcript and converts it to GuideMode’s canonical format.
  3. The transcript is redacted locally.
  4. 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.

  • 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 disable stops it everywhere at once.
Terminal window
guidemode status # is syncing on, and for this repository?
guidemode logs # what was uploaded, and anything that failed
Terminal window
guidemode uninstall

This removes the hooks, the skill and your stored credentials.