Skip to content

README.md

Latest commit

 

History

History
149 lines (108 loc) · 5.44 KB

README.md

File metadata and controls

149 lines (108 loc) · 5.44 KB
Raw

Claude Statusline Documentation

Last Updated: 2026-05-29 Version: 2.4.0

Comprehensive documentation for the Claude Code statusline tool.

Documentation Structure

docs/
├── README.md              # This file - main documentation entry point
├── guides/                # User-facing guides and how-to documentation
├── ref/                   # Technical reference and architecture
└── plans/                 # Research, evaluations, and planning docs

Quick Navigation

For... Go To
New users Main Project README
Configuration Configuration Guide
Troubleshooting Troubleshooting Guide
Migration from v1 Migration Guide
Performance tuning Performance Guide
Architecture Architecture Doc
Feature comparison Feature Comparison

Guides (guides/)

User-facing documentation with step-by-step instructions.

Document Description
guide-001-configuration.md Complete configuration options and examples
guide-002-troubleshooting.md Common issues and solutions
guide-003-performance.md Performance optimization and benchmarks
MIGRATION.md Migrating from bash v1.0 to TypeScript v2.0

Reference (ref/)

Technical documentation and architecture.

Document Description
ARCHITECTURE.md System architecture and design decisions
FEATURE_COMPARISON.md Detailed comparison between versions

Plans (plans/)

Research, evaluations, and project planning.

Document Type Description
eval-001-terminal-widths.md Evaluation Terminal width behavior analysis
eval-002-comprehensive-code-review.md Evaluation Comprehensive code review (7.5/10)
prd-001-typescript-perf-optimization.md PRD TypeScript performance optimization requirements
prd-002-vpn-cross-platform-support.md PRD VPN indicator Linux/WSL support
research-001-sandbox-detection.md Research Sandbox detection mechanisms
research-002-competitive-analysis.md Research Competitive landscape analysis
research-003-platform-analysis.md Research Platform compatibility analysis
tasks-002-vpn-cross-platform-support.md Tasks Implementation tasks for PRD-002
prd-003-rendering-hygiene-and-cleanup.md PRD Rendering hygiene and codebase cleanup
tasks-003-prd-003-rendering-hygiene-and-cleanup.md Tasks Implementation tasks for PRD-003

Quick Start

Installation

# Bun install (recommended - 5x faster than Node.js)
bun install -g claude-statusline

# Or npm install
npm install -g claude-statusline

Configuration

# Minimal setup
cp .claude-statusline.json.example.min ~/.claude/.claude-statusline.json

# Complete setup
cp .claude-statusline.json.example ~/.claude/.claude-statusline.json

Claude Code Integration

{
  "statusLine": {
    "type": "command",
    "command": "claude-statusline"
  }
}

Version Information

TypeScript v2.0 (Current Stable)

  • Performance: ~5ms with Bun runtime, ~28ms with Node.js runtime
  • Features: Configuration files, Windows support, npm distribution
  • Recommended for: New users, Windows users, performance-critical setups

Bash v1.0 (Legacy)

  • Performance: ~99ms
  • Features: Environment variables, Unix-like systems only
  • Recommended for: Maximum stability, minimal dependencies

Getting Help

Resource Link
Issues GitHub Issues
Discussions GitHub Discussions
Contributing CONTRIBUTING.md

Contributing to Documentation

When adding new documentation, follow the naming conventions:

Pattern: prefix-{nnn}-{title}.md (3-digit incrementing integer, e.g., prd-002-vpn-support.md)

Prefix Purpose Example
guide- How-to guides guides/guide-004-advanced-config.md
eval- Evaluation reports plans/eval-003-security-audit.md
prd- Requirements plans/prd-002-windows-support.md
research- Research findings plans/research-004-new-features.md
retro- Retrospectives plans/retro-001-v2-release.md
tasks- Implementation tasks plans/tasks-002-feature-implementation.md

See guide-006-doc-organization.md for full documentation patterns.