Working In Scratch Areas

Working in Scratch Areas

Overview

Helps Claude save one-off scripts and documents to persistent scratch areas instead of littering repositories with temporary files or using /tmp.

Core principles:

• Temporary work deserves permanent storage
• Scripts and documents should be documented, organized, and preserved
• Never use /tmp or project tmp/ directories for these files
• Files belong in .scratch/ subdirectories with context

Announce at start: "I'm using the working-in-scratch-areas skill."

When to Use

Use this skill when creating:

• One-off debug scripts
• Analysis or investigation tools
• Temporary documentation or reports
• Quick test scripts
• Data extraction utilities
• Monitoring or diagnostic tools

Don't use for:

• Production code that belongs in the main codebase
• Configuration files that should be committed
• Tests that belong in the test suite
• Documentation that should be in docs/

NEVER use /tmp or project tmp/ directories. Always use .scratch/ for temporary work.

Setup Workflow

Check for Existing Scratch Area

First, check if a scratch area already exists:

test -L .scratch && echo "Scratch area exists" || echo "No scratch area"

If the symlink exists, verify gitignore is configured (see below), then you're ready to use it.

Setting Up New Scratch Area

When no scratch area exists:

1. Detect: "I notice this repository doesn't have a scratch area set up."
2. Check CLAUDE.md: Check if scratch areas location is configured in ~/.claude/CLAUDE.md
3. If not configured: Ask user where they want scratch areas with AskUserQuestion tool
4. Run setup script with the chosen location
5. Optionally save the location to CLAUDE.md for future use

Setup Steps:

# 1. Get repo root
git rev-parse --show-toplevel
# Output: /Users/josh/workspace/some-repo

# 2. Check if configured in CLAUDE.md
grep -i "scratch areas:" ~/.claude/CLAUDE.md

# 3a. If configured, run setup (reads from CLAUDE.md automatically)
cd /Users/josh/workspace/some-repo && ~/.claude/skills/working-in-scratch-areas/scripts/setup-scratch-area.sh

# 3b. If not configured, ask user for location and run with --areas-root
cd /Users/josh/workspace/some-repo && ~/.claude/skills/working-in-scratch-areas/scripts/setup-scratch-area.sh --areas-root ~/workspace/scratch-areas

# 3c. If user wants to save preference, add --save-to-claude-md flag
cd /Users/josh/workspace/some-repo && ~/.claude/skills/working-in-scratch-areas/scripts/setup-scratch-area.sh --areas-root ~/workspace/scratch-areas --save-to-claude-md

# 4. Verify gitignore (see Gitignore Setup section below)

What the script does:

• Checks ~/.claude/CLAUDE.md for configured scratch areas location (or accepts --areas-root flag)
• Creates scratch areas root directory and repository-specific subdirectory
• Creates symlink {repo-root}/.scratch → scratch area
• Creates README from template with repository-specific information
• Optionally saves location to CLAUDE.md with --save-to-claude-md flag

Script Location: ~/.claude/skills/working-in-scratch-areas/scripts/setup-scratch-area.sh

Script Options:

• --areas-root PATH - Specify scratch areas root directory (required if not in CLAUDE.md)
• --save-to-claude-md - Save the areas root to ~/.claude/CLAUDE.md for future use
• --help - Show help message

Configuring Scratch Areas Location

The setup script checks ~/.claude/CLAUDE.md for your preferred scratch areas location. If not found, you must provide --areas-root flag.

To configure in CLAUDE.md, add:

## Scratch Areas

When using the `dev-tools:working-in-scratch-areas` skill, create scratch areas in `~/workspace/scratch-areas` directory.

Suggested locations to offer user:

• ~/workspace/scratch-areas - Central location for all scratch areas
• ~/workspace/pickled-scratch-area/areas - If using the full pickled-scratch-area repository
• $(dirname "$REPO_ROOT")/scratch-areas - Sibling to current repository (for project-specific scratch areas)

Use AskUserQuestion to present these options when not configured.

Gitignore Setup

After creating scratch area, ensure .scratch is gitignored:

Preferred: Global gitignore

# Check if globally ignored
git config --global core.excludesfile
# Verify .scratch is in that file

# If not set up, add to global gitignore
echo ".scratch" >> ~/.gitignore
git config --global core.excludesfile ~/.gitignore

Alternative: Project .gitignore

If global gitignore isn't used:

# Add to project .gitignore if not present
grep -q "^\.scratch$" .gitignore || echo ".scratch" >> .gitignore

Why global is preferred: Prevents accidental commits across all repositories.

Subdirectory Organization

Always Use Subdirectories

Organize scratch files into topic-specific subdirectories:

.scratch/
├── database-debug/
│   ├── README.md
│   ├── check-connections.sh
│   └── query-results.txt
├── performance-analysis/
│   ├── README.md
│   ├── profile-api.sh
│   └── results-2024-11-05.md
└── data-extraction/
    ├── README.md
    └── extract-users.rb

Do NOT create files directly in .scratch/ root. Always use a subdirectory.

Subdirectory Workflow

1. Check for existing relevant subdirectory:

   ls -la .scratch/
   

2. If relevant subdirectory exists: Ask user if it makes sense to use it:

   • "I see there's already a .scratch/database-debug/ directory. Should I add this script there, or create a new subdirectory?"

3. If creating new subdirectory:

   • Use descriptive names: database-debug, api-performance, user-data-extraction
   • Create a README.md explaining the purpose

4. Subdirectory README required: Every subdirectory MUST have a README.md describing:

   • What kind of files are stored here
   • What problem/investigation spawned these files
   • How files relate to each other (if at all)

Example subdirectory README:

# Database Connection Debugging

## Purpose

Scripts and notes for investigating database connection timeout issues reported on 2024-11-05.

## Files

- `check-connections.sh` - Monitor active connections
- `query-slow-queries.sql` - Identify slow queries
- `findings.md` - Investigation notes and conclusions

## Status

Investigation completed 2024-11-08. Issue was connection pool exhaustion.
Keeping files for reference.

Script Creation Rules

When creating scripts in scratch areas, follow these mandatory rules:

1. Always Use Proper Shebang

Every script MUST start with #!/usr/bin/env <command>:

#!/usr/bin/env bash

#!/usr/bin/env python3

#!/usr/bin/env ruby

#!/usr/bin/env node

Why: Enables proper allow list management and makes scripts directly executable.

2. Make Scripts Executable

After creating a script (file with shebang), use the helper script to make it executable:

~/.claude/skills/working-in-scratch-areas/scripts/make-executable .scratch/subdir/script.sh

Why:

• Allows calling scripts directly (./script.sh) instead of through interpreter
• Helper script gets approved once, not per-file
• Consistent executable permissions
• Validates shebang exists (prevents making non-script files executable)

Never use chmod +x directly - use the helper script instead.

Important: Only make script files executable (files with shebangs). Do NOT make markdown files, text files, or other non-script files executable. The helper script will reject files without shebangs.

3. Call Scripts Directly

When invoking scripts, use direct execution:

✅ CORRECT:

./.scratch/database-debug/check-connections.sh

❌ WRONG:

bash .scratch/database-debug/check-connections.sh # Don't use interpreter
ruby .scratch/data-extraction/extract-users.rb    # Don't use interpreter

Why: Direct execution respects shebang and allow list configurations.

4. Use Write Tool for File Creation

When creating files in scratch areas, prefer the Write tool:

✅ CORRECT:

Use Write tool to create .scratch/subdir/script.sh with content

❌ WRONG:

cat > .scratch/subdir/script.sh << 'EOF'
# content
EOF

Why: Write tool requires fewer approvals and is cleaner.

5. Always Include Documentation Header

Every file MUST have a documentation header explaining its purpose:

Script header example:

#!/usr/bin/env bash

# check-database-connections.sh
#
# Purpose: Monitor database connection pool usage
# Created: 2024-11-05
# Used for: Investigating connection timeout issues in production
#
# This script helped identify that connection pool was being exhausted
# during peak traffic. Key finding: connection cleanup wasn't happening
# in error paths.

Document header example:

# API Performance Analysis Report

## Purpose

Analysis of API response times after v2.3.0 deployment

## Created

2024-11-05

## Usage Context

Users reported 2-3x slower response times after deploying v2.3.0.
This analysis was conducted to identify the regression.

## Key Findings

- Response times increased by 150% on average
- Root cause: New verbose logging middleware
- Each request was writing 500KB of logs
- Resolution: Disabled verbose logging in production config

## Impact

This analysis prevented a rollback and identified a simple configuration fix.
Deployment was saved by changing one config value.

Git Operations

Never Add Scratch Files to Git

When using git commands to add and commit files:

❌ NEVER do this:

git add .
git add -A
git add .scratch/

✅ ALWAYS be explicit:

git add specific-file.rb
git add src/components/Button.tsx
git add docs/api.md

Why: Prevents accidentally committing scratch work. Global gitignore is a safety net, but explicit adds are the first line of defense.

Scratch Area Stays Local

• .scratch should be in .gitignore (globally preferred)
• Scratch files are never committed or pushed
• Scratch files are specific to your local investigation
• If work needs to be shared, it should be in the main codebase

File Management Philosophy

Never Delete - Document Instead

When a file is no longer actively needed:

❌ DON'T: Delete the file ✅ DO: Add retrospective comments explaining:

• How the file was used
• What it helped understand or accomplish
• Key findings or insights gained
• When it was last relevant

Example retrospective header:

#!/usr/bin/env bash

# investigate-memory-leak.sh
#
# [RESOLVED - 2024-11-08]
# This script was used to investigate memory leaks in worker processes.
#
# Original purpose: Track memory usage over time to identify leak pattern
# Key finding: Memory leak was in redis-client gem v4.2, not our code
# Resolution: Updated gem to v4.3 which fixed the issue
# Verification: Memory usage stayed stable after upgrade
#
# Keeping this script for reference in case similar issues occur with
# other background workers.

Why: Preserved scripts document your problem-solving process and findings for future reference.

Workflow Examples

Creating a Debug Script

1. Check if scratch area exists: test -L .scratch
2. If missing, offer setup
3. Check for relevant subdirectory: ls -la .scratch/
4. Ask if existing subdir is appropriate, or create new one
5. Create subdirectory README if new: Use Write tool
6. Create script with Write tool (include shebang + header)
7. Make executable: ~/.claude/skills/working-in-scratch-areas/scripts/make-executable .scratch/subdir/script.sh
8. Run directly: ./.scratch/subdir/script.sh

Creating an Analysis Document

1. Check if scratch area exists
2. Check for relevant subdirectory
3. Ask about existing subdir or create new one
4. Create subdirectory README if new
5. Create document with Write tool (include header)
6. Document findings as you work

Archiving a Script

When a script's purpose is complete:

1. DON'T delete it
2. Use Edit tool to add retrospective header with [RESOLVED] section
3. Document findings and resolution

Best Practices Checklist

When creating any file in scratch area, verify:

• File is in a subdirectory, not .scratch/ root
• Subdirectory has a README.md describing its purpose
• Checked for existing relevant subdirectory first
• Used Write tool for file creation (not cat/echo)
• Descriptive filename that indicates purpose
• Documentation header with purpose and context
• Created date in header
• Usage context documented
• .scratch is in gitignore (global or project)

For script files specifically:

• Proper shebang line (#!/usr/bin/env <command>)
• Made executable using helper script (verifies shebang)
• Called directly (not through interpreter like bash or ruby)

When completing work with a file:

• Add retrospective comments if no longer needed
• Document key findings
• Explain what was learned
• Note resolution if applicable
• Keep file for future reference

Common Patterns

Investigation Script Pattern

#!/usr/bin/env bash

# investigate-{issue}.sh
#
# Purpose: Debug {specific issue}
# Created: {date}
# Used for: {context}

set -euo pipefail

# Investigation logic here
echo "Starting investigation..."

# Document findings in comments as you discover them

Data Extraction Pattern

#!/usr/bin/env bash

# extract-{data-type}.sh
#
# Purpose: Extract {specific data} for {reason}
# Created: {date}
# Used for: {context}

set -euo pipefail

# Extraction logic
# Output to .scratch/subdir/extracted-data.txt

Monitoring Pattern

#!/usr/bin/env bash

# monitor-{resource}.sh
#
# Purpose: Monitor {resource} for {reason}
# Created: {date}
# Used for: {context}

set -euo pipefail

while true; do
  # Monitoring logic
  sleep 5
done

Analysis Report Pattern

# {Topic} Analysis Report

## Purpose

{What you're analyzing and why}

## Created

{Date}

## Usage Context

{Why this analysis was needed}

## Methodology

{How you approached the analysis}

## Findings

{What you discovered}

## Conclusions

{What this means}

## Next Steps / Impact

{What actions were taken based on this}

Benefits

• Centralized storage: All temporary work in one location
• Repository isolation: Each repo has its own subdirectory
• Easy access: Symlink makes scratch area accessible from repo root
• Persistent history: Files remain even if repository is moved/deleted
• Knowledge preservation: Comments document learnings and process
• Better security: Proper shebangs enable better allow list management
• Future reference: Preserved scripts serve as examples and documentation
• Organized: Subdirectories group related work together
• Git-safe: Global gitignore prevents accidental commits

Terminology

For consistency:

• .scratch - The symlink in repository root (e.g., ./.scratch/)
• scratch area - The concept of a dedicated space for temporary work
• scratch areas - The overall system of centralized scratch directories
• pickled-scratch-area - The central repository managing all scratch areas

Advanced Features

This skill provides the core functionality for working with scratch areas. For additional features like migration scripts and testing utilities, see the full repository:

Repository: ~/workspace/pickled-scratch-area/

Available tools:

• migrate-scratch-areas.sh - Migrate existing scratch areas to new structure
• migrate-to-dot-scratch.sh - Rename scratch symlinks to .scratch
• migrate-all-scratch-areas.sh - Batch migration across multiple repositories
• test-setup-scenarios.sh - Comprehensive test suite for setup script
• rename-scratch-areas.sh - Legacy renaming utilities

These are typically one-time operations and not needed for day-to-day scratch area usage.

Quick Reference

Remember

• Temporary work deserves permanent storage
• Never use /tmp or project tmp/ - always use .scratch/
• Always organize into subdirectories with README files
• Check for existing relevant subdirectories first
• Every script needs a shebang
• Every file needs documentation
• Use Write tool for file creation
• Use helper script to make files executable
• Call scripts directly, not through interpreter
• Never add .scratch/ files to git
• Never delete - add retrospective comments instead