mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-10 22:21:22 -07:00
86828bb561
Co-authored-by: Adam Weidman <65992621+adamfweidman@users.noreply.github.com> Co-authored-by: Sehoon Shon <sshon@google.com> Co-authored-by: Adib234 <30782825+Adib234@users.noreply.github.com> Co-authored-by: Sandy Tao <sandytao520@icloud.com> Co-authored-by: Abhi <43648792+abhipatel12@users.noreply.github.com> Co-authored-by: Aishanee Shah <aishaneeshah@gmail.com> Co-authored-by: gemini-cli-robot <gemini-cli-robot@google.com> Co-authored-by: Gal Zahavi <38544478+galz10@users.noreply.github.com> Co-authored-by: Jacob Richman <jacob314@gmail.com> Co-authored-by: joshualitt <joshualitt@google.com> Co-authored-by: Jenna Inouye <jinouye@google.com>
62 lines
2.4 KiB
Markdown
62 lines
2.4 KiB
Markdown
# Gemini CLI
|
|
|
|
Within Gemini CLI, `packages/cli` is the frontend for users to send and receive
|
|
prompts with the Gemini AI model and its associated tools. For a general
|
|
overview of Gemini CLI, see the [main documentation page](../index.md).
|
|
|
|
## Basic features
|
|
|
|
- **[Commands](./commands.md):** A reference for all built-in slash commands
|
|
- **[Custom Commands](./custom-commands.md):** Create your own commands and
|
|
shortcuts for frequently used prompts.
|
|
- **[Headless Mode](./headless.md):** Use Gemini CLI programmatically for
|
|
scripting and automation.
|
|
- **[Model Selection](./model.md):** Configure the Gemini AI model used by the
|
|
CLI.
|
|
- **[Settings](./settings.md):** Configure various aspects of the CLI's behavior
|
|
and appearance.
|
|
- **[Themes](./themes.md):** Customizing the CLI's appearance with different
|
|
themes.
|
|
- **[Keyboard Shortcuts](./keyboard-shortcuts.md):** A reference for all
|
|
keyboard shortcuts to improve your workflow.
|
|
- **[Tutorials](./tutorials.md):** Step-by-step guides for common tasks.
|
|
|
|
## Advanced features
|
|
|
|
- **[Checkpointing](./checkpointing.md):** Automatically save and restore
|
|
snapshots of your session and files.
|
|
- **[Enterprise Configuration](./enterprise.md):** Deploying and manage Gemini
|
|
CLI in an enterprise environment.
|
|
- **[Sandboxing](./sandbox.md):** Isolate tool execution in a secure,
|
|
containerized environment.
|
|
- **[Telemetry](./telemetry.md):** Configure observability to monitor usage and
|
|
performance.
|
|
- **[Token Caching](./token-caching.md):** Optimize API costs by caching tokens.
|
|
- **[Trusted Folders](./trusted-folders.md):** A security feature to control
|
|
which projects can use the full capabilities of the CLI.
|
|
- **[Ignoring Files (.geminiignore)](./gemini-ignore.md):** Exclude specific
|
|
files and directories from being accessed by tools.
|
|
- **[Context Files (GEMINI.md)](./gemini-md.md):** Provide persistent,
|
|
hierarchical context to the model.
|
|
|
|
## Non-interactive mode
|
|
|
|
Gemini CLI can be run in a non-interactive mode, which is useful for scripting
|
|
and automation. In this mode, you pipe input to the CLI, it executes the
|
|
command, and then it exits.
|
|
|
|
The following example pipes a command to Gemini CLI from your terminal:
|
|
|
|
```bash
|
|
echo "What is fine tuning?" | gemini
|
|
```
|
|
|
|
You can also use the `--prompt` or `-p` flag:
|
|
|
|
```bash
|
|
gemini -p "What is fine tuning?"
|
|
```
|
|
|
|
For comprehensive documentation on headless usage, scripting, automation, and
|
|
advanced examples, see the **[Headless Mode](./headless.md)** guide.
|