diff --git a/docs.json b/docs.json index 74606b2a..6f4058f5 100644 --- a/docs.json +++ b/docs.json @@ -423,6 +423,7 @@ "runpodctl/reference/runpodctl-pod", "runpodctl/reference/runpodctl-serverless", "runpodctl/reference/runpodctl-template", + "runpodctl/reference/runpodctl-model", "runpodctl/reference/runpodctl-hub", "runpodctl/reference/runpodctl-network-volume", "runpodctl/reference/runpodctl-registry", diff --git a/runpodctl/overview.mdx b/runpodctl/overview.mdx index 8fa4d651..48fa2093 100644 --- a/runpodctl/overview.mdx +++ b/runpodctl/overview.mdx @@ -181,6 +181,7 @@ Runpod CLI organizes commands into groups based on the resource type: | `runpodctl pod` | | Manage Pods (create, list, start, stop, delete) | | `runpodctl serverless` | `sls` | Manage Serverless endpoints | | `runpodctl template` | `tpl` | List, search, and manage templates | +| `runpodctl model` | | Manage models in the model repository (add, list, remove) | | `runpodctl hub` | | Browse and deploy from the Runpod Hub | | `runpodctl network-volume` | `nv` | Manage network volumes | | `runpodctl registry` | `reg` | Manage container registry authentications | diff --git a/runpodctl/reference/runpodctl-config.mdx b/runpodctl/reference/runpodctl-config.mdx index c4644628..70b636b5 100644 --- a/runpodctl/reference/runpodctl-config.mdx +++ b/runpodctl/reference/runpodctl-config.mdx @@ -35,6 +35,22 @@ Your Runpod API key, which authenticates the CLI to access your account. You can The Runpod API endpoint URL. The default value should work for most users. +## Environment variables + +You can also configure the CLI using environment variables. When set, these take precedence over the corresponding values in your config file. + + +Your Runpod API key. Overrides the `apiKey` value in your config file. + + + +The Runpod GraphQL API endpoint URL. Overrides the `apiUrl` value in your config file. + + + +The Runpod REST API endpoint URL. Overrides the `restApiUrl` value in your config file. + + ## Related commands - [`runpodctl doctor`](/runpodctl/reference/runpodctl-doctor) diff --git a/runpodctl/reference/runpodctl-model.mdx b/runpodctl/reference/runpodctl-model.mdx new file mode 100644 index 00000000..d39f09af --- /dev/null +++ b/runpodctl/reference/runpodctl-model.mdx @@ -0,0 +1,111 @@ +--- +title: "model" +sidebarTitle: "model" +--- + +Manage models in the Runpod model repository. Use these subcommands to upload model files, list your models, and remove models or individual model versions. + + +```bash Command +runpodctl model [flags] +``` + + +## Subcommands + +### Add a model + +Add a model to the model repository. To upload model files from your local machine, point `--model-path` at the directory that contains them: + +```bash +runpodctl model add --name "my-model" --owner "my-team" --model-path ./model +``` + +When you upload from a directory in a terminal, `runpodctl` shows a progress bar with upload progress and estimated time remaining, then prints the total model size once the upload finishes. + +#### Add flags + + +Model name. + + + +Model owner namespace (a user or team owner ID). + + + +Directory containing the model files to upload. + + + +Wait for uploaded model files to finish hashing before the command returns. Requires `--model-path`. When hashing completes, `runpodctl` prints a message confirming the model is ready to deploy along with its model URL. + + + +Maximum time to wait when `--wait-for-hash` is set. Set to `0` to wait indefinitely. + + + +Include the full upload details in the `--wait-for-hash` output. Without this flag, a compact summary is printed instead. + + + + +`runpodctl model add` also accepts lower-level flags for configuring uploads directly, such as `--content-type`, `--file-name`, `--file-size`, `--part-size`, `--metadata`, and `--model-status`. Run `runpodctl model add --help` to see the complete list. + + + +### List models + +List the models in your model repository: + +```bash +runpodctl model list +``` + +#### List flags + + +Filter the results by model name. + + + +Filter the results by provider. + + +### Remove a model + +Remove a model from the model repository: + +```bash +runpodctl model remove --name "my-model" --owner "my-team" +``` + +To remove a single model version instead of the entire model, pass either `--hash` or `--version`. This marks that version as removed and leaves the rest of the model in place. + +```bash +runpodctl model remove --name "my-model" --owner "my-team" --version "" +``` + +#### Remove flags + + +Model name. + + + +Model owner. + + + +Hash of the model version to remove. Cannot be combined with `--version`. + + + +UUID of the model version to remove. Cannot be combined with `--hash`. + + +## Related commands + +- [`runpodctl serverless`](/runpodctl/reference/runpodctl-serverless) +- [`runpodctl config`](/runpodctl/reference/runpodctl-config)