Making Gemini CLI extensions simpler to make use of

Cease debugging ambiguous startup failures brought on by lacking API keys, hidden setting variables, or a crashing MCP server. AI instruments are best once they’re tailor-made to your particular setting and information however handbook configuration is usually brittle and complicated. For this reason we’re launching extension settings. Gemini CLI extensions can now outline settings that the person will probably be prompted to offer upon set up, making certain extensions have precisely what they should perform from the second you put in them.

Sorry, your browser would not help playback for this video

A primary-class expertise for extension configuration

Extension settings present a structured method that ensures your expertise is painless and easy. Extension authors can now outline precisely what data their instrument must perform; whether or not it is an API key, a base URL, or a mission identifier. No extra digging by way of README’s or attempting to decode error messages.

Extension settings present the next advantages:

Automated setup: Customers are mechanically prompted to offer settings throughout the set up of an extension.
Built-in safety: Delicate settings like API keys are mechanically saved within the system keychain quite than plain textual content recordsdata.
Command-line administration: The brand new gemini extensions config command offers a centralized option to view and replace settings.
Scoped overrides: Help for each world person and project-specific workspace scopes ensures the proper configuration is utilized in the proper context.

Sensible instance: The AlloyDB extension

The AlloyDB extension is an ideal instance of why structured settings matter. To attach along with your database and work together along with your information, the extension requires a number of items of data: a mission ID, area, cluster ID, occasion ID, and database.

Up to now, you needed to manually export these as setting variables. Now, the extension defines them in its manifest. If you set up it, Gemini CLI guides you thru the setup:

? Undertaking ID: Your GCP mission ID
? Area: us-central1
? Cluster ID: my-cluster
? Occasion ID: my-primary-instance


✔ Undertaking ID
ID of the Google Cloud mission: my-google-cloud-project
✔ Location
Area of the AlloyDB cluster: us-central1
✔ Cluster ID
ID of the AlloyDB cluster: my-cluster
✔ Occasion ID
ID of the AlloyDB occasion: my-instance
✔ Database
Identify of the database: postgres
✔ Consumer
(Elective) Username of the database person (Default: IAM person): postgres
✔ Password
(Elective) Password of the database person (Default: IAM person): *****
✔ IP Sort
(Elective) Sort of the IP handle: PUBLIC, PRIVATE, or PSC (Default: Public):
Extension "alloydb" put in efficiently and enabled.

Shell

These values are saved securely and supplied to the extension’s MCP server mechanically, so you can begin querying your information instantly. This setup offers a dependable and safe methodology for database connection. It ensures you’ve gotten fixed visibility into which database is lively and prevents the agent from altering your configuration.

Try these updates for all Information Cloud extensions: bigquery-data-analytics, cloud-sql-mysql, cloud-sql-postgresql, cloud-sql-sqlserver, firestore-native, looker, spanner.

Learn how to outline settings as an creator

So as to add configuration to your extension, embody a settings array in your gemini-extension.json file. Every setting specifies a user-friendly title, an outline, and the setting variable it must be mapped to.

{
  "title": "my-cool-extension",
  "model": "1.0.0",
  "settings": [
    {
      "name": "API Key",
      "description": "Your secret API key for the service.",
      "envVar": "MY_API_KEY",
      "sensitive": true
    },
    {
      "name": "Endpoint URL",
      "description": "The base URL for the API service.",
      "envVar": "API_ENDPOINT"
    }
  ]
}

JSON

When a person installs this extension, Gemini CLI guides them by way of the setup course of. If a setting is marked as delicate, the enter is obfuscated throughout entry and saved securely within the system keychain.

Managing settings with the config command

The gemini extensions config command is your major instrument for managing extension configuration after set up. Use it to replace settings interactively or goal particular values instantly.

Replace all settings for an extension

To stroll by way of each setting outlined by an extension, run:

gemini extensions config

Shell

Replace a selected setting

If precisely which worth wants to alter, specify the setting variable title:

gemini extensions config

Shell

Use workspace overrides

For settings that adjust between initiatives, use the –scope workspace flag to save lots of the worth in your present listing’s configuration quite than globally:

gemini extensions config alloydb ALLOYDB_POSTGRES_CLUSTER --scope workspace

Shell

Debugging the configuration

When troubleshooting points with extensions, it’s typically useful to confirm that every one configuration settings are appropriate. A easy typo in a mission ID or a lacking API key can forestall an extension from functioning correctly.

You may examine the presently put in extensions and their lively settings utilizing the extensions listing command. This performance is accessible by way of the command line and as a built-in command. Each will output a abstract of your put in extensions, their model standing, and their present configuration.

Command Line

gemini extensions listing

# ✓ alloydb (0.1.10)
#  Supply: https://github.com/gemini-cli-extensions/alloydb (Sort: github-release)
#  Launch tag: 0.1.10
# ...
#  Settings:
#   Undertaking ID: my-gcp-project
#   Location: us-central1
#   Cluster ID: my-alloy-db
#   Occasion ID: my-primary
#   Database: postgres
#   Consumer: postgres
#   Password: *****
#   IP Sort: public

Shell

/extensions listing

# Put in extensions:
#   alloydb (v0.1.10) - lively (updated)
#     settings:
#     - Undertaking ID: my-gcp-project
#     - Location: us-central1
#     - Cluster ID: my-alloy-db
#     - Occasion ID: my-primary
#     - Database: postgres
#     - Consumer: postgres
#     - Password: ****
#     - IP Sort: public

Shell

Finest practices for extension settings

Present clear descriptions: Assist customers perceive precisely the place to seek out the values they want (e.g., “Discover this in your GCP Console underneath IAM”).
Use delicate for secrets and techniques: All the time set “delicate”: true for API keys, passwords, or any information that shouldn’t be saved in plain textual content.
Hold names concise: Use quick, user-friendly names that match properly inside terminal prompts.
Leverage workspace scope: Use workspace-scoped settings for project- particular IDs to forestall world configuration air pollution.

Get began at the moment

Extension settings and the gemini extensions config command can be found as of v0.28.0+. Replace to the most recent model by working:

npm set up -g @google/gemini-cli@newest

Shell

Try our up to date documentation to study extra:

Check out extension settings at the moment when constructing Gemini CLI extensions and if you happen to run into any points tell us on our GitHub repository or on socials!

It’s also possible to observe Gemini CLI on X to remain updated with the most recent information and bulletins.