gemini-cli

(β˜… 106,598)

An open-source AI agent that brings the power of Gemini directly into your terminal.

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .editorconfig
  • .geminiignore
  • .gitattributes
  • .gitignore
  • .lycheeignore
  • .npmrc
  • .nvmrc
  • .prettierignore
  • .prettierrc.json
  • .yamllint.yml
  • CONTRIBUTING.md
  • Dockerfile
  • esbuild.config.js
  • eslint.config.js
  • GEMINI.md
  • LICENSE
  • Makefile
  • package-lock.json
  • package.json
  • README.md
  • ROADMAP.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/google-gemini/gemini-cli

Downloads the entire project code from GitHub to your computer.

cd gemini-cli

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
  • Homebrew A package manager for macOS/Linux.
npm install -g @google/gemini-cli

Installs the package published on the npm registry globally β€” no need to clone the source.

brew install gemini-cli

Installs the pre-built package via Homebrew β€” no source build required.

npm install -g @google/gemini-cli@preview

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g @google/gemini-cli@latest

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f .gcp/Dockerfile.development -t gemini-cli .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 gemini-cli

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g @google/gemini-cli

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g @google/gemini-cli@preview

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g @google/gemini-cli@latest

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g @google/gemini-cli@nightly

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation