Skip to content

Commit 86db2c1

Browse files
chore: adds privacy and terms to help text (#67)
Adds links to Run terms of service and privacy policy to the help text --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 3ec7799 commit 86db2c1

3 files changed

Lines changed: 27 additions & 3 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,13 @@ runware run <model> [key=value ...] [flags]
6363

6464
| Flag | Description |
6565
|------|-------------|
66+
| `--preset` | Load parameters from a saved preset (model and params used as defaults; `<model>` may be omitted when the preset provides one) |
6667
| `--task-type` | Override detected task type (e.g. `imageInference`, `videoInference`, `audioInference`, `textInference`) |
6768
| `--output-dir` | Directory to save downloaded output files (default `./outputs`) |
6869
| `--no-download` | Skip auto-downloading media files |
6970
| `--delivery-method` | Delivery method (`sync` or `async`) (default `async`) |
7071
| `--poll-interval` | Polling interval for async requests (default `2s`) |
72+
| `--validate` | Validate parameters against the model schema before submitting |
7173

7274
#### Image generation
7375

@@ -155,7 +157,7 @@ runware model schema google:3@2 --response # Show response schema i
155157
Save frequently used configurations:
156158

157159
```shell
158-
runware preset save quick-flux --model runware:100@1 --width 512 --height 512 --steps 4
160+
runware preset save quick-flux runware:100@1 width=512 height=512 steps=4
159161
runware preset list
160162
runware preset show quick-flux
161163
runware preset delete quick-flux
@@ -172,6 +174,22 @@ runware config path # Print config file path
172174

173175
Config is stored at `~/.runware/config.yaml`.
174176

177+
### Upload
178+
179+
```shell
180+
runware upload <file|url> # Upload an image asset; prints imageUUID (and taskUUID) for use in run params
181+
```
182+
183+
Accepts a local file path, public URL, or data URI. The returned imageUUID can be passed to parameters like `inputs.seedImage=<imageUUID>` on the `run` command. The taskUUID can be used with `runware result`.
184+
185+
### Result
186+
187+
```shell
188+
runware result <taskUUID> # Resume waiting for an async task by UUID
189+
```
190+
191+
Use when `runware run` was interrupted before a task completed. The taskUUID is printed when the task is first submitted.
192+
175193
### Other
176194

177195
```shell
@@ -315,7 +333,8 @@ Once installed, `Tab` works at every level:
315333
# Complete subcommands
316334
$ runware <Tab>
317335
auth account completion config model
318-
ping preset run version
336+
ping preset result run upload
337+
version
319338
320339
# Complete model AIR identifiers for `run`
321340
$ runware run <Tab>

docs/runware.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ CLI tool for the Runware inference API
77
A command-line tool for interacting with the Runware inference API.
88
Generate images, search models, manage your account, and more.
99

10+
Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy).
11+
1012
### Options
1113

1214
```

internal/cmd/root.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ func NewRootCmd(logger *log.Logger) *cobra.Command {
4040
root := &cobra.Command{
4141
Use: "runware",
4242
Short: "CLI tool for the Runware inference API",
43-
Long: "A command-line tool for interacting with the Runware inference API.\nGenerate images, search models, manage your account, and more.",
43+
Long: `A command-line tool for interacting with the Runware inference API.
44+
Generate images, search models, manage your account, and more.
45+
46+
Use of Runware services is subject to our Terms of Service (https://runware.ai/terms) and Privacy Policy (https://runware.ai/privacy).`,
4447
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
4548
if verbose, _ := cmd.Root().PersistentFlags().GetBool("verbose"); verbose {
4649
logger.SetLevel(log.DebugLevel)

0 commit comments

Comments
 (0)