@ariso-ai/ivan 1.0.2 → 1.0.3
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 +21 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -98,19 +98,33 @@ Then describe what you want to accomplish. Ivan will:
|
|
|
98
98
|
|
|
99
99
|
#### Non-Interactive Mode (Headless)
|
|
100
100
|
|
|
101
|
-
Run Ivan with a
|
|
101
|
+
Run Ivan with a JSON configuration file:
|
|
102
102
|
|
|
103
103
|
```bash
|
|
104
|
-
#
|
|
105
|
-
ivan
|
|
104
|
+
# Run with a config file
|
|
105
|
+
ivan -c path/to/config.json
|
|
106
|
+
ivan --config path/to/config.json
|
|
107
|
+
```
|
|
106
108
|
|
|
107
|
-
|
|
108
|
-
ivan "Refactor the database module" --no-wait
|
|
109
|
+
**Configuration file format:**
|
|
109
110
|
|
|
110
|
-
|
|
111
|
-
|
|
111
|
+
```json
|
|
112
|
+
{
|
|
113
|
+
"tasks": ["Add user authentication with JWT tokens", "Add tests for auth module"],
|
|
114
|
+
"generateSubtasks": false,
|
|
115
|
+
"prStrategy": "multiple",
|
|
116
|
+
"waitForComments": false,
|
|
117
|
+
"workingDir": "/path/to/repo"
|
|
118
|
+
}
|
|
112
119
|
```
|
|
113
120
|
|
|
121
|
+
**Configuration options:**
|
|
122
|
+
- `tasks` (required): Array of task descriptions
|
|
123
|
+
- `generateSubtasks` (optional): For single tasks, whether to break them down into subtasks. Only applies when `tasks` has one item
|
|
124
|
+
- `prStrategy` (optional): `"single"` (one PR for all tasks) or `"multiple"` (one PR per task, default)
|
|
125
|
+
- `waitForComments` (optional): Wait 30 minutes for PR reviews and automatically address comments (default: false)
|
|
126
|
+
- `workingDir` (optional): Repository path to execute tasks in (defaults to current directory)
|
|
127
|
+
|
|
114
128
|
Non-interactive mode is perfect for:
|
|
115
129
|
- CI/CD pipelines
|
|
116
130
|
- Automated workflows
|