diff --git a/README.md b/README.md index 79847bc3..14c9de15 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,21 @@ [![Gemini CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml) -This repository contains the Gemini CLI tool. - ![Gemini CLI Screenshot](./docs/assets/gemini-screenshot.png) +This repository contains the Gemini CLI, a command-line AI workflow tool that connects to your +tools, understands your code and accelerates your workflows. + +With the Gemini CLI you can: + +- Query and edit large codebases in and beyond Gemini's 1M token context window. +- Generate new apps from PDFs or sketches, using Gemini's multimodal capabilities. +- Automate operational tasks, like querying pull requests or handling complex rebases. +- Use tools and MCP servers to connect new capabilities, including [media generation with Imagen, + Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-g> +- Ground your queries with the [Google Search](https://ai.google.dev/gemini-api/docs/grounding) + tool, built in to Gemini. + ## Quickstart 1. **Prerequisites:** Ensure you have [Node.js version 18](https://nodejs.org/en/download) or higher installed. @@ -41,16 +52,23 @@ For other authentication methods, including Google Workspace accounts, see the [ ## Examples -Once the CLI is running, you can start interacting with Gemini from your shell. Try a simple query: +Once the CLI is running, you can start interacting with Gemini from your shell. -``` -> How can I build a web app? +You can start a project from a new directory: + +```sh +$ cd new-project/ +$ gemini +> Write me a Gemini Discord bot that answers questions using a FAQ.md file I will provide ``` -Or ask it to perform a task using its tools: +Or work with an existing project: -``` -> List files in the current directory. +```sh +$ git clone https://github.com/google-gemini/gemini-cli +$ cd gemini-cli +$ gemini +> Give me a summary of all of the changes that went in yesterday ``` ### Next steps