thought-cabinet 0.1.3 → 0.1.8

package/README.md

@@ -69,30 +69,24 @@ cd your-project
 thc agent init
 ```
 
-This interactively installs to `.claude/`:
-- **Commands** - Slash commands for workflow phases (`/research_codebase`, `/create_plan`, etc.)
+This interactively discovers and installs assets to your agent's config directory (e.g. `.claude/`):
+
 - **Agents** - Specialized sub-agents for code analysis and research
-- **Skills** - Extended capabilities like document generation
-- **Settings** - Project permissions and configuration
+- **Skills** - Extended capabilities like structured workflows and document generation
 
-Options:
-```bash
-thc agent init --all              # Copy all files without prompting
-thc agent init --force            # Overwrite existing .claude directory
-thc agent init --name codebuddy   # Use alternative agent (codebuddy)
-```
+Assets are installed via **symlink** by default: a canonical copy is stored in `.thought-cabinet/` (project) or `~/.config/thought-cabinet/` (global), and symlinks are created in the agent's config directory. This means updating the canonical copy updates all agents at once.
 
 ### Slash Commands
 
 These commands guide the AI through each phase of development:
 
-| Command | Purpose |
-|---------|---------|
+| Command              | Purpose                                                               |
+| -------------------- | --------------------------------------------------------------------- |
 | `/research_codebase` | Deep-dive into codebase, save findings to `thoughts/shared/research/` |
-| `/create_plan` | Create implementation plan with phases and success criteria |
-| `/iterate_plan` | Refine existing plans based on feedback |
-| `/implement_plan` | Execute plan phase-by-phase with verification |
-| `/validate_plan` | Verify implementation against plan's success criteria |
+| `/create_plan`       | Create implementation plan with phases and success criteria           |
+| `/iterate_plan`      | Refine existing plans based on feedback                               |
+| `/implement_plan`    | Execute plan phase-by-phase with verification                         |
+| `/validate_plan`     | Verify implementation against plan's success criteria                 |
 
 ### Context Offloading
 
@@ -128,6 +122,7 @@ cat thoughts/yourusername/gotchas.md
 ```
 
 All thoughts are git-tracked, so you can:
+
 - Share knowledge with team members via `thc sync`
 - See how understanding evolved over time
 - Recover context even after months
@@ -233,6 +228,7 @@ thc init
 ```
 
 This sets up:
+
 - A global thoughts repository (default: `~/thoughts`)
 - Directory structure for this project
 - Git hooks for protection and auto-sync
@@ -269,9 +265,11 @@ thc worktree merge feature-name
 ### Agent Configuration
 
 ```bash
-thc agent init            # Install Claude Code slash commands, agents, and skills
-thc agent init --all      # Install all without prompting
-thc agent init --force    # Overwrite existing configuration
+thc agent init                    # Interactively install agents and skills
+thc agent init --all              # Install all without prompting (symlink mode)
+thc agent init --force            # Overwrite existing installations
+thc agent init --agent cursor     # Install for a specific agent
+thc agent init --global           # Install to global scope
 ```
 
 ### Thoughts Management
@@ -322,9 +320,7 @@ Configure hooks in `.thought-cabinet/hooks.json` to run commands on events:
   "hooks": {
     "PostWorktreeAdd": [
       {
-        "hooks": [
-          { "type": "command", "command": "npm install", "timeout": 300 }
-        ]
+        "hooks": [{ "type": "command", "command": "npm install", "timeout": 300 }]
       }
     ]
   }
@@ -332,6 +328,7 @@ Configure hooks in `.thought-cabinet/hooks.json` to run commands on events:
 ```
 
 **Available events:**
+
 - `PreWorktreeAdd`, `PostWorktreeAdd` - Worktree creation
 - `PreWorktreeMerge`, `PostWorktreeMerge` - Worktree merge
 - `PostThoughtsInit`, `PostThoughtsDestroy`, `PostThoughtsSync` - Thoughts lifecycle
@@ -339,6 +336,7 @@ Configure hooks in `.thought-cabinet/hooks.json` to run commands on events:
 ### Git Hooks
 
 Automatically installed git hooks:
+
 - **pre-commit**: Prevents accidental commits of `thoughts/` directory
 - **post-commit**: Auto-syncs thoughts after each commit
 
@@ -358,12 +356,14 @@ your-project/
 ## Best Practices
 
 **For AI-assisted development:**
+
 - Always run `/research_codebase` before planning complex features
 - Use `/create_plan` to make implementation explicit and verifiable
 - Implement in worktrees for maximum throughput
 - Run `/validate_plan` before merging to catch deviations
 
 **General tips:**
+
 - Run `thc sync` frequently to share knowledge
 - Use `thc prune` to clean up stale mappings