summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Tedesco <[email protected]>2025-06-25 03:53:03 +0000
committerGitHub <[email protected]>2025-06-25 03:53:03 +0000
commit268d29f05c29a612fc31918e7d0380f4b522b422 (patch)
treebb0714d59ffe8091ad20a3fbd693d1072cd8c714 /docs
parentb6ccf12551bf43992b89c8b2c78d1352e89787eb (diff)
docs: fix typos in documentation (#1411)
Co-authored-by: Dan Tedesco <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r--docs/cli/authentication.md6
-rw-r--r--docs/cli/configuration.md4
-rw-r--r--docs/deployment.md2
-rw-r--r--docs/integration-tests.md2
-rw-r--r--docs/sandbox.md2
-rw-r--r--docs/telemetry.md2
-rw-r--r--docs/tools/web-search.md2
-rw-r--r--docs/troubleshooting.md2
8 files changed, 11 insertions, 11 deletions
diff --git a/docs/cli/authentication.md b/docs/cli/authentication.md
index b74e2b60..7770c3c6 100644
--- a/docs/cli/authentication.md
+++ b/docs/cli/authentication.md
@@ -52,7 +52,7 @@ The Gemini CLI requires you to authenticate with Google's AI services. On initia
export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION" # e.g., us-central1
export GOOGLE_GENAI_USE_VERTEXAI=true
```
- - For repeated use, you can add the environment variables to your `.env` file (located in the project directory or user home directory) or your shell's configuration file (like `~/.bashrc`, `~/.zshrc`, or `~/.profile`). For example, the following commands adds the environment variables to a `~/.bashrc` file:
+ - For repeated use, you can add the environment variables to your `.env` file (located in the project directory or user home directory) or your shell's configuration file (like `~/.bashrc`, `~/.zshrc`, or `~/.profile`). For example, the following commands add the environment variables to a `~/.bashrc` file:
```bash
echo 'export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"' >> ~/.bashrc
echo 'export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION"' >> ~/.bashrc
@@ -60,13 +60,13 @@ The Gemini CLI requires you to authenticate with Google's AI services. On initia
source ~/.bashrc
```
- If using express mode:
- - Set the `GOOGLE_API_KEY` environment variables. In the following methods, replace `YOUR_GOOGLE_API_KEY` with your Vertex AI API key provided by express mode:
+ - Set the `GOOGLE_API_KEY` environment variable. In the following methods, replace `YOUR_GOOGLE_API_KEY` with your Vertex AI API key provided by express mode:
- You can temporarily set these environment variables in your current shell session using the following commands:
```bash
export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true
```
- - For repeated use, you can add the environment variables to your `.env` file (located in the project directory or user home directory) or your shell's configuration file (like `~/.bashrc`, `~/.zshrc`, or `~/.profile`). For example, the following commands adds the environment variables to a `~/.bashrc` file:
+ - For repeated use, you can add the environment variables to your `.env` file (located in the project directory or user home directory) or your shell's configuration file (like `~/.bashrc`, `~/.zshrc`, or `~/.profile`). For example, the following commands add the environment variables to a `~/.bashrc` file:
```bash
echo 'export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"' >> ~/.bashrc
echo 'export GOOGLE_GENAI_USE_VERTEXAI=true' >> ~/.bashrc
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index 90646b99..d22aa4b9 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -165,7 +165,7 @@ In addition to a project settings file, a project's `.gemini` directory can cont
- **Description:** Configures logging and metrics collection for Gemini CLI. For more information, see [Telemetry](../telemetry.md).
- **Default:** `{"enabled": false, "target": "local", "otlpEndpoint": "http://localhost:4317", "logPrompts": true}`
- **Properties:**
- - **`enabled`** (boolean): Whether or not telemtery is enabled.
+ - **`enabled`** (boolean): Whether or not telemetry is enabled.
- **`target`** (string): The destination for collected telemetry. Supported values are `local` and `gcp`.
- **`otlpEndpoint`** (string): The endpoint for the OTLP Exporter.
- **`logPrompts`** (boolean): Whether or not to include the content of user prompts in the logs.
@@ -243,7 +243,7 @@ The CLI automatically loads environment variables from an `.env` file. The loadi
- Your Google Cloud API key.
- Required for using Vertex AI in express mode.
- Ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable.
- - Example: `export GOOGLE_API_KEY="YOUR_GOOGLE_API_ KEY"`.
+ - Example: `export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"`.
- **`GOOGLE_CLOUD_PROJECT`**:
- Your Google Cloud Project ID.
- Required for using Code Assist or Vertex AI.
diff --git a/docs/deployment.md b/docs/deployment.md
index b615cb44..40747c7c 100644
--- a/docs/deployment.md
+++ b/docs/deployment.md
@@ -73,7 +73,7 @@ Contributors to the project will want to run the CLI directly from the source co
### 4. Running the latest Gemini CLI commit from GitHub
-You can run the most recently committed version of Gemini CLI directly from the GitHub repository. This is useful for testing features still in developement.
+You can run the most recently committed version of Gemini CLI directly from the GitHub repository. This is useful for testing features still in development.
```bash
# Execute the CLI directly from the main branch on GitHub
diff --git a/docs/integration-tests.md b/docs/integration-tests.md
index 400767dc..60dfa30b 100644
--- a/docs/integration-tests.md
+++ b/docs/integration-tests.md
@@ -18,7 +18,7 @@ The integration tests can also be run using the following shortcut:
npm run test:e2e
```
-## Running a specfic set of tests
+## Running a specific set of tests
To run a subset of test files, you can use `npm run <integration test command> <file_name1> ....` where <integration test command> is either `test:e2e` or `test:integration*` and `<file_name>` is any of the `.test.js` files in the `integration-tests/` directory. For example, the following command runs `list_directory.test.js` and `write_file.test.js`:
diff --git a/docs/sandbox.md b/docs/sandbox.md
index 1170895e..77ea0f73 100644
--- a/docs/sandbox.md
+++ b/docs/sandbox.md
@@ -7,7 +7,7 @@ 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
+# install gemini-cli with npm
npm install -g @google/gemini-cli
# Verify installation
diff --git a/docs/telemetry.md b/docs/telemetry.md
index bca3adc9..b620ec71 100644
--- a/docs/telemetry.md
+++ b/docs/telemetry.md
@@ -132,7 +132,7 @@ Use the `npm run telemetry -- --target=gcp` command to automate setting up a loc
## Logs and metric reference
-The following section describes the struture of logs and metrics generated for Gemini CLI.
+The following section describes the structure of logs and metrics generated for Gemini CLI.
- A `sessionId` is included as a common attribute on all logs and metrics.
diff --git a/docs/tools/web-search.md b/docs/tools/web-search.md
index c0f7c8db..9ba56bfb 100644
--- a/docs/tools/web-search.md
+++ b/docs/tools/web-search.md
@@ -14,7 +14,7 @@ Use `google_web_search` to perform a web search using Google Search via the Gemi
## How to use `google_web_search` with the Gemini CLI
-The `google_web_search` tool sends a query to the Gemini API, which then perform a web search. `google_web_search` will return a generated response based on the search results, including citations and sources.
+The `google_web_search` tool sends a query to the Gemini API, which then performs a web search. `google_web_search` will return a generated response based on the search results, including citations and sources.
Usage:
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 7dbda1b8..233a0aa5 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -24,7 +24,7 @@ This guide provides solutions to common issues and debugging tips.
- **Solution:**
Either stop the other process that is using the port or configure the MCP server to use a different port.
-- **Error: Command not found (when attempting the run Gemini CLI).**
+- **Error: Command not found (when attempting to run Gemini CLI).**
- **Cause:** Gemini CLI is not correctly installed or not in your system's PATH.
- **Solution:**