Moved 25 files from root to organized subdirectories while keeping essential scripts (install.sh, setup.sh, start*.sh, stop*.sh) in root. ## Changes: ### New Directory Structure: - Created `/scripts/` for utility scripts - Created `/docs/guides/` for user guides - Created `/docs/development/` for dev documentation - Created `/docs/archive/` for historical/legacy docs ### Moved Files: **To `/scripts/` (7 files):** - backup_claude_os.sh - restore_claude_os.sh - run_tests.sh - setup_native.sh - start_mcp_server.sh - start_redis_workers.sh - entrypoint.sh **To `/docs/guides/` (7 files):** - AUTH_SETUP.md - BACKUP_RESTORE_GUIDE.md - HOOK_SETUP_QUICK_START.md - SHARING_GUIDE.md - START_SCRIPTS_GUIDE.md - PORTS_GUIDE.md - WHAT_IS_CLAUDE_OS.md **To `/docs/development/` (4 files):** - COMPREHENSIVE_REVIEW.md - SECURITY_FIXES.md - CLAUDE_OS_DEVELOPER_GUIDE.md - PROJECT_SETUP_AND_COMMANDS.md **To `/docs/archive/` (10 files):** - HYBRID_INDEXING_COMPLETE.md - INITIALIZE_PROJECT_HOOKS_FIX.md - INSTALL_ENHANCEMENTS.md - INSTALL_FIXES.md - PISTN_TEST_RESULTS.md - SESSION_SUMMARY.md - TEST_COVERAGE.md - TEST_RESULTS.md - TESTING_STATUS.md - README_TESTING.md ### Updated References: **Fixed broken documentation links in:** - docs/QUICK_REFERENCE.md - docs/PRODUCTION_DEPLOYMENT.md - docs/SCRIPTS_GUIDE.md - docs/development/SECURITY_FIXES.md - docs/guides/BACKUP_RESTORE_GUIDE.md - docs/development/CLAUDE_OS_DEVELOPER_GUIDE.md - tests/TESTING_GUIDE.md - tests/TEST_COVERAGE.md **Script references updated to:** - `./scripts/backup_claude_os.sh` - `./scripts/restore_claude_os.sh` - `./scripts/run_tests.sh` - `./scripts/setup_native.sh` - `./scripts/start_mcp_server.sh` - `./scripts/start_redis_workers.sh` ### Remaining in Root (9 essential files): - install.sh - setup.sh - start.sh - start_all_services.sh - stop_all_services.sh - restart_services.sh - README.md - CLAUDE.md - requirements.txt (+ GEMINI_DIAGRAM_PROMPT.md) ## Benefits: ✅ Cleaner root directory (9 files vs 34 files) ✅ Organized documentation by purpose ✅ Scripts grouped in dedicated directory ✅ Essential startup commands still in root ✅ All references updated and verified ✅ No broken links Version: 2.0.2
8.4 KiB
Claude OS Sharing Guide
Overview
This guide explains how to share Claude OS with coworkers and set up new projects.
Architecture
claude-os/
├── templates/ # All reusable templates
│ ├── commands/ # Slash commands (symlinked to ~/.claude/)
│ ├── skills/ # Skills (symlinked to ~/.claude/)
│ ├── agents/ # Agent-OS agents (8 specialized agents)
│ └── project-files/ # Files created during project init
│ ├── CLAUDE.md.template
│ ├── agent-os/ # Agent-OS project templates
│ └── .claude-os/ # Config templates
├── cli/ # CLI tools
│ └── claude-os-consolidate.sh
├── install.sh # One-command install for coworkers
└── app/ # Flask API server
For You (Initial Setup)
Step 1: Consolidate Your Files
Move all scattered commands and skills into templates/:
cd /Users/iamanmp/Projects/claude-os
./cli/claude-os-consolidate.sh
This will:
- Move commands from
~/.claude/commands/→templates/commands/ - Move skills from
~/.claude/skills/→templates/skills/ - Create symlinks so everything still works for you
- Update any hardcoded paths
Step 2: Commit to Git
cd /Users/iamanmp/Projects/claude-os
git add templates/ cli/ install.sh SHARING_GUIDE.md
git commit -m "Add templates and installation system for sharing"
git push
Step 3: Test Installation (Optional)
Test on a different machine or user account:
git clone your-repo/claude-os.git
cd claude-os
./install.sh
For Coworkers (First Time Setup)
Step 1: Clone Claude OS
git clone your-repo/claude-os.git
cd claude-os
Step 2: Run Install Script
./install.sh
This will:
- ✅ Create
~/.claude/directories - ✅ Symlink all commands and skills
- ✅ Optional: Install Agent-OS (8 agents by Builder Methods)
- ✅ Ask about AI provider (Ollama or OpenAI)
- ✅ Set up Python virtual environment
- ✅ Install dependencies
- ✅ Configure MCP server
- ✅ Create start script
Note: Agent-OS is an optional integration created by Builder Methods (CasJam Media LLC) and MIT licensed. The installer will ask if you want to install it.
Step 3: Start Claude OS
./start.sh
This starts the MCP server at http://localhost:8051
Step 4: Initialize Their First Project
cd /path/to/their/project
In Claude Code, run:
/claude-os-init
Follow the prompts to:
- Name the project
- Specify tech stack
- Ingest documentation
- Analyze codebase
Done! Their project is now connected to Claude OS.
For New Projects (After Setup)
Once Claude OS is installed, initializing new projects is simple:
cd /path/to/new/project
In Claude Code:
/claude-os-init
Answer the questions and you're done!
What Gets Created During Project Init
your-project/
├── CLAUDE.md # Project context (auto-loaded every session)
├── .claude/ # Project-specific Claude Code files
│ ├── commands/ # (symlinks to Claude OS templates)
│ ├── skills/ # (symlinks to Claude OS templates)
│ ├── agents/ # Project-specific agents
│ ├── ARCHITECTURE.md # Generated by initialize-project
│ ├── CODING_STANDARDS.md
│ └── DEVELOPMENT_PRACTICES.md
└── .claude-os/ # Claude OS state/config
├── config.json # Project configuration
├── hooks.json # Project hooks
└── .gitignore # State files ignored
Knowledge Bases Created
Each project gets 4 knowledge bases:
{project}-project_memories- Claude's memory for decisions, patterns, solutions{project}-project_profile- Architecture, standards, practices{project}-project_index- Automated codebase index{project}-knowledge_docs- Your documentation (auto-ingested)
Commands Available After Setup
All these work in any initialized project:
/claude-os-init- Initialize new project/claude-os-search- Search project memories/claude-os-save- Save insights/claude-os-remember- Quick save to memories/claude-os-list- List knowledge bases/claude-os-session- Manage dev sessions/claude-os-triggers- Manage trigger phrases
Skills Available
initialize-project- Analyze codebase and generate standardsremember-this- Auto-save when you say "remember this:"memory- Simple memory management
Agent-OS Commands (If Installed)
If you chose to install Agent-OS during setup, you also get these commands:
/new-spec- Initialize a new feature specification/create-spec- Full specification workflow/plan-product- Create product documentation/implement-spec- Implement a specification
Agent-OS is created by Builder Methods (CasJam Media LLC) and provides 8 specialized agents for spec-driven development. Learn more at https://github.com/builder-methods/agent-os
Benefits for Your Team
One-Time Setup
- Clone repo → run install → done
- No configuration needed
- Works on Mac/Linux (Windows with WSL)
Project Isolation
- Each project has its own knowledge bases
- No cross-contamination
- Team members can work on multiple projects
AI Memory Across Sessions
- Claude remembers decisions across conversations
- Searchable history of all work
- Pattern recognition improves over time
Documentation Integration
- Automatically indexes your docs
- Searchable alongside code context
- Always up to date
Updating Claude OS
When you add new commands/skills to templates:
# On your machine:
cd /Users/iamanmp/Projects/claude-os
git pull origin main
# Commands/skills auto-update via symlinks!
Coworkers do the same:
cd ~/Projects/claude-os
git pull origin main
# Their symlinks automatically point to updated templates
Troubleshooting
"Command not found: /claude-os-init"
Symlinks weren't created. Re-run:
cd /path/to/claude-os
./install.sh
"Connection refused to localhost:8051"
Claude OS server isn't running:
cd /path/to/claude-os
./start.sh
"Project already exists"
Project name is taken. Choose a different name or delete the old project via the UI at http://localhost:8051
Commands work but changes don't persist
Make sure you're committing changes to the Claude OS repo, not your project repo:
cd /path/to/claude-os # NOT your project dir
git status
git add templates/
git commit -m "Updated templates"
git push
Adding Custom Commands/Skills
Add a New Command
- Create file in
templates/commands/my-command.md - Write command logic (see existing commands for examples)
- Commit to git
- Coworkers pull and get it automatically via symlinks
Add a New Skill
- Create directory in
templates/skills/my-skill/ - Add
SKILL.mdand any scripts - Commit to git
- Coworkers pull and get it automatically
Security Notes
.claude-os/state files are git-ignored by default- Never commit API keys or secrets to CLAUDE.md
- Each team member has their own Claude OS database
- Knowledge bases are local, not shared (unless you want to sync them)
FAQ
Q: Do I need to reinstall for each project?
A: No! Install Claude OS once, then just run /claude-os-init in each project.
Q: Can multiple people work on the same project? A: Yes! Each person has their own Claude OS database. Shared project knowledge goes in CLAUDE.md (git-tracked).
Q: What if someone doesn't have Claude Code? A: They need Claude Code (the CLI tool) to use this. Free at https://claude.com/claude-code
Q: How much disk space does it use? A: ~500MB for Claude OS + dependencies. Each project's knowledge base is ~10-100MB depending on docs.
Q: Does this work on Windows? A: Yes, with WSL (Windows Subsystem for Linux). Native Windows support coming soon.
Support
- 📚 Documentation: See README.md in this repo
- 🐛 Issues: Open an issue on GitHub
- 💬 Questions: Ask in team chat or @ the maintainer
Next Steps
- For you: Run
./cli/claude-os-consolidate.shto organize your files - For coworkers: Share the repo URL and have them run
./install.sh - For new projects: Just run
/claude-os-initand answer questions
You built this! Now share it and make your whole team invincible! 🚀