docs(cli): include generate help

[roderik]

Summary by Sourcery

Include the generate command help in the README and update the docs generation script to append its output.

Build:

• Extend the docs:cli npm script to run bun src/index.ts generate --help and include its output in the generated README

Documentation:

• Add Usage and Options sections for the network-bootstrapper generate command to the CLI documentation in README.md

[gemini-code-assist]

Summary of Changes

Hello @roderik, 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 improves the project's command-line interface documentation by embedding the detailed help for the generate command directly into the README.md. This change makes it easier for users to understand and utilize the generate command's various options without needing to execute the command itself. Furthermore, the process of updating this documentation has been automated, ensuring consistency and reducing manual effort.

Highlights

• Documentation Update: The README.md file now includes comprehensive help documentation for the generate CLI command, detailing its usage and all available options with their descriptions and default values.
• Automated CLI Documentation Generation: The docs:cli script in package.json has been updated to automatically append the help output for the generate subcommand to the README.md file, ensuring the documentation remains current.

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. ↩

[github-actions]

To view in Slack, search for: 1758128715.298869

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[gemini-code-assist]

Code Review

This pull request updates the documentation generation script to include the help output for the generate subcommand in the README.md. While this is a good addition, the implementation can be improved. The script concatenates two separate help outputs into a single code block, which harms readability. I've suggested an update to the script in package.json to create separate, headed code blocks for each command's help output, which will improve the structure and clarity of the documentation.

[gemini-code-assist]

The docs:cli script is becoming long and hard to read. More importantly, it concatenates the help output of two different commands into a single markdown code block in README.md. This makes the documentation less clear and structured.

For better readability and semantic structure in the generated README.md, I suggest splitting the output into two separate, headed code blocks. This also makes the script's intent clearer.

As this script grows, you might also consider moving it to a separate shell script file (e.g., in a scripts/ directory) and calling it from here. This would significantly improve maintainability.

    "docs:cli": "cat README.tpl > README.md && printf '\\n### Main command\\n\\n\`\`\`text\\n' >> README.md && bun src/index.ts --help >> README.md && printf '\\n\`\`\`\\n\\n### \`generate\` command\\n\\n\`\`\`text\\n' >> README.md && bun src/index.ts generate --help >> README.md && printf '\\n\`\`\`\\n' >> README.md",