Skip to content

Commit feb478d

Browse files
committed
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.
1 parent 369c413 commit feb478d

14 files changed

Lines changed: 20 additions & 18 deletions

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Runware CLI
22

3-
A command-line tool for interacting with the [Runware](https://runware.ai) inference API. Built in Go, distributed as a single static binary.
3+
A command-line tool for interacting with the [Runware](https://runware.ai) API. Built in Go, distributed as a single static binary.
4+
5+
Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more.
46

57
## Install
68

docs/runware.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
## runware
22

3-
CLI tool for the Runware inference API
3+
CLI tool for the Runware API
44

55
### Synopsis
66

7-
A command-line tool for interacting with the Runware inference API.
8-
Generate images, search models, manage your account, and more.
7+
A command-line tool for interacting with the full Runware API.
8+
Run image generation, video generation, audio generation, 3D, upscaling, background removal, captioning, search models, and more.
99

1010
Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy).
1111

docs/runware_account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ Account information, team, and API keys
2626

2727
### SEE ALSO
2828

29-
* [runware](runware.md) - CLI tool for the Runware inference API
29+
* [runware](runware.md) - CLI tool for the Runware API
3030
* [runware account details](runware_account_details.md) - Show account details, team, API keys, and usage
3131

docs/runware_auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Login, logout, and check authentication status.
2323

2424
### SEE ALSO
2525

26-
* [runware](runware.md) - CLI tool for the Runware inference API
26+
* [runware](runware.md) - CLI tool for the Runware API
2727
* [runware auth login](runware_auth_login.md) - Authenticate with an API key
2828
* [runware auth logout](runware_auth_logout.md) - Clear stored credentials
2929
* [runware auth status](runware_auth_status.md) - Show current auth state

docs/runware_completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ runware completion [bash|zsh|fish|powershell] [flags]
5959

6060
### SEE ALSO
6161

62-
* [runware](runware.md) - CLI tool for the Runware inference API
62+
* [runware](runware.md) - CLI tool for the Runware API
6363

docs/runware_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Manage CLI configuration
1919

2020
### SEE ALSO
2121

22-
* [runware](runware.md) - CLI tool for the Runware inference API
22+
* [runware](runware.md) - CLI tool for the Runware API
2323
* [runware config path](runware_config_path.md) - Print config file path
2424
* [runware config reset](runware_config_reset.md) - Reset configuration defaults
2525
* [runware config set](runware_config_set.md) - Set a config value

docs/runware_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Manage and search models
1919

2020
### SEE ALSO
2121

22-
* [runware](runware.md) - CLI tool for the Runware inference API
22+
* [runware](runware.md) - CLI tool for the Runware API
2323
* [runware model examples](runware_model_examples.md) - Show example requests for a model
2424
* [runware model pricing](runware_model_pricing.md) - Show pricing for a model
2525
* [runware model schema](runware_model_schema.md) - Show the request/response schema for a model

docs/runware_ping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ runware ping [flags]
3030

3131
### SEE ALSO
3232

33-
* [runware](runware.md) - CLI tool for the Runware inference API
33+
* [runware](runware.md) - CLI tool for the Runware API
3434

docs/runware_preset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Manage named presets
1919

2020
### SEE ALSO
2121

22-
* [runware](runware.md) - CLI tool for the Runware inference API
22+
* [runware](runware.md) - CLI tool for the Runware API
2323
* [runware preset delete](runware_preset_delete.md) - Delete a preset
2424
* [runware preset list](runware_preset_list.md) - List all saved presets
2525
* [runware preset save](runware_preset_save.md) - Save a named preset

docs/runware_result.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,5 @@ runware result <taskUUID> [flags]
5050

5151
### SEE ALSO
5252

53-
* [runware](runware.md) - CLI tool for the Runware inference API
53+
* [runware](runware.md) - CLI tool for the Runware API
5454

0 commit comments

Comments
 (0)