docs(agentstack-cli): mark admin-only and local-only commands

[JanPokorny]

Summary

Linked Issues

Fixes #1766

Documentation

• No Docs Needed:

If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

[gemini-code-assist]

Summary of Changes

Hello @JanPokorny, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the user experience of the agentstack-cli by clearly indicating which commands require administrative privileges or are restricted to local operations. By embedding these markers directly into the command help texts and the main CLI overview, users can quickly understand the scope and prerequisites for executing specific commands, leading to improved usability and reduced confusion.

Highlights

• CLI Command Clarity: Explicitly marked agentstack-cli commands as [Admin only] or [Local only] in their help descriptions and the main CLI overview for improved user understanding.
• Command Reorganization: The info command was relocated from the 'Agent Management' section to the 'Getting Started' section in the main CLI help output, enhancing logical grouping.
• Documentation Updates: Updated command help strings and docstrings across various modules to reflect access restrictions and improve overall command line documentation, removing redundant docstrings where help arguments were added.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request consistently adds [Admin only] and [Local only] markers to the help texts of various CLI commands, which improves clarity for users. I've noticed some inconsistencies in how the help texts are implemented across different files. While some files move the help text to the help parameter of the typer decorator and remove the now-redundant docstring (a clean approach), others just update the docstring, or a mix of both. My review comments focus on making these implementations consistent across the codebase for better maintainability. I've also pointed out a case where help text was missed for a command alias.

[gemini-code-assist]

To maintain consistency with how other commands are being updated in this PR, I suggest moving the help text from the docstring to a help parameter in the @app.command decorator and then removing the docstring.

Suggested change

	@app.command("add")
	async def add_provider(
	capability: typing.Annotated[
	ModelCapability | None, typer.Argument(help="Which default model to change (llm/embedding)")
	] = None,
	):
	"""Add a new model provider. [Admin only]"""
	@app.command("add", help="Add a new model provider. [Admin only]")
	async def add_provider(
	capability: typing.Annotated[
	ModelCapability | None, typer.Argument(help="Which default model to change (llm/embedding)")
	] = None,
	):

[gemini-code-assist]

The model provider remove command has help text, but it seems the model remove command is missing it. For completeness and consistency, you should add help text for the command registered with the main app as well.

Suggested change

	@app.command("remove | rm | delete")
	@app.command("remove | rm | delete", help="Remove a model provider [Admin only]")