You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-6Lines changed: 33 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,39 @@ To get started with **`awos`**, you'll need a couple of things set up first:
20
20
21
21
### Step 1: Install `awos`
22
22
23
-
First, open your terminal, create a new directory for your project, and run this single command. It will set up everything you need.
23
+
First, open your terminal, create a new directory for your project, and run the installer with the required `--agent` flag. This will set up everything you need.
24
+
25
+
**For Claude Code:**
26
+
27
+
```sh
28
+
npx @provectusinc/awos --agent claude
29
+
```
30
+
31
+
**For GitHub Copilot:**
24
32
25
33
```sh
26
-
npx @provectusinc/awos
34
+
npx @provectusinc/awos --agent copilot
27
35
```
28
36
37
+
**Note:** The `--agent` flag is mandatory and specifies which AI agent you'll be using. Currently supported agents are `claude` and `copilot`.
38
+
39
+
### CLI Flags Reference
40
+
41
+
**Required Flags:**
42
+
43
+
-`--agent <agent-name>` - Specifies which AI agent to configure (required)
-`--force-overwrite` - Overwrites all files, including customizations
50
+
- Use case: Updating to latest version
51
+
- Example: `npx @provectusinc/awos --agent claude --force-overwrite`
52
+
-`--dry-run` - Preview changes without modifying files
53
+
- Use case: Testing before installation
54
+
- Example: `npx @provectusinc/awos --agent claude --dry-run`
55
+
29
56
### Step 2: Follow the Workflow
30
57
31
58
**`awos`** guides you through a logical, step-by-step process. You'll use a series of "agents" to define, plan, and build your product. Run the commands in the following order.
@@ -145,10 +172,10 @@ Refer to the instructions located in this file: .awos/commands/implement.md
145
172
146
173
### Normal Update
147
174
148
-
To update **`awos`** to the latest version, run the installer again:
175
+
To update **`awos`** to the latest version, run the installer again with the `--agent` flag:
149
176
150
177
```sh
151
-
npx @provectusinc/awos
178
+
npx @provectusinc/awos --agent claude
152
179
```
153
180
154
181
**What gets updated:**
@@ -160,10 +187,10 @@ npx @provectusinc/awos
160
187
161
188
### Force Update
162
189
163
-
To update **`awos`** to the latest version, run the installer again with the `--force-overwrite`flag:
190
+
To update **`awos`** to the latest version, run the installer again with both the `--agent` and `--force-overwrite`flags:
164
191
165
192
```sh
166
-
npx @provectusinc/awos --force-overwrite
193
+
npx @provectusinc/awos --agent claude --force-overwrite
167
194
```
168
195
169
196
**Important:** The `--force-overwrite` flag will overwrite existing files in `.claude/commands/awos` and `.claude/agents`.
0 commit comments