Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit 2e57a18

Browse files
authored
Merge pull request #367 from jumpstarter-dev/unified-cli
Unified cli
2 parents 27d1981 + 28e4c74 commit 2e57a18

55 files changed

Lines changed: 458 additions & 823 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ clean: clean-docs clean-venv clean-build clean-test
6262
.PHONY: sync docs docs-all serve-all test test-packages build clean-test clean-docs clean-venv clean-build \
6363
mypy-jumpstarter \
6464
mypy-jumpstarter-cli-admin \
65-
mypy-jumpstarter-cli-client \
6665
mypy-jumpstarter-driver-can \
6766
mypy-jumpstarter-driver-dutlink \
6867
mypy-jumpstarter-driver-network \

docs/source/api-reference/drivers/flashers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ This doesn't work with sphinx-click, so we'll just use the raw CLI
8585
```
8686
-->
8787
```bash
88-
$ jmp client shell -l board ti-03
88+
$ jmp shell -l board=ti-03
8989
INFO:jumpstarter.client.lease:Created lease request for labels {'board': 'ti-03'} for 0:30:00
9090
jumpstarter ⚡remote ➤ j storage
9191
Usage: j storage [OPTIONS] COMMAND [ARGS]...

docs/source/api-reference/drivers/yepkit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ client.power.off()
5151

5252
### CLI access
5353
```bash
54-
$ sudo ~/.cargo/bin/uv run jmp exporter shell -c ./packages/jumpstarter-driver-yepkit/examples/exporter.yaml
54+
$ sudo ~/.cargo/bin/uv run jmp shell --exporter-config ./packages/jumpstarter-driver-yepkit/examples/exporter.yaml
5555
WARNING:Ykush:No serial number provided for ykush, using the first one found: YK25838
5656
INFO:Ykush:Power OFF for Ykush YK25838 on port 1
5757
INFO:Ykush:Power OFF for Ykush YK25838 on port 2

docs/source/cli/clients.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ self-signed certificates.
8282

8383
3. Those details can be installed as a secret on CI, or passed down to the final user.
8484

85-
Then the user can create the client using the [jmp client](./reference/jmp-client.md#jmp-client-config-create) CLI:
85+
Then the user can create the client using the [jmp](./reference/jmp.md#jmp-config-client-create) CLI:
8686

8787
```bash
88-
$ jmp client config create my-client
88+
$ jmp config client create my-client
8989
Enter a valid Jumpstarter service endpoint: devl.jumpstarter.dev
9090
Enter a Jumpstarter auth token (hidden): ***
9191
Enter a comma-separated list of allowed driver packages (optional):

docs/source/cli/reference/index.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,24 @@ This section provides details on the Jumpstarter CLI.
55
## jmp
66

77
The base jmp command contains a set of subcommands for the different featuers, those
8-
can also be installed and used independently as `jmp-admin`, `jmp-client`, and
9-
`jmp-exporter`, `jmp-driver`.
8+
can also be installed and used independently as `jmp-admin` and `jmp`.
109

1110
```bash
1211
jmp [OPTIONS] COMMAND [ARGS]...
1312
```
1413

1514
### commands
1615

17-
```{toctree}
18-
:maxdepth: 1
19-
jmp-admin.md
20-
```
21-
2216
The `jmp-admin` or `jmp admin` CLI allows administration of exporters and clients in a Kubernetes cluster. To use this CLI, you must have a valid `kubeconfig` and access to the cluter/namespace where the Jumpstarter controller resides.
2317

2418
```{toctree}
2519
:maxdepth: 1
26-
jmp-client.md
20+
jmp-admin.md
2721
```
2822

29-
The `jmp-client` or `jmp client` CLI allows interaction with Jumpstarter as a clients.
30-
31-
32-
```{toctree}
33-
:maxdepth: 1
34-
jmp-exporter.md
35-
```
36-
The `jmp-exporter` or `jmp exporter` CLI allows you to run Jumpstarter exporters as services, container, or standalone.
23+
The `jmp` CLI allows interaction with Jumpstarter as a clients or exporter.
3724

3825
```{toctree}
3926
:maxdepth: 1
40-
jmp-driver.md
27+
jmp.md
4128
```
42-
43-
The `jmp-driver` or `jmp driver` CLI allows you to list and create Jumpstarter drivers.

docs/source/cli/reference/jmp-admin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# admin
1+
# jmp-admin
22

33
```{eval-rst}
44
.. click:: jumpstarter_cli_admin:admin

docs/source/cli/reference/jmp-client.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/cli/reference/jmp-driver.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/cli/reference/jmp-exporter.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/cli/reference/jmp.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# jmp
2+
3+
```{eval-rst}
4+
.. click:: jumpstarter_cli:jmp
5+
:prog: jmp
6+
:nested: full
7+
```

0 commit comments

Comments
 (0)