Skip to content

Commit f97c346

Browse files
chore: update Readme to reflect cli flags changes
1 parent 5866474 commit f97c346

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,39 @@ To get started with **`awos`**, you'll need a couple of things set up first:
2020

2121
### Step 1: Install `awos`
2222

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:**
2432

2533
```sh
26-
npx @provectusinc/awos
34+
npx @provectusinc/awos --agent copilot
2735
```
2836

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)
44+
- Supported values: `claude`, `copilot`
45+
- Example: `npx @provectusinc/awos --agent claude`
46+
47+
**Optional Flags:**
48+
49+
- `--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+
2956
### Step 2: Follow the Workflow
3057

3158
**`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
145172

146173
### Normal Update
147174

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:
149176

150177
```sh
151-
npx @provectusinc/awos
178+
npx @provectusinc/awos --agent claude
152179
```
153180

154181
**What gets updated:**
@@ -160,10 +187,10 @@ npx @provectusinc/awos
160187

161188
### Force Update
162189

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:
164191

165192
```sh
166-
npx @provectusinc/awos --force-overwrite
193+
npx @provectusinc/awos --agent claude --force-overwrite
167194
```
168195

169196
**Important:** The `--force-overwrite` flag will overwrite existing files in `.claude/commands/awos` and `.claude/agents`.

0 commit comments

Comments
 (0)