Skip to content

chore: updates the CLI description in docs and help text#75

Merged
Ryank90 merged 2 commits into
mainfrom
chore/cli-description
Jun 23, 2026
Merged

chore: updates the CLI description in docs and help text#75
Ryank90 merged 2 commits into
mainfrom
chore/cli-description

Conversation

@danmrichards

Copy link
Copy Markdown
Collaborator

Updates the CLI description in docs and help text to better represent the APIs it can interact with.

Updates the CLI description in docs and help text to better represent the APIs it can interact with.
@danmrichards danmrichards requested a review from Copilot June 23, 2026 10:06
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. To trigger a review, include coderabbit-review in the PR description. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b087535-e534-4859-8815-1e2026d0ceca

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch chore/cli-description

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

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 CLI’s top-level description across the README, runware --help text, and generated docs to reflect broader Runware API capabilities beyond just “inference”.

Changes:

  • Updated README introduction to refer to the Runware API (not specifically the inference API) and expanded the capability summary.
  • Updated Cobra root command Short/Long help text to match the new positioning.
  • Updated generated docs (docs/*.md) to reflect the new root command description in Synopsis and SEE ALSO sections.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Updates the project’s one-paragraph description and adds an expanded capability summary.
internal/cmd/root.go Updates Cobra root command Short/Long help text used by runware --help and doc generation.
docs/runware.md Updates generated root command docs (title line and synopsis).
docs/runware_version.md Updates generated SEE ALSO root description string.
docs/runware_upload.md Updates generated SEE ALSO root description string.
docs/runware_run.md Updates generated SEE ALSO root description string.
docs/runware_result.md Updates generated SEE ALSO root description string.
docs/runware_preset.md Updates generated SEE ALSO root description string.
docs/runware_ping.md Updates generated SEE ALSO root description string.
docs/runware_model.md Updates generated SEE ALSO root description string.
docs/runware_config.md Updates generated SEE ALSO root description string.
docs/runware_completion.md Updates generated SEE ALSO root description string.
docs/runware_auth.md Updates generated SEE ALSO root description string.
docs/runware_account.md Updates generated SEE ALSO root description string.

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

Comment thread internal/cmd/root.go Outdated
Comment thread docs/runware.md Outdated
Comment thread README.md
@Ryank90 Ryank90 merged commit 3360318 into main Jun 23, 2026
4 checks passed
@Ryank90 Ryank90 deleted the chore/cli-description branch June 23, 2026 10:17
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