hone-ai 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,14 +22,28 @@ Transform feature ideas into working code through autonomous development with hu
22
22
  hone init
23
23
  ```
24
24
 
25
- 4. **Create a feature**
26
- ```bash
27
- hone prd "Add user login with email and password"
28
- hone prd-to-tasks .plans/prd-user-login.md
29
- hone run .plans/tasks-user-login.yml -i 3
30
- ```
25
+ That's it! You're ready to use hone.
26
+
27
+ ## Common Workflow
28
+
29
+ ```bash
30
+ # 1. Generate project documentation (if no AGENTS.md exists)
31
+ hone agents-md
32
+
33
+ # 2. Create a PRD from your feature description
34
+ hone prd "Add user login with email and password"
31
35
 
32
- That's it! hone will implement the feature, run tests, and commit changes automatically.
36
+ # 3. Manually review the generated PRD
37
+ # Edit .plans/prd-user-login.md as needed
38
+
39
+ # 4. Generate tasks from the PRD
40
+ hone prd-to-tasks .plans/prd-user-login.md
41
+
42
+ # 5. Implement the feature
43
+ hone run .plans/tasks-user-login.yml -i 10
44
+ ```
45
+
46
+ hone will implement the feature, run tests, and commit changes automatically.
33
47
 
34
48
  ## Prerequisites
35
49
 
@@ -77,14 +91,16 @@ cp hone-macos /usr/local/bin/hone # macOS
77
91
  cp hone-linux /usr/local/bin/hone # Linux
78
92
  ```
79
93
 
80
- ## Common Commands
94
+ ## Commands
81
95
 
82
96
  ### Create and implement a feature
83
97
 
84
98
  ```bash
99
+ hone agents-md # Generate AGENTS.md (first time only)
85
100
  hone prd "Feature description" # Generate requirements
101
+ # Review .plans/prd-<feature>.md manually
86
102
  hone prd-to-tasks .plans/prd-feature.md # Generate tasks
87
- hone run .plans/tasks-feature.yml -i 5 # Implement tasks
103
+ hone run .plans/tasks-feature.yml -i 10 # Implement tasks
88
104
  ```
89
105
 
90
106
  ### Reference files and URLs in PRDs
@@ -148,11 +164,13 @@ Each `hone run` executes multiple iterations of this cycle automatically.
148
164
  When creating PRDs, you can reference files and URLs directly in your feature description:
149
165
 
150
166
  **Local files:**
167
+
151
168
  - `./docs/api-spec.md` - Read project documentation
152
169
  - `src/components/Button.tsx` - Analyze existing components
153
170
  - `./database/schema.sql` - Review database structure
154
171
 
155
172
  **URLs:**
173
+
156
174
  - `https://docs.stripe.com/api` - External API documentation
157
175
  - `https://www.figma.com/design/123/App` - Design specifications
158
176
  - `http://localhost:3000/dashboard` - Reference existing pages
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hone-ai",
3
- "version": "0.11.0",
3
+ "version": "0.12.0",
4
4
  "description": "AI coding agent orchestrator - orchestrate AI agents to implement features based on PRDs",
5
5
  "keywords": [
6
6
  "ai",
package/src/index.ts CHANGED
@@ -36,6 +36,13 @@ program
36
36
  .addHelpText(
37
37
  'after',
38
38
  `
39
+ Common Workflow:
40
+ hone agents-md # Generate AGENTS.md (if none exists)
41
+ hone prd "your feature description" # Create a PRD
42
+ # Manually review .plans/prd-<feature>.md
43
+ hone prd-to-tasks .plans/prd-<feature>.md # Generate tasks from PRD
44
+ hone run .plans/tasks-<feature>.yml -i 10 # Implement the feature
45
+
39
46
  Model Configuration:
40
47
  Configure models in .plans/hone.config.yml:
41
48