@@ -14,7 +14,6 @@ A comprehensive developer assistant that streamlines your coding workflow with a
1414- [ Installation] ( #installation )
1515- [ Basic Usage] ( #basic-usage )
1616- [ Configuration] ( #configuration )
17- - [ Hooks System] ( #hooks-system )
1817- [ AI Features] ( #ai-features )
1918- [ Issue Provider Integration] ( #issue-provider-integration )
2019- [ Advanced Usage] ( #advanced-usage )
@@ -36,18 +35,14 @@ workie begin feature/new-ui
3635
3736# List worktrees
3837workie --list
39-
40- # Ask AI about your code
41- workie ask " What does this function do?"
4238```
4339
4440## Features
4541
4642### Core Features
4743
4844- 🌳 ** Smart Git Worktree Management** - Create and manage git worktrees effortlessly
49- - 🤖 ** AI-Powered Assistant** - Ask questions and get intelligent responses about your codebase
50- - 🪝 ** Comprehensive Hooks System** - Automate workflows with lifecycle and Claude Code hooks
45+ - 🤖 ** AI-Powered Assistant** - Generate branch names and commit messages from issue details
5146- 📋 ** Issue Provider Integration** - Connect with GitHub, Jira, and Linear
5247- 🔔 ** System Notifications** - Get alerts for important events
5348- 📁 ** Smart File Copying** - Automatically copy essential files to new worktrees
@@ -109,50 +104,12 @@ workie -l
109104# Remove a worktree
110105workie finish feature/completed-work
111106workie finish feature/old-branch --prune-branch
112- ```
113-
114- ### AI Assistant
115-
116- ``` bash
117- # Ask questions about your codebase
118- workie ask " What does the main function do?"
119- workie ask " How do I add a new provider?"
120-
121- # Use AI with tools
122- workie ask -t " Create a commit message for my changes"
123- workie ask -t " List all test files"
124107
125108# Create AI-powered branch names from issues
126109workie begin --issue 123 --ai
127110workie begin --issue github:456 --ai
128111```
129112
130- ### Hooks Management
131-
132- ``` bash
133- # List configured hooks
134- workie hooks list
135-
136- # Test all hooks
137- workie hooks test
138-
139- # Run specific hooks
140- workie hooks run post_create
141- workie hooks run claude_notification
142-
143- # Generate Claude Code settings configuration
144- workie hooks claude-config
145-
146- # Generate config with AI optimization
147- workie hooks claude-config --ai
148-
149- # Generate for specific hooks only
150- workie hooks claude-config --hooks pre_tool_use,stop
151-
152- # Save to file
153- workie hooks claude-config --output ~ /.claude/settings.json
154- ```
155-
156113### Conflict Monitoring
157114
158115``` bash
@@ -189,14 +146,6 @@ files_to_copy:
189146
190147# Default issue provider
191148default_provider : github
192-
193- # Basic hooks
194- hooks :
195- post_create :
196- - " npm install"
197- - " cp .env.example .env"
198- pre_remove :
199- - " git status"
200149` ` `
201150
202151### Initializing Configuration
@@ -214,81 +163,6 @@ workie init --output my-config.yaml
214163workie init --force
215164```
216165
217- ## Hooks System
218-
219- Hooks allow you to automate tasks at different stages of your workflow.
220-
221- ### Lifecycle Hooks
222-
223- ``` yaml
224- hooks :
225- # After creating a worktree
226- post_create :
227- - " echo 'Welcome to your new worktree!'"
228- - " npm install"
229-
230- # Before removing a worktree
231- pre_remove :
232- - " echo 'Cleaning up...'"
233- - " git status"
234- ` ` `
235-
236- ### Claude Code Integration
237-
238- > ⚠️ **EXPERIMENTAL FEATURE** - Claude Code hooks are unofficial and may break without warning.
239-
240- ` ` ` yaml
241- hooks :
242- # Before Claude uses a tool
243- claude_pre_tool_use :
244- - ' echo "Tool: $TOOL_NAME" >> activity.log'
245-
246- # After Claude uses a tool
247- claude_post_tool_use :
248- - ' test "$TOOL_NAME" = "Edit" && npm run lint'
249-
250- # When Claude sends notifications
251- claude_notification :
252- - ' echo "Notification: $MESSAGE"'
253-
254- # Enable system notifications
255- system_notifications :
256- enabled : true
257- title : " Workie Alert"
258- ` ` `
259-
260- ### AI-Powered Hook Decisions
261-
262- ` ` ` yaml
263- hooks :
264- claude_pre_tool_use :
265- - ' security-check.sh'
266-
267- # Enable AI decision making
268- ai_decision :
269- enabled : true
270- model : " zephyr"
271- strict_mode : false
272- ` ` `
273-
274- ### Watch Configuration
275-
276- Monitor your worktree branches for potential rebase conflicts:
277-
278- ` ` ` yaml
279- watch :
280- enabled : true
281- interval_minutes : 5 # Check frequency
282- notify_on_conflicts : true # Send system notifications
283- port : 8080 # HTTP server port
284- branches_to_ignore : # Glob patterns to ignore
285- - " experimental/*"
286- - " tmp/*"
287- - " wip/*"
288- ` ` `
289-
290- For detailed hook documentation, see [docs/hooks.md](docs/hooks.md).
291-
292166## AI Features
293167
294168### Setup
@@ -320,22 +194,6 @@ workie begin --issue 123
320194workie begin --issue 123 --ai
321195```
322196
323- # ## Code Assistant
324-
325- ` ` ` bash
326- # Understanding code
327- workie ask "What does the WorktreeManager do?"
328-
329- # Finding files
330- workie ask -t "Find all test files for authentication"
331-
332- # Generating code
333- workie ask -t "Create a unit test for parseIssueReference"
334-
335- # Git operations
336- workie ask -t "Show me the last 5 commits"
337- ` ` `
338-
339197## Issue Provider Integration
340198
341199### GitHub
@@ -419,93 +277,6 @@ your-project-worktrees/ # Created automatically
419277 └── scripts/ # ✓ Copied recursively
420278```
421279
422- ### Claude Code Settings Integration
423-
424- To use Workie hooks with Claude Code:
425-
426- #### Automatic Configuration Generation
427-
428- Use the `claude-config` command to generate the required settings:
429-
430- ```bash
431- # Generate configuration for all configured hooks
432- workie hooks claude-config
433-
434- # Use AI to generate optimal configuration
435- workie hooks claude-config --ai
436-
437- # Generate for specific hooks only
438- workie hooks claude-config --hooks pre_tool_use,post_tool_use,stop
439-
440- # Save directly to Claude settings
441- workie hooks claude-config --output ~/.claude/settings.json
442-
443- # Append to existing settings (merge manually)
444- workie hooks claude-config >> claude-hooks.json
445- ```
446-
447- #### Manual Configuration
448-
449- 1 . Edit Claude settings (` ~/.claude/settings.json ` ):
450-
451- ``` json
452- {
453- "hooks" : {
454- "PreToolUse" : [
455- {
456- "matcher" : " Write|Edit|Bash" ,
457- "hooks" : [
458- {
459- "type" : " command" ,
460- "command" : " workie hooks run claude_pre_tool_use"
461- }
462- ]
463- }
464- ],
465- "PostToolUse" : [
466- {
467- "matcher" : " Edit" ,
468- "hooks" : [
469- {
470- "type" : " command" ,
471- "command" : " workie hooks run claude_post_tool_use"
472- }
473- ]
474- }
475- ],
476- "Stop" : [
477- {
478- "hooks" : [
479- {
480- "type" : " command" ,
481- "command" : " workie hooks run claude_stop"
482- }
483- ]
484- }
485- ]
486- }
487- }
488- ```
489-
490- 2 . Configure Workie hooks in ` .workie.yaml `
491- 3 . Test: ` workie hooks test `
492-
493- ### Security Policy Example
494-
495- ``` yaml
496- hooks :
497- claude_pre_tool_use :
498- - |
499- case "$TOOL_NAME" in
500- Write|Edit)
501- if [[ "$1" =~ ^/etc/|^/sys/ ]]; then
502- echo "BLOCKED: System file modification" >&2
503- exit 1
504- fi
505- ;;
506- esac
507- ` ` `
508-
509280## Troubleshooting
510281
511282### Common Issues
@@ -528,15 +299,6 @@ ollama list
528299ollama pull zephyr
529300```
530301
531- ** Hooks not triggering:**
532- ``` bash
533- # Test hooks manually
534- workie hooks test
535-
536- # Check Claude Code settings
537- cat ~ /.claude/settings.json
538- ```
539-
540302### Getting Help
541303
542304``` bash
@@ -557,7 +319,6 @@ workie --version
5573193 . ** Worktree Creation** : Creates ` <repo>-worktrees/ ` directory
5583204 . ** Branch Management** : Creates new branches in separate worktrees
5593215 . ** File Copying** : Copies configured files to new worktrees
560- 6 . ** Hook Execution** : Runs configured hooks at appropriate times
561322
562323## Vision
563324
0 commit comments