{"id":29028573,"url":"https://github.com/google-gemini/gemini-cli","last_synced_at":"2026-04-07T19:01:52.921Z","repository":{"id":301159146,"uuid":"968197216","full_name":"google-gemini/gemini-cli","owner":"google-gemini","description":"An open-source AI agent that brings the power of Gemini directly into your terminal.","archived":false,"fork":false,"pushed_at":"2026-03-06T05:26:47.000Z","size":51916,"stargazers_count":96606,"open_issues_count":2641,"forks_count":11947,"subscribers_count":509,"default_branch":"main","last_synced_at":"2026-03-06T05:37:31.158Z","etag":null,"topics":["ai","ai-agents","cli","gemini","gemini-api","mcp-client","mcp-server"],"latest_commit_sha":null,"homepage":"https://geminicli.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/google-gemini.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-17T17:04:31.000Z","updated_at":"2026-03-06T05:33:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"7ea6d185-8d69-4f88-a51f-d16b2c6f7a73","html_url":"https://github.com/google-gemini/gemini-cli","commit_stats":null,"previous_names":["google-gemini/gemini-cli"],"tags_count":422,"template":false,"template_full_name":null,"purl":"pkg:github/google-gemini/gemini-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-gemini%2Fgemini-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-gemini%2Fgemini-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-gemini%2Fgemini-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-gemini%2Fgemini-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/google-gemini","download_url":"https://codeload.github.com/google-gemini/gemini-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-gemini%2Fgemini-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30324185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-agents","cli","gemini","gemini-api","mcp-client","mcp-server"],"created_at":"2025-06-26T07:34:44.698Z","updated_at":"2026-04-07T19:01:52.913Z","avatar_url":"https://github.com/google-gemini.png","language":"TypeScript","readme":"# Gemini CLI\n\n[![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)\n[![Gemini CLI E2E (Chained)](https://github.com/google-gemini/gemini-cli/actions/workflows/chained_e2e.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/chained_e2e.yml)\n[![Version](https://img.shields.io/npm/v/@google/gemini-cli)](https://www.npmjs.com/package/@google/gemini-cli)\n[![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)\n[![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/google-gemini/gemini-cli?utm_source=badge\u0026utm_medium=github\u0026utm_campaign=github.com/google-gemini/gemini-cli)\n\n![Gemini CLI Screenshot](/docs/assets/gemini-screenshot.png)\n\nGemini CLI is an open-source AI agent that brings the power of Gemini directly\ninto your terminal. It provides lightweight access to Gemini, giving you the\nmost direct path from your prompt to our model.\n\nLearn all about Gemini CLI in our [documentation](https://geminicli.com/docs/).\n\n## 🚀 Why Gemini CLI?\n\n- **🎯 Free tier**: 60 requests/min and 1,000 requests/day with personal Google\n  account.\n- **🧠 Powerful Gemini 3 models**: Access to improved reasoning and 1M token\n  context window.\n- **🔧 Built-in tools**: Google Search grounding, file operations, shell\n  commands, web fetching.\n- **🔌 Extensible**: MCP (Model Context Protocol) support for custom\n  integrations.\n- **💻 Terminal-first**: Designed for developers who live in the command line.\n- **🛡️ Open source**: Apache 2.0 licensed.\n\n## 📦 Installation\n\nSee\n[Gemini CLI installation, execution, and releases](https://www.geminicli.com/docs/get-started/installation)\nfor recommended system specifications and a detailed installation guide.\n\n### Quick Install\n\n#### Run instantly with npx\n\n```bash\n# Using npx (no installation required)\nnpx @google/gemini-cli\n```\n\n#### Install globally with npm\n\n```bash\nnpm install -g @google/gemini-cli\n```\n\n#### Install globally with Homebrew (macOS/Linux)\n\n```bash\nbrew install gemini-cli\n```\n\n#### Install globally with MacPorts (macOS)\n\n```bash\nsudo port install gemini-cli\n```\n\n#### Install with Anaconda (for restricted environments)\n\n```bash\n# Create and activate a new environment\nconda create -y -n gemini_env -c conda-forge nodejs\nconda activate gemini_env\n\n# Install Gemini CLI globally via npm (inside the environment)\nnpm install -g @google/gemini-cli\n```\n\n## Release Channels\n\nSee [Releases](https://www.geminicli.com/docs/changelogs) for more details.\n\n### Preview\n\nNew preview releases will be published each week at UTC 23:59 on Tuesdays. These\nreleases will not have been fully vetted and may contain regressions or other\noutstanding issues. Please help us test and install with `preview` tag.\n\n```bash\nnpm install -g @google/gemini-cli@preview\n```\n\n### Stable\n\n- New stable releases will be published each week at UTC 20:00 on Tuesdays, this\n  will be the full promotion of last week's `preview` release + any bug fixes\n  and validations. Use `latest` tag.\n\n```bash\nnpm install -g @google/gemini-cli@latest\n```\n\n### Nightly\n\n- New releases will be published each day at UTC 00:00. This will be all changes\n  from the main branch as represented at time of release. It should be assumed\n  there are pending validations and issues. Use `nightly` tag.\n\n```bash\nnpm install -g @google/gemini-cli@nightly\n```\n\n## 📋 Key Features\n\n### Code Understanding \u0026 Generation\n\n- Query and edit large codebases\n- Generate new apps from PDFs, images, or sketches using multimodal capabilities\n- Debug issues and troubleshoot with natural language\n\n### Automation \u0026 Integration\n\n- Automate operational tasks like querying pull requests or handling complex\n  rebases\n- Use MCP servers to connect new capabilities, including\n  [media generation with Imagen, Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia)\n- Run non-interactively in scripts for workflow automation\n\n### Advanced Capabilities\n\n- Ground your queries with built-in\n  [Google Search](https://ai.google.dev/gemini-api/docs/grounding) for real-time\n  information\n- Conversation checkpointing to save and resume complex sessions\n- Custom context files (GEMINI.md) to tailor behavior for your projects\n\n### GitHub Integration\n\nIntegrate Gemini CLI directly into your GitHub workflows with\n[**Gemini CLI GitHub Action**](https://github.com/google-github-actions/run-gemini-cli):\n\n- **Pull Request Reviews**: Automated code review with contextual feedback and\n  suggestions\n- **Issue Triage**: Automated labeling and prioritization of GitHub issues based\n  on content analysis\n- **On-demand Assistance**: Mention `@gemini-cli` in issues and pull requests\n  for help with debugging, explanations, or task delegation\n- **Custom Workflows**: Build automated, scheduled and on-demand workflows\n  tailored to your team's needs\n\n## 🔐 Authentication Options\n\nChoose the authentication method that best fits your needs:\n\n### Option 1: Sign in with Google (OAuth login using your Google Account)\n\n**✨ Best for:** Individual developers as well as anyone who has a Gemini Code\nAssist License. (see\n[quota limits and terms of service](https://cloud.google.com/gemini/docs/quotas)\nfor details)\n\n**Benefits:**\n\n- **Free tier**: 60 requests/min and 1,000 requests/day\n- **Gemini 3 models** with 1M token context window\n- **No API key management** - just sign in with your Google account\n- **Automatic updates** to latest models\n\n#### Start Gemini CLI, then choose _Sign in with Google_ and follow the browser authentication flow when prompted\n\n```bash\ngemini\n```\n\n#### If you are using a paid Code Assist License from your organization, remember to set the Google Cloud Project\n\n```bash\n# Set your Google Cloud Project\nexport GOOGLE_CLOUD_PROJECT=\"YOUR_PROJECT_ID\"\ngemini\n```\n\n### Option 2: Gemini API Key\n\n**✨ Best for:** Developers who need specific model control or paid tier access\n\n**Benefits:**\n\n- **Free tier**: 1000 requests/day with Gemini 3 (mix of flash and pro)\n- **Model selection**: Choose specific Gemini models\n- **Usage-based billing**: Upgrade for higher limits when needed\n\n```bash\n# Get your key from https://aistudio.google.com/apikey\nexport GEMINI_API_KEY=\"YOUR_API_KEY\"\ngemini\n```\n\n### Option 3: Vertex AI\n\n**✨ Best for:** Enterprise teams and production workloads\n\n**Benefits:**\n\n- **Enterprise features**: Advanced security and compliance\n- **Scalable**: Higher rate limits with billing account\n- **Integration**: Works with existing Google Cloud infrastructure\n\n```bash\n# Get your key from Google Cloud Console\nexport GOOGLE_API_KEY=\"YOUR_API_KEY\"\nexport GOOGLE_GENAI_USE_VERTEXAI=true\ngemini\n```\n\nFor Google Workspace accounts and other authentication methods, see the\n[authentication guide](https://www.geminicli.com/docs/get-started/authentication).\n\n## 🚀 Getting Started\n\n### Basic Usage\n\n#### Start in current directory\n\n```bash\ngemini\n```\n\n#### Include multiple directories\n\n```bash\ngemini --include-directories ../lib,../docs\n```\n\n#### Use specific model\n\n```bash\ngemini -m gemini-2.5-flash\n```\n\n#### Non-interactive mode for scripts\n\nGet a simple text response:\n\n```bash\ngemini -p \"Explain the architecture of this codebase\"\n```\n\nFor more advanced scripting, including how to parse JSON and handle errors, use\nthe `--output-format json` flag to get structured output:\n\n```bash\ngemini -p \"Explain the architecture of this codebase\" --output-format json\n```\n\nFor real-time event streaming (useful for monitoring long-running operations),\nuse `--output-format stream-json` to get newline-delimited JSON events:\n\n```bash\ngemini -p \"Run tests and deploy\" --output-format stream-json\n```\n\n### Quick Examples\n\n#### Start a new project\n\n```bash\ncd new-project/\ngemini\n\u003e Write me a Discord bot that answers questions using a FAQ.md file I will provide\n```\n\n#### Analyze existing code\n\n```bash\ngit clone https://github.com/google-gemini/gemini-cli\ncd gemini-cli\ngemini\n\u003e Give me a summary of all of the changes that went in yesterday\n```\n\n## 📚 Documentation\n\n### Getting Started\n\n- [**Quickstart Guide**](https://www.geminicli.com/docs/get-started) - Get up\n  and running quickly.\n- [**Authentication Setup**](https://www.geminicli.com/docs/get-started/authentication) -\n  Detailed auth configuration.\n- [**Configuration Guide**](https://www.geminicli.com/docs/reference/configuration) -\n  Settings and customization.\n- [**Keyboard Shortcuts**](https://www.geminicli.com/docs/reference/keyboard-shortcuts) -\n  Productivity tips.\n\n### Core Features\n\n- [**Commands Reference**](https://www.geminicli.com/docs/reference/commands) -\n  All slash commands (`/help`, `/chat`, etc).\n- [**Custom Commands**](https://www.geminicli.com/docs/cli/custom-commands) -\n  Create your own reusable commands.\n- [**Context Files (GEMINI.md)**](https://www.geminicli.com/docs/cli/gemini-md) -\n  Provide persistent context to Gemini CLI.\n- [**Checkpointing**](https://www.geminicli.com/docs/cli/checkpointing) - Save\n  and resume conversations.\n- [**Token Caching**](https://www.geminicli.com/docs/cli/token-caching) -\n  Optimize token usage.\n\n### Tools \u0026 Extensions\n\n- [**Built-in Tools Overview**](https://www.geminicli.com/docs/reference/tools)\n  - [File System Operations](https://www.geminicli.com/docs/tools/file-system)\n  - [Shell Commands](https://www.geminicli.com/docs/tools/shell)\n  - [Web Fetch \u0026 Search](https://www.geminicli.com/docs/tools/web-fetch)\n- [**MCP Server Integration**](https://www.geminicli.com/docs/tools/mcp-server) -\n  Extend with custom tools.\n- [**Custom Extensions**](https://geminicli.com/docs/extensions/writing-extensions) -\n  Build and share your own commands.\n\n### Advanced Topics\n\n- [**Headless Mode (Scripting)**](https://www.geminicli.com/docs/cli/headless) -\n  Use Gemini CLI in automated workflows.\n- [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS\n  Code companion.\n- [**Sandboxing \u0026 Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe\n  execution environments.\n- [**Trusted Folders**](https://www.geminicli.com/docs/cli/trusted-folders) -\n  Control execution policies by folder.\n- [**Enterprise Guide**](https://www.geminicli.com/docs/cli/enterprise) - Deploy\n  and manage in a corporate environment.\n- [**Telemetry \u0026 Monitoring**](https://www.geminicli.com/docs/cli/telemetry) -\n  Usage tracking.\n- [**Tools reference**](https://www.geminicli.com/docs/reference/tools) -\n  Built-in tools overview.\n- [**Local development**](https://www.geminicli.com/docs/local-development) -\n  Local development tooling.\n\n### Troubleshooting \u0026 Support\n\n- [**Troubleshooting Guide**](https://www.geminicli.com/docs/resources/troubleshooting) -\n  Common issues and solutions.\n- [**FAQ**](https://www.geminicli.com/docs/resources/faq) - Frequently asked\n  questions.\n- Use `/bug` command to report issues directly from the CLI.\n\n### Using MCP Servers\n\nConfigure MCP servers in `~/.gemini/settings.json` to extend Gemini CLI with\ncustom tools:\n\n```text\n\u003e @github List my open pull requests\n\u003e @slack Send a summary of today's commits to #dev channel\n\u003e @database Run a query to find inactive users\n```\n\nSee the\n[MCP Server Integration guide](https://www.geminicli.com/docs/tools/mcp-server)\nfor setup instructions.\n\n## 🤝 Contributing\n\nWe welcome contributions! Gemini CLI is fully open source (Apache 2.0), and we\nencourage the community to:\n\n- Report bugs and suggest features.\n- Improve documentation.\n- Submit code improvements.\n- Share your MCP servers and extensions.\n\nSee our [Contributing Guide](./CONTRIBUTING.md) for development setup, coding\nstandards, and how to submit pull requests.\n\nCheck our [Official Roadmap](https://github.com/orgs/google-gemini/projects/11)\nfor planned features and priorities.\n\n## 📖 Resources\n\n- **[Official Roadmap](./ROADMAP.md)** - See what's coming next.\n- **[Changelog](https://www.geminicli.com/docs/changelogs)** - See recent\n  notable updates.\n- **[NPM Package](https://www.npmjs.com/package/@google/gemini-cli)** - Package\n  registry.\n- **[GitHub Issues](https://github.com/google-gemini/gemini-cli/issues)** -\n  Report bugs or request features.\n- **[Security Advisories](https://github.com/google-gemini/gemini-cli/security/advisories)** -\n  Security updates.\n\n### Uninstall\n\nSee the [Uninstall Guide](https://www.geminicli.com/docs/resources/uninstall)\nfor removal instructions.\n\n## 📄 Legal\n\n- **License**: [Apache License 2.0](LICENSE)\n- **Terms of Service**:\n  [Terms \u0026 Privacy](https://www.geminicli.com/docs/resources/tos-privacy)\n- **Security**: [Security Policy](SECURITY.md)\n\n---\n\n\u003cp align=\"center\"\u003e\n  Built with ❤️ by Google and the open source community\n\u003c/p\u003e\n","funding_links":[],"categories":["Quick Start","AI Agent Frameworks","Interactive Code Assistants","TypeScript","Terminal \u0026 CLI Agents","Evaluation","Features","CLI","Repos","🚀 Specialized Agents","🚀 AI Tools for Vim, Neovim, and Terminal","AI Coding Agents","Vibe Coding","🧑‍💻 Coding Agents","📚 Requirements","Table of Contents","CLI Coding Tools","代码 Coding","A01_文本生成_文本对话","Alternatives to Claude Code","AI Tools","Official","Development Toolkits","AI driven development","Related Projects","\u003ca name=\"ai\"\u003e\u003c/a\u003eAI / ChatGPT","AI Coding Assistants \u0026 Agents","CLI Tools","Agentic Coding (CLI focused)","Web Automation and UI Interaction","📚 Projects (2474 total)","AI应用","AI代码助手","Runtime","CLI \u0026 Terminal Tools","Uncategorized","Tools and Code","CLI and TUI Tools","ai","🤖 AI \u0026 LLM (人工智能与大模型)","Frameworks \u0026 Libraries","Terminal-Based AI Agents","命令行工具","AI 相关","ツール","Coding and Debugging","🤖 AI Code Assistants \u0026 Editors"],"sub_categories":["1. Choose Your AI Tool","General Agent Frameworks","Intelligent Code CLIs","Software productivity","💻 Coding Agents","Gemini CLI","Commands","Agent","AI Agents Stack","大语言对话模型及数据","👨‍💻 Developer Tools","CLI Tools","Quantized Models","Provider-Native Coding CLIs","Browser Automation","MCP Servers","AI Terminal","AI Coding CLIs","Uncategorized","Vibe Coding and AI Coding Assistants","Codex Resources","Code Agents","CLI 工具","IDE \u0026 エディタアシスタント","Data Analysis","By Deployment Model"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle-gemini%2Fgemini-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoogle-gemini%2Fgemini-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle-gemini%2Fgemini-cli/lists"}