From feb478d56a1ad91d9774a21774e50bcc2669788f Mon Sep 17 00:00:00 2001 From: Dan Richards Date: Tue, 23 Jun 2026 11:06:23 +0100 Subject: [PATCH 1/2] chore: updates the CLI description in docs and help text Updates the CLI description in docs and help text to better represent the APIs it can interact with. --- README.md | 4 +++- docs/runware.md | 6 +++--- docs/runware_account.md | 2 +- docs/runware_auth.md | 2 +- docs/runware_completion.md | 2 +- docs/runware_config.md | 2 +- docs/runware_model.md | 2 +- docs/runware_ping.md | 2 +- docs/runware_preset.md | 2 +- docs/runware_result.md | 2 +- docs/runware_run.md | 2 +- docs/runware_upload.md | 2 +- docs/runware_version.md | 2 +- internal/cmd/root.go | 6 +++--- 14 files changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d1c94e1..6afb924 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Runware CLI -A command-line tool for interacting with the [Runware](https://runware.ai) inference API. Built in Go, distributed as a single static binary. +A command-line tool for interacting with the [Runware](https://runware.ai) API. Built in Go, distributed as a single static binary. + +Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more. ## Install diff --git a/docs/runware.md b/docs/runware.md index 5a177ee..ae7aab9 100644 --- a/docs/runware.md +++ b/docs/runware.md @@ -1,11 +1,11 @@ ## runware -CLI tool for the Runware inference API +CLI tool for the Runware API ### Synopsis -A command-line tool for interacting with the Runware inference API. -Generate images, search models, manage your account, and more. +A command-line tool for interacting with the full Runware API. +Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more. Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy). diff --git a/docs/runware_account.md b/docs/runware_account.md index ec164f4..dfa745e 100644 --- a/docs/runware_account.md +++ b/docs/runware_account.md @@ -26,6 +26,6 @@ Account information, team, and API keys ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API * [runware account details](runware_account_details.md) - Show account details, team, API keys, and usage diff --git a/docs/runware_auth.md b/docs/runware_auth.md index 6306288..77537c3 100644 --- a/docs/runware_auth.md +++ b/docs/runware_auth.md @@ -23,7 +23,7 @@ Login, logout, and check authentication status. ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API * [runware auth login](runware_auth_login.md) - Authenticate with an API key * [runware auth logout](runware_auth_logout.md) - Clear stored credentials * [runware auth status](runware_auth_status.md) - Show current auth state diff --git a/docs/runware_completion.md b/docs/runware_completion.md index 6cd3124..8ff8f78 100644 --- a/docs/runware_completion.md +++ b/docs/runware_completion.md @@ -59,5 +59,5 @@ runware completion [bash|zsh|fish|powershell] [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/docs/runware_config.md b/docs/runware_config.md index 1deada5..929020c 100644 --- a/docs/runware_config.md +++ b/docs/runware_config.md @@ -19,7 +19,7 @@ Manage CLI configuration ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API * [runware config path](runware_config_path.md) - Print config file path * [runware config reset](runware_config_reset.md) - Reset configuration defaults * [runware config set](runware_config_set.md) - Set a config value diff --git a/docs/runware_model.md b/docs/runware_model.md index 49fefe0..2158206 100644 --- a/docs/runware_model.md +++ b/docs/runware_model.md @@ -19,7 +19,7 @@ Manage and search models ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API * [runware model examples](runware_model_examples.md) - Show example requests for a model * [runware model pricing](runware_model_pricing.md) - Show pricing for a model * [runware model schema](runware_model_schema.md) - Show the request/response schema for a model diff --git a/docs/runware_ping.md b/docs/runware_ping.md index 1d38c34..09095b3 100644 --- a/docs/runware_ping.md +++ b/docs/runware_ping.md @@ -30,5 +30,5 @@ runware ping [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/docs/runware_preset.md b/docs/runware_preset.md index 3b10826..e444c3c 100644 --- a/docs/runware_preset.md +++ b/docs/runware_preset.md @@ -19,7 +19,7 @@ Manage named presets ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API * [runware preset delete](runware_preset_delete.md) - Delete a preset * [runware preset list](runware_preset_list.md) - List all saved presets * [runware preset save](runware_preset_save.md) - Save a named preset diff --git a/docs/runware_result.md b/docs/runware_result.md index 7463639..a5be052 100644 --- a/docs/runware_result.md +++ b/docs/runware_result.md @@ -50,5 +50,5 @@ runware result [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/docs/runware_run.md b/docs/runware_run.md index 024ccd6..db5a88d 100644 --- a/docs/runware_run.md +++ b/docs/runware_run.md @@ -96,5 +96,5 @@ runware run [key=value ...] [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/docs/runware_upload.md b/docs/runware_upload.md index 6a53a1c..8028847 100644 --- a/docs/runware_upload.md +++ b/docs/runware_upload.md @@ -50,5 +50,5 @@ runware upload [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/docs/runware_version.md b/docs/runware_version.md index 9e2ebaa..4fa028a 100644 --- a/docs/runware_version.md +++ b/docs/runware_version.md @@ -30,5 +30,5 @@ runware version [flags] ### SEE ALSO -* [runware](runware.md) - CLI tool for the Runware inference API +* [runware](runware.md) - CLI tool for the Runware API diff --git a/internal/cmd/root.go b/internal/cmd/root.go index fe7eac1..85310e7 100644 --- a/internal/cmd/root.go +++ b/internal/cmd/root.go @@ -39,9 +39,9 @@ func NewRootCmd(logger *log.Logger) *cobra.Command { root := &cobra.Command{ Use: "runware", - Short: "CLI tool for the Runware inference API", - Long: `A command-line tool for interacting with the Runware inference API. -Generate images, search models, manage your account, and more. + Short: "CLI tool for the Runware API", + Long: `A command-line tool for interacting with the full Runware API. +Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more. Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy).`, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { From d6b32f301c5b0375d13b0bde986c77d7be4a28dc Mon Sep 17 00:00:00 2001 From: Dan Richards Date: Tue, 23 Jun 2026 11:11:01 +0100 Subject: [PATCH 2/2] clarification on api coverage --- docs/runware.md | 2 +- internal/cmd/root.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/runware.md b/docs/runware.md index ae7aab9..7db942b 100644 --- a/docs/runware.md +++ b/docs/runware.md @@ -4,7 +4,7 @@ CLI tool for the Runware API ### Synopsis -A command-line tool for interacting with the full Runware API. +A command-line tool for interacting with the Runware API. Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more. Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy). diff --git a/internal/cmd/root.go b/internal/cmd/root.go index 85310e7..5fd4aa6 100644 --- a/internal/cmd/root.go +++ b/internal/cmd/root.go @@ -40,7 +40,7 @@ func NewRootCmd(logger *log.Logger) *cobra.Command { root := &cobra.Command{ Use: "runware", Short: "CLI tool for the Runware API", - Long: `A command-line tool for interacting with the full Runware API. + Long: `A command-line tool for interacting with the Runware API. Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more. Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy).`,