Skip to content

Commit 132169a

Browse files
committed
docs(extensions): add documentation for extensions
Adds a new documentation page for Gemini CLI extensions, explaining how to configure and use them. The main README is updated to include a link to the new documentation.
1 parent 793032b commit 132169a

2 files changed

Lines changed: 46 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Use it to perform GitHub pull request reviews, triage issues, perform code analy
2020
- [Issue Triage](#issue-triage)
2121
- [Pull Request Review](#pull-request-review)
2222
- [Gemini CLI Assistant](#gemini-cli-assistant)
23+
- [Configuration](#configuration)
2324
- [Inputs](#inputs)
2425
- [Outputs](#outputs)
2526
- [Repository Variables](#repository-variables)
@@ -28,6 +29,7 @@ Use it to perform GitHub pull request reviews, triage issues, perform code analy
2829
- [Google Authentication](#google-authentication)
2930
- [GitHub Authentication](#github-authentication)
3031
- [Observability](#observability)
32+
- [Extensions](#extensions)
3133
- [Best Practices](#best-practices)
3234
- [Customization](#customization)
3335
- [Contributing](#contributing)
@@ -137,15 +139,15 @@ This action can be used to automatically review pull requests when they are
137139
opened. For a detailed guide on how to set up the pull request review system,
138140
go to the [GitHub PR Review workflow documentation](./examples/workflows/pr-review).
139141

140-
141-
142142
### Gemini CLI Assistant
143143

144144
This type of action can be used to invoke a general-purpose, conversational Gemini
145145
AI assistant within the pull requests and issues to perform a wide range of
146146
tasks. For a detailed guide on how to set up the general-purpose Gemini CLI workflow,
147147
go to the [Gemini Assistant workflow documentation](./examples/workflows/gemini-assistant).
148148

149+
## Configuration
150+
149151
### Inputs
150152

151153
<!-- BEGIN_AUTOGEN_INPUTS -->
@@ -271,6 +273,14 @@ for debugging and optimization.
271273
For detailed instructions on how to set up and configure observability, go to
272274
the [Observability documentation](./docs/observability.md).
273275

276+
## Extensions
277+
278+
The Gemini CLI can be extended with additional functionality through extensions.
279+
These extensions are installed from source from their GitHub repositories.
280+
281+
For detailed instructions on how to set up and configure extensions, go to the
282+
[Extensions documentation](./docs/extensions.md).
283+
274284
## Best Practices
275285

276286
To ensure the security, reliability, and efficiency of your automated workflows, we strongly recommend following our best practices. These guidelines cover key areas such as repository security, workflow configuration, and monitoring.

docs/extensions.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Extensions
2+
3+
Gemini CLI can be extended with additional functionality through extensions.
4+
These extensions are installed from source from their GitHub repositories.
5+
6+
For more information on creating and using extensions, see [documentation].
7+
8+
[documentation]: https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md
9+
10+
## Configuration
11+
12+
To use extensions in your GitHub workflow, provide a JSON array of GitHub
13+
repositories to the `extensions` input of the `run-gemini-cli` action.
14+
15+
### Example
16+
17+
Here is an example of how to configure a workflow to install and use extensions:
18+
19+
```yaml
20+
jobs:
21+
main:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- id: gemini
25+
uses: google-github-actions/run-gemini-cli@v0
26+
with:
27+
gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
28+
prompt: "/security:analyze"
29+
extensions: |
30+
[
31+
"https://github.com/gemini-cli-extensions/security.git",
32+
"https://github.com/gemini-cli-extensions/code-review.git"
33+
]
34+
```

0 commit comments

Comments
 (0)