From 6277bfdcbd85bc30e2038162f29e7a76c66117fa Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 14 Feb 2026 23:40:22 +0000 Subject: [PATCH] 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> --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1743511..da4f56b 100644 --- a/README.md +++ b/README.md @@ -199,23 +199,35 @@ agentsync apply ## Usage ```bash -# Initialize a new configuration +# Initialize a new configuration (in current directory) agentsync init +# Initialize configuration in a specific directory +agentsync init --path /path/to/project + +# Overwrite existing configuration without prompting +agentsync init --force + # Initialize with interactive wizard (for existing projects with agent files) agentsync init --wizard # Apply configuration (create symlinks) agentsync apply +# Use a custom config file +agentsync apply --config /path/to/config.toml + +# Specify a project root directory +agentsync apply --path /path/to/project + # Clean existing symlinks before applying agentsync apply --clean # Remove all managed symlinks agentsync clean -# Use a custom config file -agentsync apply --config /path/to/config.toml +# Clean symlinks in a specific project +agentsync clean --path /path/to/project # Dry run (show what would be done without making changes) agentsync apply --dry-run @@ -230,15 +242,15 @@ agentsync apply --no-gitignore agentsync apply --verbose # Show status of managed symlinks -agentsync status +agentsync status [--project-root ] [--json] # Run diagnostic and health check agentsync doctor [--project-root ] # Manage skills -agentsync skill install -agentsync skill update -agentsync skill uninstall +agentsync skill [--project-root ] install [--source ] [--json] +agentsync skill [--project-root ] update [--source ] [--json] +agentsync skill [--project-root ] uninstall [--json] ``` ### Status