claude-scope: Instructions file for Claude Code

CLAUDE.md

Claude Code CLI tool that displays status information in the terminal.

Version: v0.8.44

---

Quick Commands

npm run build          # Build the project
npm test               # Run all tests
npx @biomejs/biome check --write ./src   # Format & lint
npm version patch      # Bump version (patch/minor/major)

---

Installation & Default Config

On first run, claude-scope automatically creates ~/.claude-scope/config.json with default settings:

• Layout: rich (3 lines)
• Display Style: balanced
• Theme: monokai

Users can customize via:

claude-scope quick-config   # Interactive configuration menu

Or manually edit ~/.claude-scope/config.json.

---

Tech Stack

• Language: TypeScript (Node.js)
• Minimal runtime dependencies - systeminformation for system monitoring
• Formatter: Biome for linting and formatting
• Package manager: npm

---

Architecture (Overview)

This project uses a widget registry pattern with Dependency Inversion:

• IWidget interface - all widgets implement this
• WidgetRegistry - central widget lifecycle manager
• WidgetFactory - centralized widget creation
• Renderer - multi-line rendering with error boundaries

Key files: src/core/types.ts, src/core/widget-registry.ts, src/core/widget-factory.ts

Detailed architecture: See docs/ARCHITECTURE.md

---

Widget Development

To add a new widget:

1. Implement IWidget interface (or extend StdinDataWidget)
2. Add to WidgetFactory in src/core/widget-factory.ts
3. Create styles in styles.ts using StyleMap pattern
4. Use DEFAULT_THEME (Monokai) for colors

Widget documentation: See docs/WIDGETS.md for all widgets, styles, and examples

---

Code Conventions

• File size: Keep <~500 LOC; split/refactor as needed
• Types: Avoid any; use proper TypeScript types
• Imports: ES modules (import/export), organized alphabetically
• Error handling: Widgets should return null on failure
• Testing: >80% coverage for core, >60% for widgets