docs: add Gemini CLI agents guide - #429
Open
michaelxu2288 wants to merge 1 commit into
Open
Conversation
Companion to the scale-agentex-python change that adds a Gemini CLI harness (convert_gemini_cli_to_agentex_events, GeminiCliTurn, and sync / async / temporal agentex init templates). Documents the CLI invocation, the stream-json to canonical-event mapping, usage normalisation, and the multi-turn and tool-approval caveats; adds the page to the Framework Agents nav and lists Gemini CLI among the coding-CLI options. Claude-Session: https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3
|
|
||
| The template spawns the CLI in streaming-JSON mode with the prompt on the command line and stdin closed: | ||
|
|
||
| ```python |
Contributor
There was a problem hiding this comment.
Passing the potentially user-supplied prompt through -p puts its full contents in the subprocess argument list, where process listings or process telemetry may capture it. This is a non-blocking documentation concern: please warn readers not to include secrets and recommend suitable isolation or redaction for shared environments.
How this was verified: The documented command directly inserts prompt into the argument list passed to create_subprocess_exec.
Prompt To Fix With AI
This is a comment left during a code review.
Path: agentex/docs/docs/development_guides/gemini_cli_agents.md
Line: 16
Comment:
**Prompt Exposed in Arguments**
Passing the potentially user-supplied prompt through `-p` puts its full contents in the subprocess argument list, where process listings or process telemetry may capture it. This is a non-blocking documentation concern: please warn readers not to include secrets and recommend suitable isolation or redaction for shared environments.
**How this was verified:** The documented command directly inserts `prompt` into the argument list passed to `create_subprocess_exec`.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Companion to scaleapi/scale-agentex-python#516 ("feat(harness): add a Gemini CLI harness"). Adds
development_guides/gemini_cli_agents.md(CLI invocation with the prompt on argv and stdin closed, the stream-json to canonical-event mapping table, usage normalisation, the multi-turn caveat since--resumeis index-based, tool approval modes), adds it to the Framework Agents nav, and lists Gemini CLI in the framework table and the coding-CLI bullet of Choose Your Agent Type.Test
mkdocs build --strictwithdocs/requirements.txt: the page renders and its links resolve; no warnings reference the changed files (the 15 pre-existing strict-mode warnings are unrelated).https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3