Where to Find Documentation for Caveman: Complete Repository Guide

Caveman documentation lives entirely within the JuliusBrussee/caveman GitHub repository, with the README.md serving as the central entry point linking to installation guides, command references, and agent-specific integration files.

If you are searching for where to find documentation for caveman, the JuliusBrussee/caveman project maintains comprehensive documentation internally rather than on external sites. The repository structure organizes documentation into logical sections covering installation procedures, CLI command syntax, plugin integrations, and methodology explanations. All documentation files are accessible directly from the main branch and cross-referenced through the primary README.md table of contents.

Main Documentation Entry Points

The documentation hierarchy begins with two primary files that provide orientation and setup instructions.

README.md – Project Overview

The README.md file at the repository root serves as the main entry point and high-level overview. It contains the feature list, quick links to all other documentation sections, and a table of contents that links to specialized guides. According to the JuliusBrussee/caveman source code, this file is the recommended starting point for understanding the project's purpose and navigating to specific topics.

INSTALL.md – Installation Guide

Detailed step-by-step installation instructions reside in INSTALL.md. This file documents the one-liner installer script, per-agent installation commands, and all available CLI flags for the install process. It covers both Unix-based systems and Windows installation procedures.

Command Reference Documentation

Each built-in CLI command maintains its own dedicated documentation file within the repository.

The Commands Directory Structure

The commands/ directory contains individual markdown files for every available command. As implemented in JuliusBrussee/caveman, this modular approach separates concerns and allows users to reference specific functionality without parsing through monolithic documentation.

Key command files include:

• commands/caveman.md – Documents the /caveman activation command, syntax variants like /caveman full and /caveman ultra, and compression level specifications.
• commands/caveman-stats.md – Describes the /caveman-stats command for viewing token-saving statistics and includes the --share flag documentation.
• commands/caveman-compress.md – Explains the /caveman-compress command syntax for processing memory files such as CLAUDE.md.

Agent Integration and Plugin Documentation

Caveman integrates with multiple AI agents, and each integration point includes dedicated documentation.

Plugin Documentation Location

Agent-specific implementation details live in the src/plugins/ directory. For example, the Opencode plugin documentation is located at src/plugins/opencode/README.md, which explains how Caveman interfaces with the Opencode agent. Similar structure exists for other supported agents including Claude Code, Gemini, and OpenClaw.

Skills Documentation

The skills/ directory contains markdown files explaining how Caveman exposes functionality to various AI agents. These files describe the skill interface, available capabilities, and configuration options for agent integration.

Specialized Documentation Resources

Beyond the primary guides, the repository contains targeted documentation for specific concerns.

Token Savings Methodology

The docs/HONEST-NUMBERS.md file provides transparent documentation regarding token-saving claims and measurement methodology. This resource explains how Caveman calculates efficiency metrics and presents verifiable data about context window optimization.

Platform-Specific Installation

Windows users should consult docs/install-windows.md for PowerShell-specific installation notes and Windows environment configuration. This supplements the general INSTALL.md with platform-specific considerations.

Security and Privacy Guarantees

Privacy policies and security statements are formally documented in SECURITY.md. This file outlines telemetry practices, data handling procedures, and security vulnerability reporting processes.

Quick Start Code Examples

The following commands demonstrate how to interact with Caveman using the documented syntax.

Install Caveman

Use the one-liner installer for Unix systems:

curl -fsSL https://raw.githubusercontent.com/JuliusBrussee/caveman/main/install.sh | bash

For Windows PowerShell:

irm https://raw.githubusercontent.com/JuliusBrussee/caveman/main/install.ps1 | iex

Install for Specific Agents

Install only the Opencode integration using Node.js:

node bin/install.js --only opencode

Or via npx:

npx -y github:JuliusBrussee/caveman -- --only opencode

Activate Caveman Mode

Switch to full compression mode:

/caveman full

Switch to ultra compression:

/caveman ultra

View Statistics

Display token-saving statistics with sharing enabled:

/caveman-stats --share

Compress Memory Files

Process a Claude memory file:

/caveman-compress CLAUDE.md

List Detected Agents

Perform a dry-run to see available agents:

node bin/install.js --list

Summary

• Entry Point: Start with README.md for the overview and navigation links.
• Installation: Reference INSTALL.md for complete setup instructions and CLI flags.
• Command Details: Check individual files in commands/ for syntax and options.
• Agent Integration: Review src/plugins/ and skills/ for AI agent configurations.
• Methodology: Consult docs/HONEST-NUMBERS.md for token-saving measurements.
• Security: Review SECURITY.md for privacy guarantees and data handling.

Frequently Asked Questions

Is Caveman documentation hosted outside of GitHub?

No. According to the JuliusBrussee/caveman repository structure, all official documentation resides within the GitHub repository itself. There are no external documentation sites or wikis; users should reference the markdown files directly in the main branch.

Which file contains the complete installation reference?

The INSTALL.md file contains the comprehensive installation workflow, including the one-liner script, per-agent install commands, and all available flags such as --only and --list. Windows-specific supplemental instructions are available in docs/install-windows.md.

Where is the token-saving measurement methodology explained?

The docs/HONEST-NUMBERS.md file explains the token-saving claims and measurement methodology. It details how Caveman calculates context window efficiency and provides transparency regarding performance metrics.

How do I find documentation for specific CLI commands?

Each command has a dedicated markdown file in the commands/ directory. For example, /caveman syntax is documented in commands/caveman.md, while /caveman-stats is covered in commands/caveman-stats.md. These files describe syntax, available options, and usage examples for each specific command.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}