Skip to content

Latest commit

 

History

History

gemini-cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
imgs
imgs
 
 
GEMINI.md
GEMINI.md
 
 
NOTES.md
NOTES.md
 
 
README.md
README.md
 
 
devcontainer-feature.json
devcontainer-feature.json
 
 
install.sh
install.sh
 
 

README.md

Gemini CLI (gemini-cli)

Installs Gemini CLI, and needed dependencies.

Example Usage

"features": {
    "ghcr.io/marblejenka/devcontainer-feature/gemini-cli:0": {}
}

Options

Options Id Description Type Default Value
version Select or enter a Gemini CLI version to install string latest
geminifiles A git repository URL to clone for gemini-cli configuration. It is expected to have an install.sh at the root. string -
keep_google_api_credentials If true, persists Google API credentials across container rebuilds by storing them in a volume. Note: this parameter is for Google OAuth sessions. Does not cover API Keys or Vertex AI (gcloud) authentication. boolean false
google_api_credentials_persist_dir The directory where Google API credentials will be persisted when keep_google_api_credentials is enabled. string /dc/gemini-cli
extensions A comma-separated list of Gemini CLI extensions to install (e.g., 'https://github.com/gemini-cli-extensions/conductor'). See https://github.com/gemini-cli-extensions for a list of available extensions. string -

Customizations

VS Code Extensions

  • google.geminicodeassist

OS Support

This feature supports Ubuntu-based operating systems and has been tested with the following container images:

  • ubuntu:latest
  • mcr.microsoft.com/devcontainers/base:ubuntu
  • mcr.microsoft.com/devcontainers/universal:linux

Using with Default Features

To install the Gemini CLI across all your development environments that use Dev Containers, you can add this feature to Dev > Containers: Default Features in VS Code settings. Open your VS Code settings, search for default feature, and then select Edit in settings.json to add the feature.

Default Feature Image

Persistence of CLI Credentials

Maintaining authentication state across container rebuilds is crucial. This feature helps manage the persistence of credentials for the 'Login with Google (OAuth)' method using a named volume. Other authentication methods, such as Vertex AI or API Keys, typically rely on related features or external mechanisms for persistence.

Login with Google (OAuth)

This feature can persist credentials for the Login with Google (OAuth) flow. Enable the keep_google_api_credentials option to preserve your Google OAuth tokens across container rebuilds by storing them in a named volume.

How it works

  • A dedicated volume is mounted at /dc/gemini-cli.
  • The feature creates a symlink from the authentication file (~/.gemini/oauth_creds.json) to this persistent volume.
  • This ensures your login session remains active across rebuilds, while other configuration files can be managed independently, for example, through your GEMINIFILES repository.

Example devcontainer.json Configuration

"features": {
    "ghcr.io/marblejenka/devcontainer-feature/gemini-cli:0": {
        "keep_google_api_credentials": true
    }
},
"mounts": [
    {
        "source": "gemini-cli-persistence",
        "target": "/dc/gemini-cli",
        "type": "volume"
    }
]

Vertex AI

Authentication for Vertex AI is handled through the Google Cloud CLI (gcloud). To persist Vertex AI credentials, it is recommended to use a feature specifically designed for gcloud credential persistence, such as gcloud-cli-persistence.

Example devcontainer.json Configuration

"features": {
    "ghcr.io/jajera/features/gcloud-cli:1": {},
    "ghcr.io/joshuanianji/devcontainer-features/gcloud-cli-persistence:1": {},
    "ghcr.io/marblejenka/devcontainer-feature/gemini-cli:0": {}
},
"mounts": [
    {
        "source": "gcloud-cli-persistence",
        "target": "/dc/gcloud-cli",
        "type": "volume"
    }
]

Environment Variables

You may also want to create a .env file at your project root to automatically select the Google Cloud project and model region.

GOOGLE_CLOUD_PROJECT=your_project_id
GOOGLE_CLOUD_LOCATION=global # or your preferred region

API Key (Token)

This feature does not manage API Keys (Tokens). Users are expected to handle these securely, for instance, by using environment variables or a preferred secret management provider (e.g., 1Password CLI (op)).

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.