mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-04-24 22:55:13 +00:00
Docs IA update and Get Started section. (#10192)
This commit is contained in:
54
docs/get-started/index.md
Normal file
54
docs/get-started/index.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# 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 deployment options, see [Gemini CLI Execution and Deployment](./deployment.md).
|
||||
|
||||
## Authenticate
|
||||
|
||||
To begin using Gemini CLI, you must authenticate with a Google service. The most straightforward authentication method uses 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**.
|
||||
|
||||
For other authentication options and information, 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).
|
||||
Reference in New Issue
Block a user