Skip to content

Commit 20d5fa5

Browse files
committed
fix(upload): help example fails with missing uniqueIdentifier
1 parent dcb528b commit 20d5fa5

2 files changed

Lines changed: 15 additions & 9 deletions

File tree

docs/runware_model_upload.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ runware model upload [flags]
2222

2323
```
2424
# Upload a FLUX checkpoint from a hosted safetensors file
25-
runware model upload --air "myorg:42@1" \
25+
# NOTE: --air must use your configured AIR source (see: runware account details)
26+
runware model upload --air "<your-air-source>:42@1" \
27+
--unique-identifier "my-custom-model-v1" \
2628
--category checkpoint \
2729
--architecture flux1d \
2830
--name "My Custom Model"\
@@ -31,7 +33,8 @@ runware model upload [flags]
3133
--private
3234
3335
# Upload a LoRA with metadata and defaults
34-
runware model upload --air "myorg:42@1" \
36+
runware model upload --air "<your-air-source>:42@1" \
37+
--unique-identifier "style-lora-v1" \
3538
--category lora \
3639
--architecture sdxl \
3740
--name "Style LoRA" \
@@ -46,7 +49,7 @@ runware model upload [flags]
4649
### Options
4750

4851
```
49-
--air string Custom AIR identifier (provider:model@version)
52+
--air string Custom AIR identifier (<air-source>:<name>@<version>; see 'runware account details' for your air-source)
5053
-a, --architecture string Model architecture (e.g. flux1d, sdxl, sd1x)
5154
-c, --category string Model category: checkpoint, lora, lycoris, vae, embeddings
5255
--comment string Internal notes
@@ -65,7 +68,7 @@ runware model upload [flags]
6568
--short-description string Brief model summary
6669
--tags strings Comma-separated categorical labels
6770
-t, --type string Model type (checkpoint: base, inpainting; lora/embeddings: positive, negative)
68-
--unique-identifier string Custom unique identifier for the model
71+
--unique-identifier string Unique identifier for this model version/state (5-64 chars)
6972
--version string Version identifier (e.g. 1.0)
7073
```
7174

internal/cmd/model/upload.go

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ identifier is printed and the model can be used with 'runware run'.
7676
7777
NOTE: "model upload" is only supported by the WebSocket (ws) transport. If you have your default transport configured as http you must set the --transport ws flag when calling "model upload"`,
7878
Example: ` # Upload a FLUX checkpoint from a hosted safetensors file
79-
runware model upload --air "myorg:42@1" \
79+
# NOTE: --air must use your configured AIR source (see: runware account details)
80+
runware model upload --air "<your-air-source>:42@1" \
81+
--unique-identifier "my-custom-model-v1" \
8082
--category checkpoint \
8183
--architecture flux1d \
8284
--name "My Custom Model"\
@@ -85,7 +87,8 @@ NOTE: "model upload" is only supported by the WebSocket (ws) transport. If you h
8587
--private
8688
8789
# Upload a LoRA with metadata and defaults
88-
runware model upload --air "myorg:42@1" \
90+
runware model upload --air "<your-air-source>:42@1" \
91+
--unique-identifier "style-lora-v1" \
8992
--category lora \
9093
--architecture sdxl \
9194
--name "Style LoRA" \
@@ -166,8 +169,8 @@ NOTE: "model upload" is only supported by the WebSocket (ws) transport. If you h
166169
f.StringVarP(&flags.architecture, "architecture", "a", "", "Model architecture (e.g. flux1d, sdxl, sd1x)")
167170
f.StringVar(&flags.format, "format", "safetensors", "Model file format")
168171
f.StringVarP(&flags.modelType, "type", "t", "", "Model type (checkpoint: base, inpainting; lora/embeddings: positive, negative)")
169-
f.StringVar(&flags.air, "air", "", "Custom AIR identifier (provider:model@version)")
170-
f.StringVar(&flags.uniqueIdentifier, "unique-identifier", "", "Custom unique identifier for the model")
172+
f.StringVar(&flags.air, "air", "", "Custom AIR identifier (<air-source>:<name>@<version>; see 'runware account details' for your air-source)")
173+
f.StringVar(&flags.uniqueIdentifier, "unique-identifier", "", "Unique identifier for this model version/state (5-64 chars)")
171174
f.StringVar(&flags.heroImageURL, "hero-image-url", "", "URL of a display image for the model")
172175
f.StringSliceVar(&flags.tags, "tags", nil, "Comma-separated categorical labels")
173176
f.StringVar(&flags.shortDescription, "short-description", "", "Brief model summary")
@@ -180,7 +183,7 @@ NOTE: "model upload" is only supported by the WebSocket (ws) transport. If you h
180183
f.Float64Var(&flags.defaultWeight, "default-weight", 0, "Default weight (lora, lycoris)")
181184
f.StringVar(&flags.positiveTriggerWords, "positive-trigger-words", "", "Activation keywords (lora, lycoris)")
182185

183-
for _, name := range []string{"category", "name", "version", "download-url", "architecture"} {
186+
for _, name := range []string{"air", "unique-identifier", "category", "name", "version", "download-url", "architecture"} {
184187
if err := cmd.MarkFlagRequired(name); err != nil {
185188
panic(err)
186189
}

0 commit comments

Comments
 (0)