CodePal

A full-featured devtools toolkit for checking, validating, generating, formatting, linting, explaining, converting, diffing, previewing, and fixing code — with built-in logging, search, statistics, and data export.

Commands

Usage

codepal \x3Ccommand> [args]

Each command with arguments logs the input with a timestamp to a category-specific log file. Running a command with no arguments shows the most recent entries for that category.

Data Storage

• Default location: ~/.local/share/codepal
• Log files: Each command has its own log file (e.g., check.log, lint.log, generate.log)
• History: All actions are also recorded in history.log with timestamps
• Export formats: JSON (structured array of objects), CSV (type/time/value columns), plain text (grouped by category)

Requirements

• Bash 4+ (strict mode: set -euo pipefail)
• No external dependencies or API keys required
• Standard Unix tools (date, wc, grep, du, head, tail)

When to Use

1. Code review tracking — Use check, lint, and validate to log issues discovered during code review sessions, then search to find them later
2. Learning unfamiliar codebases — Use explain to document your understanding of code patterns, then report to create summaries
3. Code generation and templating — Use generate to log code generation prompts and template to track template usage
4. Diffing and debugging — Use diff to record code changes and fix to document bug fixes, creating an audit trail
5. Team metrics and reporting — Use stats for activity summaries, export json to feed into dashboards, and recent for quick status checks

Examples

# Check a function
codepal check "validateEmail() is missing null check"

# Generate a code snippet description
codepal generate "React hook for debounced search"

# Lint a file
codepal lint "server.js:42 — unused variable 'config'"

# Explain a concept
codepal explain "JavaScript closure in event handler"

# Record a diff
codepal diff "Refactored auth middleware to use async/await"

# Fix a bug
codepal fix "Off-by-one error in pagination logic"

# View aggregate statistics
codepal stats

# Export all logged data as CSV
codepal export csv

# Search for entries about authentication
codepal search "auth"

# Show recent activity
codepal recent

# Health check
codepal status

Output

• Command results print to stdout
• Entries are timestamped (YYYY-MM-DD HH:MM) and persisted to ~/.local/share/codepal/\x3Ccategory>.log
• Export files are written to ~/.local/share/codepal/export.\x3Cfmt> with a byte count confirmation

Powered by BytesAgain | bytesagain.com | [email protected]