⚡ BRIEFED DEV-PORTAL NATIVE DOCUMENTATION ⚡ ⚡ VERSION 0.9.0-beta.6 IS LIVE! ⚡ ⚡ FULLY OPEN SOURCE CLI TOOL ⚡ ⚡ BRIEFED DEV-PORTAL NATIVE DOCUMENTATION ⚡
BRIEFED ■

03. CLI COMMANDS

Briefed provides a single zero-dependency bin utility named briefed built on Commander.js. This page documents the parameters, behaviors, options, and commands exposed by the CLI tool.

⚙️ Subcommands Directory

1. briefed init

Installs Git background hooks (post-merge and post-rewrite) and scans for target context files inside your workspace.

# Standard initialization
briefed init

# Interactive wizard setup
briefed init --interactive
# OR shorthand
briefed init -i

Interactive Wizard Questions:

  1. Preferred context file path [default: auto]: Choose a custom output destination or run auto-scans.
  2. Preferred LLM backend [default: ollama]: Input ollama, gemini, anthropic, or none.
On completions, it prints a **Next Steps** onboarding checklist detailing how to stage config files, run manual sync validations, and inspect configurations.

2. briefed run

Manually computes the diff between `ORIG_HEAD` and `HEAD` and appends the summarized context entry inside the target file.

# Trigger context updates manually
briefed run [options]

Available Flags & Options:

  • -b, --backend <name>: Temporarily override backend (e.g. gemini, anthropic, ollama, none).
  • -m, --model <name>: Temporarily override LLM model.
  • -t, --target <path>: Temporarily override write path destination.
  • -v, --verbose: Print diagnostic logs, insertions/deletions, used brain, and process elapsed times.

3. briefed status

Reads and validates your active context file target, parses the log blocks, and prints details about the latest compiled entry:

briefed status

Console Readout Output: 

Target File: C:\Users\Username\Briefed\CLAUDE.md
Date:        2026-06-02T00:24:22+05:30
Commit:      abc123auth
Branch:      feature/auth-oauth2

Summary:
FILES: src/auth.ts, src/types.ts
ADDED: OAuth2 login flow helper, OAuthTokenTypes interface
REMOVED: Old insecure JWT legacy crypt.ts
DEPS: 145 insertions (+), 32 deletions (-)

4. briefed config

Deep-merges defaults, environment variables, user overrides, and prints the active Briefed configuration as a formatted JSON block.

briefed config
🔒 API key masking protection

Leaking keys in plain text inside console logs or CI logs poses a critical security risk. Briefed automatically detects resolved apiKey values in the printout and redacts them with [REDACTED], keeping developer credentials secure.

5. briefed uninstall

Removes all Briefed hook elements from your repository. If Husky is active, it safely deletes Briefed entries from .husky/post-merge and .husky/post-rewrite. If standard git hooks are active, it slices out Briefed lines cleanly without affecting other chained scripts in standard `.git/hooks/` files.

briefed uninstall