Skip to content

docs: sync getting-started guide with CLI commands #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rishi-jat wants to merge 3 commits into
base: main
Choose a base branch
from
+22 −0
Open

docs: sync getting-started guide with CLI commands #427

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3354312
docs: align getting-started guide with CLI commands
rishi-jat Feb 27, 2026
6b55963
apply gemini suggestion
rishi-jat Feb 27, 2026
ce46eca
remove
rishi-jat Feb 27, 2026
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
22 changes: 22 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -168,6 +174,22 @@ $ 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
```

### Cleanup

Delete the model artifact in the local storage:
Expand Down