Skip to content

docs: sync getting-started guide with CLI commands#427

Open
rishi-jat wants to merge 3 commits intomodelpack:mainfrom
rishi-jat:docs/getting-started-cli-sync
Open

docs: sync getting-started guide with CLI commands#427
rishi-jat wants to merge 3 commits intomodelpack:mainfrom
rishi-jat:docs/getting-started-cli-sync

Conversation

@rishi-jat
Copy link
Contributor

Description

Adds missing CLI command sections to getting-started.md to align documentation with the commands currently available in modctl.

Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Copilot AI review requested due to automatic review settings February 27, 2026 03:05
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the getting-started documentation by incorporating several modctl commands that were previously missing. The update ensures that the guide accurately reflects the full capabilities of the CLI tool, providing users with complete and current information for interacting with model artifacts.

Highlights

  • Documentation Update: Added new sections to the getting-started.md guide to include modctl commands for Tag, Inspect, Version, Logout, and Completion.
  • CLI Command Alignment: Synchronized the documentation with the currently available commands in the modctl command-line interface, ensuring the guide is up-to-date and comprehensive.
Changelog
  • docs/getting-started.md
    • Added documentation for the modctl tag command.
    • Added documentation for the modctl inspect command.
    • Added documentation for the modctl version command.
    • Added documentation for the modctl logout command.
    • Added documentation for the modctl completion command.
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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for several missing modctl CLI commands to the getting-started.md guide, which is a great improvement. The new sections for tag, inspect, version, logout, and completion are clear and provide helpful examples. I have one suggestion regarding the structure of the document to improve its logical flow for new users, which I've detailed in a specific comment.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the getting-started documentation to reflect additional modctl CLI commands that are already available in the codebase, improving parity between the guide and the actual CLI surface.

Changes:

  • Add documentation sections for tag, inspect, version, logout, and completion.
  • Provide basic one-line descriptions and example invocations for each new command.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
@rishi-jat rishi-jat requested a review from chlins February 27, 2026 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants