client

jmp-client

Jumpstarter client CLI tool

jmp-client [OPTIONS] COMMAND [ARGS]...

Options

-l, --log-level <log_level>

Set the log level

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

create-config

Create a client config.

jmp-client create-config [OPTIONS] ALIAS

Options

-o, --out <out>

Specify an output file for the client config.

--namespace <namespace>

Enter the Jumpstarter client namespace.

--name <name>

Enter the Jumpstarter client name.

-e, --endpoint <endpoint>

Enter the Jumpstarter service endpoint.

-t, --token <token>

A valid Jumpstarter auth token generated by the Jumpstarter service.

-a, --allow <allow>

A comma-separated list of driver client packages to load.

--unsafe

Should all driver client packages be allowed to load (UNSAFE!).

Arguments

ALIAS

Required argument

delete-config

Delete a client config.

jmp-client delete-config [OPTIONS] NAME

Arguments

NAME

Required argument

lease

Manage leases held by the current client

jmp-client lease [OPTIONS] COMMAND [ARGS]...

list

jmp-client lease list [OPTIONS] [NAME]

Arguments

NAME

Optional argument

release

jmp-client lease release [OPTIONS] [NAME]

Options

-l, --lease <lease>
--all

Arguments

NAME

Optional argument

request

jmp-client lease request [OPTIONS] [NAME]

Options

-l, --label <labels>

Arguments

NAME

Optional argument

list-configs

List available client configurations.

jmp-client list-configs [OPTIONS]

login

Login

jmp-client login [OPTIONS] ALIAS

Options

-e, --endpoint <endpoint>

Enter the Jumpstarter service endpoint.

--namespace <namespace>

Enter the Jumpstarter client namespace.

--name <name>

Enter the Jumpstarter client name.

--username <username>

Enter the OIDC username.

--password <password>

Enter the OIDC password.

--issuer <issuer>

Enter the OIDC issuer.

--allow <allow>

A comma-separated list of driver client packages to load.

--unsafe

Should all driver client packages be allowed to load (UNSAFE!).

--client-id <client_id>

OIDC client id

Arguments

ALIAS

Required argument

shell

Spawns a shell connecting to a leased remote exporter

jmp-client shell [OPTIONS] [NAME]

Options

-l, --label <labels>
-n, --lease <lease_name>

Arguments

NAME

Optional argument

use-config

Select the current client config.

jmp-client use-config [OPTIONS] NAME

Arguments

NAME

Required argument

version

Get the current Jumpstarter version

jmp-client version [OPTIONS]