claude-cleaner: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Claude Cleaner is a TypeScript/Deno tool that removes Claude artifacts (files and commit trailers) from Git repositories. It uses git filter-branch for both file removal (via an internal index-filter self-invocation) and commit message cleaning (via an internal msg-filter self-invocation).

Essential Commands

Development

# Run the tool locally
deno run --allow-all src/main.ts --help
deno run --allow-all src/main.ts check-deps
deno run --allow-all src/main.ts --verbose  # Dry-run mode (default)

# Type checking and linting
deno check                       # Type check
deno fmt                         # Format code
deno lint                        # Lint code

Testing

# Run all tests
deno test --allow-all
deno task test

# Run specific test suites
deno task test:unit              # Unit tests only
deno task test:integration       # Integration tests only
deno task test:verbose           # All tests with verbose output

# Run specific test file
deno test --allow-all tests/unit/file-cleaner.test.ts

Building

# Compile to standalone binary
deno task build
# or
deno compile --allow-all --output claude-cleaner src/main.ts

Architecture

Core Modules

Entry Point (main.ts):

• CLI interface using Cliffy framework
• Command: claude-cleaner [options] and claude-cleaner check-deps
• Three modes: --files-only, --commits-only, or full cleaning (both)
• Dry-run by default; requires --execute flag to apply changes

Dependency Manager (dependency-manager.ts):

• Validates that Git is available — the only external runtime dependency
• History rewriting is performed entirely by Git plus this tool's own self-invoked git filter-branch filters (see internal-filter.ts); the former Java/BFG/sd/mise toolchain has been removed
• Does not install anything; --auto-install is a deprecated no-op
• Key methods: checkGit(), checkAllDependencies()