From 3354312d08b9f1c0cd3634c1c0ccbbb94568ce15 Mon Sep 17 00:00:00 2001 From: Rishi Jat Date: Fri, 27 Feb 2026 08:35:09 +0530 Subject: [PATCH 1/3] docs: align getting-started guide with CLI commands Signed-off-by: Rishi Jat --- docs/getting-started.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 3d02c928..0bd3b73a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -168,6 +168,46 @@ $ modctl upload model-00001-of-00003.safetensors --repo registry.com/models/llam ``` +### Tag + +Tag an existing model artifact with a new reference: + +```shell +$ modctl tag registry.com/models/llama3:v1.0.0 registry.com/models/llama3:v1.0.1 +``` + +### Inspect + +Inspect metadata for a model artifact: + +```shell +$ modctl inspect registry.com/models/llama3:v1.0.0 +``` + +### Version + +Display modctl version information: + +```shell +$ modctl version +``` + +### Logout + +Logout from a registry: + +```shell +$ modctl logout example.registry.com +``` + +### Completion + +Generate shell completion scripts: + +```shell +$ modctl completion bash +``` + ### Cleanup Delete the model artifact in the local storage: From 6b55963c1498113e2f0ca68a470af0eaa6b5c2c0 Mon Sep 17 00:00:00 2001 From: Rishi Jat Date: Fri, 27 Feb 2026 08:54:28 +0530 Subject: [PATCH 2/3] apply gemini suggestion Signed-off-by: Rishi Jat --- docs/getting-started.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 0bd3b73a..8c2e84fe 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -104,6 +104,12 @@ Before the `pull` or `push` command, you need to login the registry: $ modctl login -u username -p password example.registry.com ``` +Logout from a registry: + +```shell +$ modctl logout example.registry.com +``` + Pull the model artifact from the registry: ```shell @@ -184,7 +190,9 @@ Inspect metadata for a model artifact: $ modctl inspect registry.com/models/llama3:v1.0.0 ``` -### Version +### Utilities + +#### Version Display modctl version information: @@ -192,15 +200,7 @@ Display modctl version information: $ modctl version ``` -### Logout - -Logout from a registry: - -```shell -$ modctl logout example.registry.com -``` - -### Completion +#### Completion Generate shell completion scripts: From ce46eca0c8e10665a30af32120822780e54194ae Mon Sep 17 00:00:00 2001 From: Rishi Jat Date: Fri, 27 Feb 2026 14:41:26 +0530 Subject: [PATCH 3/3] remove Signed-off-by: Rishi Jat --- docs/getting-started.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 8c2e84fe..3c19b00a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -190,24 +190,6 @@ Inspect metadata for a model artifact: $ modctl inspect registry.com/models/llama3:v1.0.0 ``` -### Utilities - -#### Version - -Display modctl version information: - -```shell -$ modctl version -``` - -#### Completion - -Generate shell completion scripts: - -```shell -$ modctl completion bash -``` - ### Cleanup Delete the model artifact in the local storage: