Skip to content

Commit 4343172

Browse files
docs(readme): clarify inputs and add links (#46)
Clarify how the inputs are passed to the Gemini CLI and add links to docs that Gemini CLI uses to define these terms. Updates were made to the `actions.yml` file, and then the readme was updated by running `npm run docs`
1 parent 8e74e04 commit 4343172

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ environment variables, and secrets.
5555

5656
<!-- BEGIN_AUTOGEN_INPUTS -->
5757

58-
- <a name="prompt"></a><a href="#user-content-prompt"><code>prompt</code></a>: _(Optional, default: `You are a helpful assistant.`)_ A specific prompt to guide Gemini.
58+
- <a name="prompt"></a><a href="#user-content-prompt"><code>prompt</code></a>: _(Optional, default: `You are a helpful assistant.`)_ A string passed to the Gemini CLI's [`--prompt` argument](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#command-line-arguments).
5959

60-
- <a name="settings"></a><a href="#user-content-settings"><code>settings</code></a>: _(Optional)_ A JSON string to configure the Gemini CLI. This will be written to
61-
.gemini/settings.json.
60+
- <a name="settings"></a><a href="#user-content-settings"><code>settings</code></a>: _(Optional)_ A JSON string written to `.gemini/settings.json` to configure the CLI's _project_ settings.
61+
For more details, see the documentation on [settings files](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#settings-files).
6262

6363

6464
<!-- END_AUTOGEN_INPUTS -->

action.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ description: |-
1919
2020
inputs:
2121
prompt:
22-
description: 'A specific prompt to guide Gemini.'
22+
description: |
23+
A string passed to the Gemini CLI's [`--prompt` argument](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#command-line-arguments).
2324
required: false
2425
default: 'You are a helpful assistant.'
2526
settings:
2627
description: |
27-
A JSON string to configure the Gemini CLI. This will be written to
28-
.gemini/settings.json.
28+
A JSON string written to `.gemini/settings.json` to configure the CLI's _project_ settings.
29+
For more details, see the documentation on [settings files](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#settings-files).
2930
required: false
3031

3132
outputs:

0 commit comments

Comments
 (0)