claude-code-explorer

Claude Code Explorer

Interactive CLI tool for exploring and managing Claude Code settings and slash commands

Overview

Claude Code Explorer is a React Ink-based CLI tool that provides an interactive terminal interface for discovering, previewing, and managing Claude Code configuration files and slash commands. Navigate through your codebase to find CLAUDE.md files, slash command definitions, and other Claude-related configurations with a beautiful terminal UI.

Features

• 🔍 Interactive File Discovery - Automatically finds Claude Code configuration files
• 📁 Split-pane Interface - File list on the left, preview on the right
• ⌨️ Keyboard Navigation - Arrow keys, Enter, ESC for smooth navigation
• 🔎 Live Search - Filter files as you type
• 📋 File Actions - Copy content, copy paths, open files in default applications
• 🎨 Terminal UI - Beautiful React Ink interface with proper focus management
• 📝 Markdown Preview - Renders CLAUDE.md files with syntax highlighting

Screenshots

Target Files

Claude Code Explorer automatically discovers these configuration files:

• CLAUDE.md → Project-level configuration (most common)
• CLAUDE.local.md → Local overrides (gitignored)
• ~/.claude/CLAUDE.md → Global user configuration
• .claude/commands//*.md** → Slash command definitions

Installation

Quick Start (Recommended)

No installation required! Run directly with:

# Using Bun (fastest)
bunx claude-code-explorer@latest

# Using npm
npx claude-code-explorer@latest

# Using pnpm
pnpm dlx claude-code-explorer@latest

Shell Alias (Recommended for Frequent Use)

The command npx claude-code-explorer can be lengthy to type. We recommend setting up a shell alias:

# Add to ~/.bashrc, ~/.zshrc, or your shell's config file
alias ccexp="npx claude-code-explorer@latest"

# For Bun users
alias ccexp="bunx claude-code-explorer@latest"

# For pnpm users
alias ccexp="pnpm dlx claude-code-explorer@latest"

After adding the alias, reload your shell configuration:

source ~/.bashrc    # or ~/.zshrc

Now you can simply run:

ccexp               # Launch in current directory
ccexp --path ~/projects  # Scan specific directory

Global Installation

For frequent use, install globally:

# npm
npm install -g claude-code-explorer

# Bun
bun install -g claude-code-explorer


# pnpm
pnpm add -g claude-code-explorer

Then run from anywhere:

claude-code-explorer

Usage

Interactive Mode (Default)

claude-code-explorer                    # Launch interactive TUI
claude-code-explorer --path ~/projects # Scan specific directory

Command Line Options

claude-code-explorer --help             # Show help information
claude-code-explorer --version          # Show version number
claude-code-explorer --path <path>      # Specify directory to scan

Examples

# Launch in current directory
bunx claude-code-explorer@latest

# Scan specific project
bunx claude-code-explorer@latest --path ~/my-project

# Quick exploration without installation
npx claude-code-explorer@latest

# Show help
bunx claude-code-explorer@latest --help

# Show version
bunx claude-code-explorer@latest --version

Common Use Cases

# Find all Claude configuration in your workspace
cd ~/workspace
bunx claude-code-explorer@latest

# Check Claude settings in a specific project
bunx claude-code-explorer@latest --path ./my-project

# Explore global Claude configuration
bunx claude-code-explorer@latest --path ~/.claude

# Using alias (after setup)
ccexp                      # Current directory
ccexp --path ~/workspace   # Specific directory

Development Mode

bun run start      # Run with hot reload
bun run dev        # Development mode with watch

Building

bun run build      # Build for production

Keyboard Shortcuts

• ↑/↓ - Navigate file list
• Enter - Open file actions menu
• ESC - Close menu / Exit
• Tab - Switch between panes
• / - Focus search input
• c - Copy file content (in menu)
• p - Copy file path (in menu)
• o - Open file in default application (in menu)

Development

Tech Stack

• Runtime: Bun + Node.js (>= 20)
• UI Framework: React Ink v6
• Components: @inkjs/ui for enhanced terminal components
• Build: tsdown (Rolldown/Oxc) with shebang executable
• Testing: vitest + ink-testing-library
• Linting: Biome with strict rules
• Type Safety: TypeScript with ultra-strict configuration

CLI Reference

Option	Short	Description	Default
--help	-h	Show help information	-
--version	-V	Show version number	-
--path	-p	Directory to scan	Current directory

Development Commands

# Quality pipeline
bun run ci                    # Full CI pipeline
bun run typecheck            # TypeScript checking
bun run check:write          # Auto-fix formatting
bun run test                 # Run all tests
bun run test:watch           # Test in watch mode

# Development
bun run start                # Run CLI in development
bun run dev                  # Development with watch
bun run build                # Build for production

Architecture

• InSource Testing - Tests alongside source code
• Branded Types - Compile-time and runtime type safety
• React Ink Components - Terminal UI with proper focus management
• Pattern Matching - File type detection with ts-pattern
• Immutable Design - Readonly properties throughout

Contributing

• Fork the repository
• Create a feature branch
• Make your changes
• Run the quality pipeline: bun run ci
• Submit a pull request

License

MIT License - see LICENSE file for details