mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-02-01 14:44:29 +00:00
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
# Get started with Gemini CLI
|
|
|
|
Welcome to Gemini CLI! This guide will help you install, configure, and start
|
|
using the Gemini CLI to enhance your workflow right from your terminal.
|
|
|
|
## Quickstart: Install, authenticate, configure, and use Gemini CLI
|
|
|
|
Gemini CLI brings the power of advanced language models directly to your command
|
|
line interface. As an AI-powered assistant, Gemini CLI can help you with a
|
|
variety of tasks, from understanding and generating code to reviewing and
|
|
editing documents.
|
|
|
|
## Install
|
|
|
|
The standard method to install and run Gemini CLI uses `npm`:
|
|
|
|
```bash
|
|
npm install -g @google/gemini-cli
|
|
```
|
|
|
|
Once Gemini CLI is installed, run Gemini CLI from your command line:
|
|
|
|
```bash
|
|
gemini
|
|
```
|
|
|
|
For more installation options, see [Gemini CLI Installation](./installation.md).
|
|
|
|
## Authenticate
|
|
|
|
To begin using Gemini CLI, you must authenticate with a Google service. In most
|
|
cases, you can log in with your existing Google account:
|
|
|
|
1. Run Gemini CLI after installation:
|
|
|
|
```bash
|
|
gemini
|
|
```
|
|
|
|
2. When asked "How would you like to authenticate for this project?" select **1.
|
|
Login with Google**.
|
|
|
|
3. Select your Google account.
|
|
|
|
4. Click on **Sign in**.
|
|
|
|
Certain account types may require you to configure a Google Cloud project. For
|
|
more information, including other authentication methods, see
|
|
[Gemini CLI Authentication Setup](./authentication.md).
|
|
|
|
## Configure
|
|
|
|
Gemini CLI offers several ways to configure its behavior, including environment
|
|
variables, command-line arguments, and settings files.
|
|
|
|
To explore your configuration options, see
|
|
[Gemini CLI Configuration](./configuration.md).
|
|
|
|
## Use
|
|
|
|
Once installed and authenticated, you can start using Gemini CLI by issuing
|
|
commands and prompts in your terminal. Ask it to generate code, explain files,
|
|
and more.
|
|
|
|
To explore the power of Gemini CLI, see [Gemini CLI examples](./examples.md).
|
|
|
|
## What's next?
|
|
|
|
- Find out more about [Gemini CLI's tools](../tools/index.md).
|
|
- Review [Gemini CLI's commands](../cli/commands.md).
|
|
- Learn how to [get started with Gemini 3](./gemini-3.md).
|