Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,13 @@ runware run <model> [key=value ...] [flags]

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

#### Image generation

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

```shell
runware preset save quick-flux --model runware:100@1 --width 512 --height 512 --steps 4
runware preset save quick-flux runware:100@1 width=512 height=512 steps=4
runware preset list
runware preset show quick-flux
runware preset delete quick-flux
Expand All @@ -172,6 +174,22 @@ runware config path # Print config file path

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

### Upload
Comment thread
danmrichards marked this conversation as resolved.

```shell
runware upload <file|url> # Upload an image asset; prints imageUUID (and taskUUID) for use in run params
```

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

### Result

```shell
runware result <taskUUID> # Resume waiting for an async task by UUID
```

Use when `runware run` was interrupted before a task completed. The taskUUID is printed when the task is first submitted.

### Other

```shell
Expand Down Expand Up @@ -315,7 +333,8 @@ Once installed, `Tab` works at every level:
# Complete subcommands
$ runware <Tab>
auth account completion config model
ping preset run version
ping preset result run upload
version

# Complete model AIR identifiers for `run`
$ runware run <Tab>
Expand Down
2 changes: 2 additions & 0 deletions docs/runware.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ CLI tool for the Runware inference API
A command-line tool for interacting with the Runware inference API.
Generate images, search models, manage your account, and more.

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

### Options

```
Expand Down
5 changes: 4 additions & 1 deletion internal/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ 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.\nGenerate images, search models, manage your account, and more.",
Long: `A command-line tool for interacting with the Runware inference API.
Generate images, search models, manage your account, 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 {
if verbose, _ := cmd.Root().PersistentFlags().GetBool("verbose"); verbose {
logger.SetLevel(log.DebugLevel)
Expand Down