@office-ai/aioncli-core 0.26.0 → 0.30.0

package/dist/docs/extensions/best-practices.md

@@ -0,0 +1,188 @@
+# Gemini CLI extension best practices
+
+This guide covers best practices for developing, securing, and maintaining
+Gemini CLI extensions.
+
+## Development
+
+Developing extensions for Gemini CLI is a lightweight, iterative process. Use
+these strategies to build robust and efficient extensions.
+
+### Structure your extension
+
+While simple extensions may contain only a few files, we recommend a organized
+structure for complex projects.
+
+```text
+my-extension/
+├── package.json
+├── tsconfig.json
+├── gemini-extension.json
+├── src/
+│   ├── index.ts
+│   └── tools/
+└── dist/
+```
+
+- **Use TypeScript:** We strongly recommend using TypeScript for type safety and
+  improved developer experience.
+- **Separate source and build:** Keep your source code in `src/` and output
+  build artifacts to `dist/`.
+- **Bundle dependencies:** If your extension has many dependencies, bundle them
+  using a tool like `esbuild` to reduce installation time and avoid conflicts.
+
+### Iterate with `link`
+
+Use the `gemini extensions link` command to develop locally without reinstalling
+your extension after every change.
+
+```bash
+cd my-extension
+gemini extensions link .
+```
+
+Changes to your code are immediately available in the CLI after you rebuild the
+project and restart the session.
+
+### Use `GEMINI.md` effectively
+
+Your `GEMINI.md` file provides essential context to the model.
+
+- **Focus on goals:** Explain the high-level purpose of the extension and how to
+  interact with its tools.
+- **Be concise:** Avoid dumping exhaustive documentation into the file. Use
+  clear, direct language.
+- **Provide examples:** Include brief examples of how the model should use
+  specific tools or commands.
+
+## Security
+
+Follow the principle of least privilege and rigorous input validation when
+building extensions.
+
+### Minimal permissions
+
+Only request the permissions your MCP server needs to function. Avoid giving the
+model broad access (such as full shell access) if restricted tools are
+sufficient.
+
+If your extension uses powerful tools like `run_shell_command`, restrict them in
+your `gemini-extension.json` file:
+
+```json
+{
+  "name": "my-safe-extension",
+  "excludeTools": ["run_shell_command(rm -rf *)"]
+}
+```
+
+This ensures the CLI blocks dangerous commands even if the model attempts to
+execute them.
+
+### Validate inputs
+
+Your MCP server runs on the user's machine. Always validate tool inputs to
+prevent arbitrary code execution or unauthorized filesystem access.
+
+```typescript
+// Example: Validating paths
+if (!path.resolve(inputPath).startsWith(path.resolve(allowedDir) + path.sep)) {
+  throw new Error('Access denied');
+}
+```
+
+### Secure sensitive settings
+
+If your extension requires API keys or other secrets, use the `sensitive: true`
+option in your manifest. This ensures keys are stored in the system keychain and
+obfuscated in the CLI output.
+
+```json
+"settings": [
+  {
+    "name": "API Key",
+    "envVar": "MY_API_KEY",
+    "sensitive": true
+  }
+]
+```
+
+## Release
+
+Follow standard versioning and release practices to ensure a smooth experience
+for your users.
+
+### Semantic versioning
+
+Follow [Semantic Versioning (SemVer)](https://semver.org/) to communicate
+changes clearly.
+
+- **Major:** Breaking changes (e.g., renaming tools or changing arguments).
+- **Minor:** New features (e.g., adding new tools or commands).
+- **Patch:** Bug fixes and performance improvements.
+
+### Release channels
+
+Use Git branches to manage release channels. This lets users choose between
+stability and the latest features.
+
+```bash
+# Install the stable version (default branch)
+gemini extensions install github.com/user/repo
+
+# Install the development version
+gemini extensions install github.com/user/repo --ref dev
+```
+
+### Clean artifacts
+
+When using GitHub Releases, ensure your archives only contain necessary files
+(such as `dist/`, `gemini-extension.json`, and `package.json`). Exclude
+`node_modules/` and `src/` to minimize download size.
+
+## Test and verify
+
+Test your extension thoroughly before releasing it to users.
+
+- **Manual verification:** Use `gemini extensions link` to test your extension
+  in a live CLI session. Verify that tools appear in the debug console (F12) and
+  that custom commands resolve correctly.
+- **Automated testing:** If your extension includes an MCP server, write unit
+  tests for your tool logic using a framework like Vitest or Jest. You can test
+  MCP tools in isolation by mocking the transport layer.
+
+## Troubleshooting
+
+Use these tips to diagnose and fix common extension issues.
+
+### Extension not loading
+
+If your extension doesn't appear in `/extensions list`:
+
+- **Check the manifest:** Ensure `gemini-extension.json` is in the root
+  directory and contains valid JSON.
+- **Verify the name:** The `name` field in the manifest must match the extension
+  directory name exactly.
+- **Restart the CLI:** Extensions are loaded at the start of a session. Restart
+  Gemini CLI after making changes to the manifest or linking a new extension.
+
+### MCP server failures
+
+If your tools aren't working as expected:
+
+- **Check the logs:** View the CLI logs to see if the MCP server failed to
+  start.
+- **Test the command:** Run the server's `command` and `args` directly in your
+  terminal to ensure it starts correctly outside of Gemini CLI.
+- **Debug console:** In interactive mode, press **F12** to open the debug
+  console and inspect tool calls and responses.
+
+### Command conflicts
+
+If a custom command isn't responding:
+
+- **Check precedence:** Remember that user and project commands take precedence
+  over extension commands. Use the prefixed name (e.g., `/extension.command`) to
+  verify the extension's version.
+- **Help command:** Run `/help` to see a list of all available commands and
+  their sources.

package/dist/docs/extensions/index.md

@@ -1,293 +1,61 @@
 # Gemini CLI extensions
 
-_This documentation is up-to-date with the v0.4.0 release._
+Gemini CLI extensions package prompts, MCP servers, custom commands, themes,
+hooks, sub-agents, and agent skills into a familiar and user-friendly format.
+With extensions, you can expand the capabilities of Gemini CLI and share those
+capabilities with others. They are designed to be easily installable and
+shareable.
 
-Gemini CLI extensions package prompts, MCP servers, and custom commands into a
-familiar and user-friendly format. With extensions, you can expand the
-capabilities of Gemini CLI and share those capabilities with others. They are
-designed to be easily installable and shareable.
+To see what's possible, browse the
+[Gemini CLI extension gallery](https://geminicli.com/extensions/browse/).
 
-To see examples of extensions, you can browse a gallery of
-[Gemini CLI extensions](https://geminicli.com/extensions/browse/).
+## Choose your path
 
-See [getting started docs](getting-started-extensions.md) for a guide on
-creating your first extension.
+Choose the guide that best fits your needs.
 
-See [releasing docs](extension-releasing.md) for an advanced guide on setting up
-GitHub releases.
+### I want to use extensions
 
-## Extension management
+Learn how to discover, install, and manage extensions to enhance your Gemini CLI
+experience.
 
-We offer a suite of extension management tools using `gemini extensions`
-commands.
+- **[Manage extensions](#manage-extensions):** List and verify your installed
+  extensions.
+- **[Install extensions](#installation):** Add new capabilities from GitHub or
+  local paths.
 
-Note that these commands are not supported from within the CLI, although you can
-list installed extensions using the `/extensions list` subcommand.
+### I want to build extensions
 
-Note that all of these commands will only be reflected in active CLI sessions on
-restart.
+Learn how to create, test, and share your own extensions with the community.
 
-### Installing an extension
+- **[Build extensions](writing-extensions.md):** Create your first extension
+  from a template.
+- **[Best practices](best-practices.md):** Learn how to build secure and
+  reliable extensions.
+- **[Publish to the gallery](releasing.md):** Share your work with the world.
 
-You can install an extension using `gemini extensions install` with either a
-GitHub URL or a local path.
+## Manage extensions
 
-Note that we create a copy of the installed extension, so you will need to run
-`gemini extensions update` to pull in changes from both locally-defined
-extensions and those on GitHub.
+Use the interactive `/extensions` command to verify your installed extensions
+and their status:
 
-NOTE: If you are installing an extension from GitHub, you'll need to have `git`
-installed on your machine. See
-[git installation instructions](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-for help.
-
-```
-gemini extensions install <source> [--ref <ref>] [--auto-update] [--pre-release] [--consent]
-```
-
-- `<source>`: The github URL or local path of the extension to install.
-- `--ref`: The git ref to install from.
-- `--auto-update`: Enable auto-update for this extension.
-- `--pre-release`: Enable pre-release versions for this extension.
-- `--consent`: Acknowledge the security risks of installing an extension and
-  skip the confirmation prompt.
-
-### Uninstalling an extension
-
-To uninstall one or more extensions, run
-`gemini extensions uninstall <name...>`:
-
-```
-gemini extensions uninstall gemini-cli-security gemini-cli-another-extension
-```
-
-### Disabling an extension
-
-Extensions are, by default, enabled across all workspaces. You can disable an
-extension entirely or for specific workspace.
-
-```
-gemini extensions disable <name> [--scope <scope>]
+```bash
+/extensions list
 ```
 
-- `<name>`: The name of the extension to disable.
-- `--scope`: The scope to disable the extension in (`user` or `workspace`).
-
-### Enabling an extension
-
-You can enable extensions using `gemini extensions enable <name>`. You can also
-enable an extension for a specific workspace using
-`gemini extensions enable <name> --scope=workspace` from within that workspace.
+You can also manage extensions from your terminal using the `gemini extensions`
+command group:
 
+```bash
+gemini extensions list
 ```
-gemini extensions enable <name> [--scope <scope>]
-```
-
-- `<name>`: The name of the extension to enable.
-- `--scope`: The scope to enable the extension in (`user` or `workspace`).
-
-### Updating an extension
 
-For extensions installed from a local path or a git repository, you can
-explicitly update to the latest version (as reflected in the
-`gemini-extension.json` `version` field) with `gemini extensions update <name>`.
+## Installation
 
-You can update all extensions with:
+Install an extension by providing its GitHub repository URL. For example:
 
+```bash
+gemini extensions install https://github.com/gemini-cli-extensions/workspace
 ```
-gemini extensions update --all
-```
-
-### Create a boilerplate extension
-
-We offer several example extensions `context`, `custom-commands`,
-`exclude-tools` and `mcp-server`. You can view these examples
-[here](https://github.com/google-gemini/gemini-cli/tree/main/packages/cli/src/commands/extensions/examples).
-
-To copy one of these examples into a development directory using the type of
-your choosing, run:
-
-```
-gemini extensions new <path> [template]
-```
-
-- `<path>`: The path to create the extension in.
-- `[template]`: The boilerplate template to use.
-
-### Link a local extension
-
-The `gemini extensions link` command will create a symbolic link from the
-extension installation directory to the development path.
-
-This is useful so you don't have to run `gemini extensions update` every time
-you make changes you'd like to test.
-
-```
-gemini extensions link <path>
-```
-
-- `<path>`: The path of the extension to link.
-
-## How it works
-
-On startup, Gemini CLI looks for extensions in `<home>/.gemini/extensions`
-
-Extensions exist as a directory that contains a `gemini-extension.json` file.
-For example:
-
-`<home>/.gemini/extensions/my-extension/gemini-extension.json`
-
-### `gemini-extension.json`
-
-The `gemini-extension.json` file contains the configuration for the extension.
-The file has the following structure:
-
-```json
-{
-  "name": "my-extension",
-  "version": "1.0.0",
-  "mcpServers": {
-    "my-server": {
-      "command": "node my-server.js"
-    }
-  },
-  "contextFileName": "GEMINI.md",
-  "excludeTools": ["run_shell_command"]
-}
-```
-
-- `name`: The name of the extension. This is used to uniquely identify the
-  extension and for conflict resolution when extension commands have the same
-  name as user or project commands. The name should be lowercase or numbers and
-  use dashes instead of underscores or spaces. This is how users will refer to
-  your extension in the CLI. Note that we expect this name to match the
-  extension directory name.
-- `version`: The version of the extension.
-- `mcpServers`: A map of MCP servers to settings. The key is the name of the
-  server, and the value is the server configuration. These servers will be
-  loaded on startup just like MCP servers settingsd in a
-  [`settings.json` file](../get-started/configuration.md). If both an extension
-  and a `settings.json` file settings an MCP server with the same name, the
-  server defined in the `settings.json` file takes precedence.
-  - Note that all MCP server configuration options are supported except for
-    `trust`.
-- `contextFileName`: The name of the file that contains the context for the
-  extension. This will be used to load the context from the extension directory.
-  If this property is not used but a `GEMINI.md` file is present in your
-  extension directory, then that file will be loaded.
-- `excludeTools`: An array of tool names to exclude from the model. You can also
-  specify command-specific restrictions for tools that support it, like the
-  `run_shell_command` tool. For example,
-  `"excludeTools": ["run_shell_command(rm -rf)"]` will block the `rm -rf`
-  command. Note that this differs from the MCP server `excludeTools`
-  functionality, which can be listed in the MCP server config.
-
-When Gemini CLI starts, it loads all the extensions and merges their
-configurations. If there are any conflicts, the workspace configuration takes
-precedence.
-
-### Settings
-
-_Note: This is an experimental feature. We do not yet recommend extension
-authors introduce settings as part of their core flows._
-
-Extensions can define settings that the user will be prompted to provide upon
-installation. This is useful for things like API keys, URLs, or other
-configuration that the extension needs to function.
-
-To define settings, add a `settings` array to your `gemini-extension.json` file.
-Each object in the array should have the following properties:
-
-- `name`: A user-friendly name for the setting.
-- `description`: A description of the setting and what it's used for.
-- `envVar`: The name of the environment variable that the setting will be stored
-  as.
-- `sensitive`: Optional boolean. If true, obfuscates the input the user provides
-  and stores the secret in keychain storage. **Example**
-
-```json
-{
-  "name": "my-api-extension",
-  "version": "1.0.0",
-  "settings": [
-    {
-      "name": "API Key",
-      "description": "Your API key for the service.",
-      "envVar": "MY_API_KEY"
-    }
-  ]
-}
-```
-
-When a user installs this extension, they will be prompted to enter their API
-key. The value will be saved to a `.env` file in the extension's directory
-(e.g., `<home>/.gemini/extensions/my-api-extension/.env`).
-
-You can view a list of an extension's settings by running:
-
-```
-gemini extensions settings list <extension name>
-```
-
-and you can update a given setting using:
-
-```
-gemini extensions settings set <extension name> <setting name> [--scope <scope>]
-```
-
-- `--scope`: The scope to set the setting in (`user` or `workspace`). This is
-  optional and will default to `user`.
-
-### Custom commands
-
-Extensions can provide [custom commands](../cli/custom-commands.md) by placing
-TOML files in a `commands/` subdirectory within the extension directory. These
-commands follow the same format as user and project custom commands and use
-standard naming conventions.
-
-**Example**
-
-An extension named `gcp` with the following structure:
-
-```
-.gemini/extensions/gcp/
-├── gemini-extension.json
-└── commands/
-    ├── deploy.toml
-    └── gcs/
-        └── sync.toml
-```
-
-Would provide these commands:
-
-- `/deploy` - Shows as `[gcp] Custom command from deploy.toml` in help
-- `/gcs:sync` - Shows as `[gcp] Custom command from sync.toml` in help
-
-### Conflict resolution
-
-Extension commands have the lowest precedence. When a conflict occurs with user
-or project commands:
-
-1. **No conflict**: Extension command uses its natural name (e.g., `/deploy`)
-2. **With conflict**: Extension command is renamed with the extension prefix
-   (e.g., `/gcp.deploy`)
-
-For example, if both a user and the `gcp` extension define a `deploy` command:
-
-- `/deploy` - Executes the user's deploy command
-- `/gcp.deploy` - Executes the extension's deploy command (marked with `[gcp]`
-  tag)
-
-## Variables
-
-Gemini CLI extensions allow variable substitution in `gemini-extension.json`.
-This can be useful if e.g., you need the current directory to run an MCP server
-using `"cwd": "${extensionPath}${/}run.ts"`.
-
-**Supported variables:**
 
-| variable                   | description                                                                                                                                                     |
-| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `${extensionPath}`         | The fully-qualified path of the extension in the user's filesystem e.g., '/Users/username/.gemini/extensions/example-extension'. This will not unwrap symlinks. |
-| `${workspacePath}`         | The fully-qualified path of the current workspace.                                                                                                              |
-| `${/} or ${pathSeparator}` | The path separator (differs per OS).                                                                                                                            |
+For more advanced installation options, see the
+[Extension reference](reference.md#install-an-extension).