Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Reference

Vibe Analyzer provides a command-line interface for managing knowledge sources, analysis, exporting, indexing, and running the MCP server.

General Syntax

vibe-analyzer [global options] <command> [subcommand] [options]

Global Options

OptionDescription
--config <path>Path to config file (default: ~/.vibe-analyzer/config.json5)
--helpShow help
--versionShow version

Commands

source — Source Management

Add, remove, and list knowledge sources.

vibe-analyzer source <subcommand>
SubcommandDescription
add <path>Adds a new directory or file to the sources list. The path is automatically converted to absolute
remove --target <path>Removes a source from the configuration. Accepts full path or unique directory name
listShows all added sources with absolute paths

Examples:

vibe-analyzer source add /home/user/projects/my-app
vibe-analyzer source remove --target my-app
vibe-analyzer source list

analyze — Analysis and Export

Extract code structure, run LLM enrichment, and export results.

vibe-analyzer analyze export [options]
OptionDescription
--target <path>Process a specific source. If not specified — all sources are processed
-m, --mode <mode>Analysis modes: ast, meta, debt, errors, advice (comma-separated)
-t, --type <type>File types to export: code, markdown, text, binary (comma-separated)
-f, --format <format>Export format: json (default), json5, toml, toon, xml, yaml
-p, --path <path>Source path for direct file/directory scanning
-o, --output <path>Export path. If not specified — file is created in ~/Downloads/

Examples:

# AST only, all sources
vibe-analyzer analyze export

# AST + LLM enrichment for code files only
vibe-analyzer analyze export -m meta,debt -t code

# Errors in markdown documentation only
vibe-analyzer analyze export -m errors -t markdown

# Full analysis with JSON5 export
vibe-analyzer analyze export -m meta,debt,errors,advice -f json5

index — OpenSearch Indexing

Full cycle: AST parsing → LLM enrichment → write to OpenSearch.

vibe-analyzer analyze index [options]
OptionDescription
--target <path>Index a specific source. If not specified — all sources
--forceForce full reindexing. Ignores hashes and processes all files again

Examples:

vibe-analyzer analyze index
vibe-analyzer analyze index --target my-app
vibe-analyzer analyze index --target my-app --force

stats — Statistics

View information and statistics for indexed projects.

vibe-analyzer stats <subcommand>

stats info

vibe-analyzer stats info [options]
OptionDescription
--target <path>Show statistics for a specific project. If not specified — all projects

Example output:

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Language                  Files           Lines     AST Objects            Size
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Rust                        194           15146            1631       498.26 KB
Markdown                     33            2884             296       102.64 KB
...
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Total                       287           24893            2082       755.11 KB
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

stats tree

vibe-analyzer stats tree --target <project> [options]
OptionDescription
--target <path>Project to display the tree for (required)
-L, --level <number>Maximum tree depth (default: 3)

serve — MCP Server

Start, stop, and check MCP server status.

vibe-analyzer serve <subcommand>
SubcommandDescription
startStart MCP server
stopStop running server (reserved)
statusShow server status (reserved)

Examples:

vibe-analyzer serve start
vibe-analyzer serve start --port 9020 --host 127.0.0.1

Export Formats

Six formats available with --format:

FormatKeyExtensionDescription
JSONjson.jsonCompact JSON without extra whitespace — minimal file size
JSON5json5.json5JSON5 with comments and trailing commas — human-readable
TOMLtoml.tomlTOML format
TOONtoon.toonTOON format — token-efficient output, optimized for LLMs
XMLxml.xmlXML with pretty-print formatting
YAMLyaml.yamlYAML format