guidemode

CLI for GuideMode — capture and analyze your Claude Code sessions.

Quick Start

npx guidemode

This walks you through everything:

1. Browser login (GitHub OAuth)
2. Installing Claude Code sync hooks
3. Optionally installing the CLI globally

Once set up, your Claude Code sessions sync automatically to GuideMode.

Install Globally (Optional)

npm install -g guidemode

Claude Code Plugin

For teams using Claude Code, install the plugin for automatic session sync:

/plugin marketplace add guidemode/guidemode-marketplace
/plugin install guidemode-sync@guidemode-marketplace

The plugin uses the same CLI under the hood — npx guidemode handles everything.

Commands

guidemode                  # First run: guided setup. After: show help
guidemode setup            # Re-run setup (login + hooks)
guidemode setup --force    # Force re-authentication
guidemode login            # Login only
guidemode logout           # Clear credentials
guidemode whoami           # Show current user
guidemode status           # Health check
guidemode status --verbose # Detailed health check
guidemode sync             # Sync current session (used by hooks)
guidemode logs             # View sync logs
guidemode logs --errors    # Show only errors
guidemode logs --follow    # Tail logs in real-time

Configuration

Config lives at ~/.guidemode/config.json:

{
  "apiKey": "gm_...",
  "serverUrl": "https://app.guidemode.dev",
  "tenantId": "your-tenant-id",
  "tenantName": "Your Team",
  "syncHooks": ["Stop", "PreCompact", "SessionEnd"],
  "redactBeforeUpload": true
}

Omit syncHooks to enable all three (default).

Secret & PII Redaction

Session transcripts naturally contain sensitive data — API keys, tokens, emails, and home directory paths that appear in tool results, bash output, and file contents. Before uploading, the CLI automatically scans and redacts this data.

Enabled by default. No configuration needed.

What Gets Redacted

| Category | Examples | Detection | |----------|----------|-----------| | API keys & tokens | AWS keys, GitHub tokens (ghp_/gho_/ghs_), Anthropic keys (sk-ant-), OpenAI keys, Slack tokens, npm tokens, GuideMode keys (gai_), generic api_key=... patterns | secretlint (15 provider rules) + custom regex | | Private keys | RSA, DSA, EC, PGP private key blocks | secretlint | | Connection strings | postgresql://user:pass@host/db, MongoDB, Redis URIs | secretlint | | Emails | [email protected] | Custom regex | | Home directories | /Users/yourname/..., /home/yourname/... | Custom regex |

Detected values are replaced with [REDACTED:CATEGORY] placeholders (e.g. [REDACTED:GitHubToken], [REDACTED:EMAIL], [REDACTED:HOME_DIR]).

What Is NOT Redacted

Structural metadata is preserved: session IDs, timestamps, message roles, model names, token usage, git branches, content block types, and tool names.

Disabling Redaction

Set redactBeforeUpload to false in your config:

{ "redactBeforeUpload": false }

Monitoring

When redactions occur, they are logged:

[INFO] [SessionEnd] Redacted 7 items in 3/45 lines (GitHubToken: 2, EMAIL: 3, HOME_DIR: 2)

View with guidemode logs.

For Developers

git clone https://github.com/guidemode/guidemode.git
cd guidemode/packages/cli
pnpm install && pnpm build

See CLAUDE.md for architecture and development details.

License

MIT