Skip to main content

Persistent context and memory tool for Claude Code sessions

Project description

Workshop

Give Claude long-term memory for your projects.

Workshop is a persistent memory tool that lets Claude Code remember your decisions, preferences, and project context across sessions. Install it once, and Claude automatically maintains institutional knowledge about your codebase - no manual note-taking required.

For developers using Claude Code - your AI pair programmer will remember why you made architectural choices, what gotchas to avoid, and what you're working on, even weeks later.

How It Works

  1. You install Workshop: pip install claude-workshop
  2. You run setup once: workshop init
  3. Claude does everything else: Records decisions, maintains context, answers "why" questions

Claude automatically:

  • 📝 Records architectural decisions with reasoning as you discuss them
  • ⚠️ Documents gotchas and constraints as you discover them
  • 🔄 Captures session summaries (files changed, commands run, what you worked on)
  • 🧠 Answers "why did we choose X?" questions by searching past decisions
  • 🎯 Tracks your current goals and next steps
  • 🔍 Provides full-text search across all project knowledge

Installation

pip install claude-workshop

# Set up Claude Code integration (recommended)
workshop init

This sets up Claude Code integration:

  • Global: Adds Workshop instructions to ~/.claude/settings.json (Claude will use Workshop in all your projects)
  • Local: Copies integration files to .claude/ (auto-loads context at session start, captures session summaries at session end)

That's it! Start a new Claude Code session and Claude will automatically maintain your project's institutional knowledge.

What Gets Set Up

The workshop init command configures Claude Code to:

  • Load existing context at the start of each session
  • Record decisions, gotchas, and preferences as you work
  • Capture session summaries automatically when sessions end
  • Answer "why" questions by searching past decisions

What You Can Do (Optional)

While Claude handles most Workshop interactions automatically, you can also use the CLI directly:

# Query what Claude has learned
workshop why "using zustand"        # Why did we make this choice?
workshop context                    # What's the current project state?
workshop sessions                   # What happened in past sessions?
workshop recent                     # What was recorded recently?

# Manually add entries (though Claude does this automatically)
workshop decision "Using PostgreSQL" -r "Need ACID guarantees for transactions"
workshop gotcha "API rate limit is 100 req/min"
workshop goal add "Implement caching layer"

Most users never need to run these commands - just let Claude manage everything!

Data Storage

Workshop uses SQLite for fast, efficient storage:

  • Project-specific: ./.workshop/workshop.db in your project root
  • Global: ~/.workshop/workshop.db for cross-project context
  • Custom location: Set WORKSHOP_DIR environment variable

Migration from JSON

If you're upgrading from an earlier version that used JSON storage, Workshop will automatically migrate your data to SQLite on first run and create a backup of your JSON file.

Claude Code Integration

Workshop integrates seamlessly with Claude Code to maintain context across sessions.

Global Setup (Recommended)

Add Workshop instructions to your global Claude Code settings so it's available in all projects:

Already done! If you have ~/.claude/settings.json configured, Claude will automatically:

  • Check for Workshop at session start
  • Use Workshop to record decisions, gotchas, and preferences
  • Query Workshop for historical context

Project-Specific Setup

For per-project integration with automatic context loading:

  1. Copy .claude/ directory from this repo to your project
  2. The SessionStart hook will auto-load Workshop context
  3. Custom instructions will guide Claude's Workshop usage

See .claude/README.md for details.

How It Works

  • Session Start: Claude checks if Workshop is available
  • During Session: Claude records important information:
    • Architectural decisions with reasoning
    • Failed approaches and why
    • User preferences and coding style
    • Gotchas and constraints
    • Current goals and next steps
  • Context Queries: Claude searches Workshop when needing historical context

Benefits

  • Continuity: Pick up exactly where you left off
  • Institutional Knowledge: Never lose context about why things are the way they are
  • Collaboration: Share context with future sessions (and future you!)
  • Efficiency: Avoid re-discovering the same information

Commands Reference

Write Entries

  • workshop note <text> - Add a note
  • workshop decision <text> -r <reasoning> - Record a decision with reasoning
  • workshop gotcha <text> - Document a gotcha or constraint
  • workshop preference <text> - Save a user preference
  • workshop antipattern <text> - Record an antipattern to avoid

Query & Search

  • workshop why <query> - Smart search answering "why did we do X?"
  • workshop search <query> - Full-text search across all entries
  • workshop context - Show current session context summary
  • workshop recent - Show recent entries
  • workshop read --type <type> - Filter entries by type

Session History

  • workshop sessions - List recent sessions
  • workshop session <id|last> - View session details

State Management

  • workshop goal add <text> - Add a goal
  • workshop goal list - List active goals
  • workshop next <text> - Add a next step/TODO

Utilities

  • workshop info - Show workspace information
  • workshop init - Set up Claude Code integration

License

MIT License - see LICENSE file for details.

Contributing

Issues and pull requests welcome at https://github.com/zachswift615/workshop

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claude_workshop-0.1.1.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

claude_workshop-0.1.1-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file claude_workshop-0.1.1.tar.gz.

File metadata

  • Download URL: claude_workshop-0.1.1.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for claude_workshop-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8289e4222e4aed8bb93fa77c073fb9b31e88284f32275847e5bef67f3731d99c
MD5 a15bfaf52718b70d8a66e29e54a156ed
BLAKE2b-256 d955cbfea7d90c550922ccd56b292769544bc964f0284f8a419fc69f98c5cc5f

See more details on using hashes here.

File details

Details for the file claude_workshop-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for claude_workshop-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b096b4119f58747a073acc1c99d29284d849b60dcd7f588a62699ba320ff2e2
MD5 7bedf0b1506aa8c53c1cea94b919339a
BLAKE2b-256 4e4ec74a3205da37a4d02685d0bc379700a342ba85a6cbe430f0b5c8ac2a9d14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page