summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZircoz <[email protected]>2025-06-29 19:11:58 +0530
committerGitHub <[email protected]>2025-06-29 13:41:58 +0000
commit87d4fc05609aa2289575fea73372f6fab4281bcd (patch)
tree375e482dcc6ccf08e3fe5c346eee47227f32b878
parentb980a47879076c030f642abc715a9f7ef6f39a35 (diff)
docs: Add uninstallation instructions to README (#1985)
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Allen Hutchison <[email protected]> Co-authored-by: Allen Hutchison <[email protected]>
-rw-r--r--README.md4
-rw-r--r--docs/Uninstall.md42
2 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md
index b3626d82..c7092e40 100644
--- a/README.md
+++ b/README.md
@@ -131,6 +131,10 @@ Use MCP servers to integrate your local system tools with your enterprise collab
> Organise my PDF invoices by month of expenditure.
```
+### Uninstall
+
+Head over to the [Uninstall](docs/Uninstall.md) guide for uninstallation instructions.
+
## Terms of Service and Privacy Notice
For details on the terms of service and privacy notice applicable to your use of Gemini CLI, see the [Terms of Service and Privacy Notice](./docs/tos-privacy.md).
diff --git a/docs/Uninstall.md b/docs/Uninstall.md
new file mode 100644
index 00000000..f2e7a7c5
--- /dev/null
+++ b/docs/Uninstall.md
@@ -0,0 +1,42 @@
+## Uninstalling the CLI
+
+Your uninstall method depends on how you ran the CLI. Follow the instructions for either npx or a global npm installation.
+
+### Method 1: Using npx
+
+npx runs packages from a temporary cache without a permanent installation. To "uninstall" the CLI, you must clear this cache, which will remove gemini-cli and any other packages previously executed with npx.
+
+The npx cache is a directory named `_npx` inside your main npm cache folder. You can find your npm cache path by running `npm config get cache`.
+
+**For macOS / Linux**
+
+```bash
+# The path is typically ~/.npm/_npx
+rm -rf "$(npm config get cache)/_npx"
+```
+
+**For Windows**
+
+_Command Prompt_
+
+```cmd
+:: The path is typically %LocalAppData%\npm-cache\_npx
+rmdir /s /q "%LocalAppData%\npm-cache\_npx"
+```
+
+_PowerShell_
+
+```powershell
+# The path is typically $env:LocalAppData\npm-cache\_npx
+Remove-Item -Path (Join-Path $env:LocalAppData "npm-cache\_npx") -Recurse -Force
+```
+
+### Method 2: Using npm (Global Install)
+
+If you installed the CLI globally (e.g., `npm install -g @google/gemini-cli`), use the `npm uninstall` command with the `-g` flag to remove it.
+
+```bash
+npm uninstall -g @google/gemini-cli
+```
+
+This command completely removes the package from your system.