Common flags (apply to most commands):
| Flag | Purpose |
|---|---|
--only <a,b,c> | Restrict to comma-separated agents |
--skip <a,b,c> | Auto-detect minus these |
--api-key <key> | Use this API key without prompting |
--yes, -y | Skip confirmation prompts |
--json | Machine-readable output |
--verbose, -v | Show every file write and HTTP call (redacted) |
--quiet, -q | Errors only |
--no-color | Disable ANSI colors |
--dry-run | Show what would be done; touch no files |
install
- Idempotent: re-running with no underlying changes produces zero filesystem writes.
- Atomic: every config write goes through a temp file + rename, so a crash mid-write leaves either the old config or the new — never a partial.
- Backup: the first time the CLI modifies any config file, it copies the original to
~/.xysq/backups/<agent>-<timestamp>.bak(last 5 per agent retained). - Merge-aware: existing MCP servers and other content in shared host files (
AGENTS.md,GEMINI.md,.cursorrules) are preserved.
uninstall
login
xysq install later.
Options
| Flag | Purpose |
|---|---|
--api-key <key> | Provide the key non-interactively |
--replace | Overwrite an existing stored key |
login --replace, run xysq install to update each wired agent’s config with the new key.
logout
| Flag | Purpose |
|---|---|
--purge | Also strip the xysq MCP entry from every wired agent (destructive) |
--yes, -y | Skip the --purge confirmation prompt |
status
doctor
| Code | Meaning |
|---|---|
| 0 | All green |
| 7 | Warnings only |
| 8 | At least one error |
update-skills
api.xysq.ai/skill/download and re-install them for every wired agent (or only the named ones). MCP wiring is left untouched.
Options
| Flag | Purpose |
|---|---|
--force | Overwrite a delimited block even if it was edited locally |
<!-- xysq:start --> ... <!-- xysq:end --> block in AGENTS.md, GEMINI.md, or .cursorrules since install, update-skills will warn rather than silently overwrite. --force clobbers the edit.
Exit codes (all commands)
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Generic / lock contention / internal error |
| 2 | Usage error (bad flag, unknown agent) |
| 3 | Auth error (invalid key, /whoami 401) |
| 4 | Network error |
| 5 | Filesystem / parse error |
| 6 | Partial success (some agents wired, some failed) |
| 7 | doctor: warnings only |
| 8 | doctor: at least one error |