Skip to content

Commit 6277bfd

Browse files
docs: update README.md for CLI accuracy
Updated the Usage section of README.md to accurately reflect current CLI capabilities, including missing flags for init, apply, clean, status, and skill commands. - Added --path and --force for init. - Added --path for apply and clean. - Added --project-root and --json for status. - Added --project-root, --source, and --json for skill commands. - Removed unimplemented list subcommand from skill documentation. Co-authored-by: yacosta738 <33158051+yacosta738@users.noreply.github.com>
1 parent b202ac1 commit 6277bfd

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -199,23 +199,35 @@ agentsync apply
199199
## Usage
200200

201201
```bash
202-
# Initialize a new configuration
202+
# Initialize a new configuration (in current directory)
203203
agentsync init
204204

205+
# Initialize configuration in a specific directory
206+
agentsync init --path /path/to/project
207+
208+
# Overwrite existing configuration without prompting
209+
agentsync init --force
210+
205211
# Initialize with interactive wizard (for existing projects with agent files)
206212
agentsync init --wizard
207213

208214
# Apply configuration (create symlinks)
209215
agentsync apply
210216

217+
# Use a custom config file
218+
agentsync apply --config /path/to/config.toml
219+
220+
# Specify a project root directory
221+
agentsync apply --path /path/to/project
222+
211223
# Clean existing symlinks before applying
212224
agentsync apply --clean
213225

214226
# Remove all managed symlinks
215227
agentsync clean
216228

217-
# Use a custom config file
218-
agentsync apply --config /path/to/config.toml
229+
# Clean symlinks in a specific project
230+
agentsync clean --path /path/to/project
219231

220232
# Dry run (show what would be done without making changes)
221233
agentsync apply --dry-run
@@ -230,15 +242,15 @@ agentsync apply --no-gitignore
230242
agentsync apply --verbose
231243

232244
# Show status of managed symlinks
233-
agentsync status
245+
agentsync status [--project-root <path>] [--json]
234246

235247
# Run diagnostic and health check
236248
agentsync doctor [--project-root <path>]
237249

238250
# Manage skills
239-
agentsync skill install <skill-id>
240-
agentsync skill update <skill-id>
241-
agentsync skill uninstall <skill-id>
251+
agentsync skill [--project-root <path>] install <skill-id> [--source <source>] [--json]
252+
agentsync skill [--project-root <path>] update <skill-id> [--source <source>] [--json]
253+
agentsync skill [--project-root <path>] uninstall <skill-id> [--json]
242254
```
243255

244256
### Status

0 commit comments

Comments
 (0)