summaryrefslogtreecommitdiff
path: root/docs/cli
diff options
context:
space:
mode:
authorcperry-goog <[email protected]>2025-05-15 20:43:01 -0700
committerGitHub <[email protected]>2025-05-15 20:43:01 -0700
commit59e8fcb4096b2f4f3841150035aa995aaebc0e97 (patch)
treea7aeb2b10af0a9fe4f203f7c4b68a33453a1bae9 /docs/cli
parent58ef39e2a964386a1026ba68419e4d64c4612551 (diff)
Docs: Fix broken links and update documentation (#377)
Diffstat (limited to 'docs/cli')
-rw-r--r--docs/cli/configuration.md4
-rw-r--r--docs/cli/index.md4
2 files changed, 3 insertions, 5 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index e3965caa..2fbca3ff 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -36,7 +36,7 @@ When you create a `.gemini/settings.json` file for project-specific settings, or
- **Generally, it's recommended to add `.gemini/` to your project's `.gitignore` file.**
- **Reasoning:** This directory often contains user-specific preferences (like themes) or local sandbox configurations that might not be relevant or applicable to all collaborators on the project. Keeping it out of version control avoids imposing one user's local setup on others.
-- **Exception:** If your team decides that certain project-specific configurations within `.gemini/` (e.g., a carefully crafted `sandbox-macos-custom.sb` profile that _all_ macOS users on the project should use) are essential for consistent project behavior, you might choose to commit specific files within `.gemini/` (e.g., `!.gemini/sandbox-macos-custom.sb`) or the entire directory. However, this should be a deliberate decision by the team.
+- **Exception:** If your team decides that certain project-specific configurations within `.gemini/` (e.g., a carefully crafted `sandbox-macos-custom.sb` profile that _all_ macOS users on the project should use) are essential for consistent project behavior, you might choose to commit specific files within `.gemini/` (e.g., `.gemini/sandbox-macos-custom.sb`) or the entire directory. However, this should be a deliberate decision by the team.
- User-specific `settings.json` often contains local paths or preferences that should not be committed.
Always consider the nature of the files within `.gemini/` before deciding to include them in version control. For most common use cases, ignoring the entire directory is the safest approach.
@@ -46,7 +46,7 @@ Always consider the nature of the files within `.gemini/` before deciding to inc
- **`theme`** (string):
- Specifies the visual theme for the CLI.
- Example: `"theme": "VS2015"`
- - See the [UI Guide](./ui-guide.md#themes) for available theme names.
+ - See the [Theming section in README.md](../../README.md#theming) for available theme names.
- **`sandbox`** (boolean or string):
- Controls whether and how to use sandboxing for tool execution.
- `true`: Enable default sandbox (e.g., Docker or Podman if configured, otherwise OS-level like Seatbelt on macOS).
diff --git a/docs/cli/index.md b/docs/cli/index.md
index d5ab6461..db1dab97 100644
--- a/docs/cli/index.md
+++ b/docs/cli/index.md
@@ -14,7 +14,6 @@ The Gemini CLI (`packages/cli`) is the primary way users interact with the Gemin
- Syntax highlighting for code blocks in various languages.
- Clear display of tool calls, inputs, and outputs.
- **Command History:** Easily access and re-run previous commands and prompts.
-- **Suggestions:** (If applicable, describe suggestion features)
- **Theming:** Customize the look and feel of the CLI to your preference. See the [Theming section in README.md](../../README.md#theming).
- **Configuration:** Tailor the CLI's behavior through configuration files. See [CLI Configuration](./configuration.md).
- **Special Commands:** Utilize built-in commands for tasks like managing history, memory, or display. See [Commands](./commands.md).
@@ -24,7 +23,7 @@ The Gemini CLI (`packages/cli`) is the primary way users interact with the Gemin
1. **Start the CLI:** Run `npm start` from the project root (or execute the installed CLI command directly). Refer to the main [README.md](../../README.md) for setup and running instructions.
2. **Enter a Prompt:** Type your question or instruction at the `>` prompt and press Enter.
```
- > Explain quantum computing in simple terms.
+ > Explain how to build a web app.
```
3. **View Response:** Gemini's response will be displayed in the terminal. If Gemini needs to use a tool (e.g., to read a file you mentioned), you will see messages indicating the tool usage.
4. **Continue Conversation:** You can continue the conversation by asking follow-up questions or giving new instructions.
@@ -32,7 +31,6 @@ The Gemini CLI (`packages/cli`) is the primary way users interact with the Gemin
## Navigating this Section
- **[Commands](./commands.md):** A detailed reference for all built-in CLI commands (e.g., `/help`, `/history`, `/theme`).
-- **[UI Guide](./ui-guide.md):** Learn more about the different parts of the CLI's user interface, including themes and display elements.
- **[Configuration](./configuration.md):** Understand how to configure various aspects of the CLI.
This documentation will help you become proficient in using the Gemini CLI for a wide range of tasks.