Skip to main content

Jetveo CLI and SDK

jv is the Jetveo command line: it signs you in to a Jetveo cluster, installs the Jetveo SDK your project is built with, and runs the SDK's commands (jv validate, jv plan, …) for you. The Jetveo IDE uses the same sign-in and the same SDK cache, so signing in once serves both. A sign-in started from the IDE (Jetveo: Sign in to a cluster) shows "Jetveo IDE on your-machine" on the consent page, and the IDE comes back to the front once you approve it.

Sign in​

jv login eu.jetveo.io

Pass the cluster's domain or the address of its administration. jv opens your browser, where you sign in to the administration if you are not already, and confirms that you want to sign in jv on this machine. Back in the terminal jv reports who you are signed in as and whether your account holds a licence.

On a machine without a browser (SSH, a container, WSL) use the device flow:

jv login eu.jetveo.io --device

jv prints a short code and a web address. Open the address on any device, sign in, type the code and approve. jv waits for the approval and then stores the token like the browser flow does.

The token is kept in ~/.jetveo/credentials.json, readable by you only, and is valid for 90 days. You can be signed in to several clusters at once; a command then takes --host <cluster> or uses the default entry of the file.

jv auth status          # who is signed in where, and the licence state
jv logout               # revoke this machine's token and forget the cluster

Licences​

Downloading an SDK needs an active licence on your account. A Jetveo administrator grants it to your user in Platform Management; it has a start, an optional end, and can be revoked. Without one jv and the IDE still sign in, but jv sdk install answers that a licence is required. Ask your Jetveo contact to grant one.

Install an SDK​

jv sdk list               # versions the cluster offers, and the ones installed here
jv sdk install 1.4.0      # download, verify and unpack into ~/.jetveo/sdks/1.4.0
jv sdk uninstall 1.4.0

The download is verified against the SHA-256 the cluster publishes before it is unpacked.

The project's SDK​

A project pins the SDK it is built with in its .jvproj:

sdk: 1.4.0

The pin is required. Without it the project is invalid: jv refuses to run SDK commands for it, the IDE loads no SDK and the editor reports the missing key.

Every SDK command you run through jv uses exactly that version. If it is not installed yet, jv installs it first, so a fresh clone works after jv login. --sdk <version> overrides the pin for one run, and outside a project it is the only way to pick an SDK. The IDE reads the same key and loads the matching SDK when it opens the project; the project editor shows it as the SDK version field under Properties.

jv --help lists the commands of jv itself followed by the commands of the project's SDK. When it cannot list them, its last line says why: no .jvproj was found, the project has no pin, or the pinned SDK is not installed (with the jv sdk install command to run). jv --help never installs anything.

Tokens on your profile​

The administration lists the tokens issued to your machines under your profile, CLI tokens, with the host name, the creation date and the last activity. Revoke a token there when a machine is gone; the next jv command on it asks you to sign in again.