Skip to content

CLAUDE.md

Latest commit

 

History

History
110 lines (79 loc) · 2.8 KB

CLAUDE.md

File metadata and controls

110 lines (79 loc) · 2.8 KB

CLAUDE.md

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

Repository Management with GitHub CLI

When creating or managing GitHub repositories:

# Create a new repository and push
gh repo create [repo-name] --public --source=. --remote=origin --push

# If repository already exists
git remote add origin https://github.com/[username]/[repo-name].git
git push -u origin master

# View repository in browser
gh repo view --web

# Clone an existing repository
gh repo clone [owner]/[repo-name]

The gh CLI handles authentication automatically and simplifies GitHub operations.

DECK Development Commands

Project Setup

# Install dependencies (once implemented)
npm install

# Run tests (once implemented)
npm test

# Start development server/daemon
npm run dev

DECK-specific Commands

# Queue a new issue
deck queue [issue-number] [priority]

# Release a completed issue
deck release [issue-number]

# Check system status
deck status

# Manage the daemon
deck daemon start|stop|restart|status

# Rebuild queue state
deck rebuild

# Monitor queue activity
deck monitor

Project Structure

/home/clide/deck/
├── OVERVIEW.md         # Comprehensive project documentation
├── CLAUDE.md          # This file - Claude Code instructions
├── README.md          # User-facing documentation (to be created)
├── src/               # Source code
│   ├── deck.sh        # Main DECK CLI implementation
│   ├── daemon.sh      # Background daemon process
│   └── lib/           # Shared utilities
├── config/            # Configuration templates
├── tests/             # Test suite
└── docs/              # Additional documentation

Development Guidelines

  1. File-based approach: Use filesystem operations for all state management
  2. Atomic operations: Ensure all file operations are atomic using proper UNIX primitives
  3. Error handling: Implement comprehensive error handling and recovery
  4. Logging: Log all operations for debugging and audit trails
  5. Testing: Write tests for all core functionality

Testing Approach

  • Unit tests for individual functions
  • Integration tests for queue operations
  • System tests for daemon behavior
  • Use standard shell testing frameworks or simple assertion scripts

Commit Message Format

type: brief description

- Detailed change 1
- Detailed change 2

Fixes #issue-number (if applicable)

Types: feat, fix, docs, style, refactor, test, chore

Important Notes

  • DECK uses /var/clide/deck/ as its runtime directory (requires appropriate permissions)
  • Lock files contain JSON metadata about work items
  • The daemon must be running for automatic queue processing
  • All operations should be idempotent and safe to retry