From 80c81f2a4cafd88333defa6b86b69f572dfec5d0 Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Mon, 14 Jul 2025 18:21:40 +0200 Subject: [PATCH] fix(docs): clarify global installation in readme (#3781) --- README.md | 5 +++++ docs/deployment.md | 7 +++++-- docs/sandbox.md | 6 ++++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22e2f24b..33cabfdd 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,11 @@ With the Gemini CLI you can: ```bash npm install -g @google/gemini-cli + ``` + + Then, run the CLI from anywhere: + + ```bash gemini ``` diff --git a/docs/deployment.md b/docs/deployment.md index 12ea0655..3287839c 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -15,14 +15,17 @@ This is the recommended way for end-users to install Gemini CLI. It involves dow - **Global install:** ```bash - # Install the CLI globally npm install -g @google/gemini-cli + ``` - # Now you can run the CLI from anywhere + Then, run the CLI from anywhere: + + ```bash gemini ``` - **NPX execution:** + ```bash # Execute the latest version from NPM without a global install npx @google/gemini-cli diff --git a/docs/sandbox.md b/docs/sandbox.md index 77ea0f73..87763685 100644 --- a/docs/sandbox.md +++ b/docs/sandbox.md @@ -7,10 +7,12 @@ This document provides a guide to sandboxing in the Gemini CLI, including prereq Before using sandboxing, you need to install and set up the Gemini CLI: ```bash -# install gemini-cli with npm npm install -g @google/gemini-cli +``` -# Verify installation +To verify the installation + +```bash gemini --version ```