software-engineer 0.1.21 → 0.1.22
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 +24 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,6 +13,26 @@ npm install -g software-engineer
|
|
|
13
13
|
- Node.js >= 18.0.0
|
|
14
14
|
- [Claude CLI](https://github.com/anthropics/claude-code) installed and configured
|
|
15
15
|
|
|
16
|
+
## Recommended Workflow
|
|
17
|
+
|
|
18
|
+
For best results, follow this workflow:
|
|
19
|
+
|
|
20
|
+
1. **Plan with Claude**: Start a Claude session and use plan mode to design what needs to be done
|
|
21
|
+
- Discuss requirements with Claude
|
|
22
|
+
- Iterate and refine the plan until it's complete
|
|
23
|
+
- Claude will generate a plan file (usually a `.md` file)
|
|
24
|
+
|
|
25
|
+
2. **Execute with software-engineer**: Once your plan is finalized, close Claude and run:
|
|
26
|
+
```bash
|
|
27
|
+
sf "implement the plan mentioned in /path/to/plan.md"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
3. **Wait for completion**: The tool will automatically execute the entire pipeline and implement your plan
|
|
31
|
+
|
|
32
|
+
This approach gives you the best of both worlds:
|
|
33
|
+
- **Interactive planning** with Claude to ensure the approach is correct
|
|
34
|
+
- **Automated execution** with comprehensive quality checks
|
|
35
|
+
|
|
16
36
|
## Usage
|
|
17
37
|
|
|
18
38
|
```bash
|
|
@@ -22,7 +42,10 @@ sf "<requirement>"
|
|
|
22
42
|
### Examples
|
|
23
43
|
|
|
24
44
|
```bash
|
|
25
|
-
#
|
|
45
|
+
# Recommended: Use with a plan file from Claude
|
|
46
|
+
sf "implement the plan mentioned in ./docs/feature-plan.md"
|
|
47
|
+
|
|
48
|
+
# Basic usage with direct requirement
|
|
26
49
|
sf "add user authentication with JWT"
|
|
27
50
|
|
|
28
51
|
# Custom review iterations
|
package/package.json
CHANGED