From 5d7979c5c710d36d1ed889a35cf0c73678a62dc4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 08:30:16 +0100 Subject: [PATCH] docs: refresh reset and uninstall refs --- docs/cli/index.md | 1 + docs/cli/reset.md | 17 ++++++++++++++++- docs/cli/uninstall.md | 21 ++++++++++++++++++++- 3 files changed, 37 insertions(+), 2 deletions(-) diff --git a/docs/cli/index.md b/docs/cli/index.md index b6ab332e238..5f8d16c8626 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -947,6 +947,7 @@ Options: Notes: - `--non-interactive` requires `--yes` and explicit scopes (or `--all`). +- `--all` removes service, state, workspace, and app together. ### `tasks` diff --git a/docs/cli/reset.md b/docs/cli/reset.md index df142390866..6a1b33e515c 100644 --- a/docs/cli/reset.md +++ b/docs/cli/reset.md @@ -10,11 +10,26 @@ title: "reset" Reset local config/state (keeps the CLI installed). +Options: + +- `--scope `: `config`, `config+creds+sessions`, or `full` +- `--yes`: skip confirmation prompts +- `--non-interactive`: disable prompts; requires `--scope` and `--yes` +- `--dry-run`: print actions without removing files + +Examples: + ```bash openclaw backup create openclaw reset openclaw reset --dry-run +openclaw reset --scope config --yes --non-interactive openclaw reset --scope config+creds+sessions --yes --non-interactive +openclaw reset --scope full --yes --non-interactive ``` -Run `openclaw backup create` first if you want a restorable snapshot before removing local state. +Notes: + +- Run `openclaw backup create` first if you want a restorable snapshot before removing local state. +- If you omit `--scope`, `openclaw reset` uses an interactive prompt to choose what to remove. +- `--non-interactive` is only valid when both `--scope` and `--yes` are set. diff --git a/docs/cli/uninstall.md b/docs/cli/uninstall.md index 77333f62651..5f93012f816 100644 --- a/docs/cli/uninstall.md +++ b/docs/cli/uninstall.md @@ -10,11 +10,30 @@ title: "uninstall" Uninstall the gateway service + local data (CLI remains). +Options: + +- `--service`: remove the gateway service +- `--state`: remove state and config +- `--workspace`: remove workspace directories +- `--app`: remove the macOS app +- `--all`: remove service, state, workspace, and app +- `--yes`: skip confirmation prompts +- `--non-interactive`: disable prompts; requires `--yes` +- `--dry-run`: print actions without removing files + +Examples: + ```bash openclaw backup create openclaw uninstall +openclaw uninstall --service --yes --non-interactive +openclaw uninstall --state --workspace --yes --non-interactive openclaw uninstall --all --yes openclaw uninstall --dry-run ``` -Run `openclaw backup create` first if you want a restorable snapshot before removing state or workspaces. +Notes: + +- Run `openclaw backup create` first if you want a restorable snapshot before removing state or workspaces. +- `--all` is shorthand for removing service, state, workspace, and app together. +- `--non-interactive` requires `--yes`.