CLI
Command-line reference
Modes
| Mode | Description |
|---|---|
local | Manage the local machine. |
check-local | Show configuration differences on the local machine (no changes). |
apply | Converge multiple remote hosts over SSH to the declared state. |
run | Same converge path as apply, under a less-loaded name. |
plan | Show intended operations over SSH without changing anything (dry-run). |
check | Run syntax-check and inventory-check in one pass. |
show-inventory | Display resolved inventory hosts and groups. |
pull | Pull and apply configuration locally, with optional inventory for variables. |
syntax-check | Statically validate playbooks/roles/tasks/templates (no execution). |
inventory-check | Validate an inventory tree (groups, group_vars, host_vars). |
docs | Build and serve this documentation site locally. |
install | Install the running jetpack binary to /usr/local/bin/jetpack and symlink /usr/local/bin/jetp to it. |
Flags
| Flag | Takes value | Description |
|---|---|---|
--allow-localhost-delegation | no | — |
--ask-login-password | no | — |
--async | no | Run tasks asynchronously (per-host parallelism). |
--batch-size | yes | — |
--check | yes | — |
--chroot | yes | — |
--config | yes | — |
--environment | yes | — |
--extra-vars | yes | Inject extra variables from a YAML file or quoted JSON. |
--forward-agent | no | Enable SSH agent forwarding for specific tasks (e.g. git). |
--groups | yes | — |
--help | yes | — |
--inventory | yes | Inventory path; may be given multiple times (later paths overlay earlier ones). |
--limit-groups | yes | Restrict the run to these groups. |
--limit-hosts | yes | Restrict the run to these hosts. |
--modules | yes | — |
--no-browser | no | (docs mode) Print the local docs URL instead of opening a browser. |
--no-secrets | yes | — |
--playbook | yes | Playbook path(s); the automation content to run. |
--port | yes | SSH port (ssh modes) or HTTP port (docs mode). |
--profile | yes | — |
--roles | yes | — |
--show-groups | yes | — |
--show-hosts | yes | — |
--sudo | yes | Sudo to this user for all tasks by default. |
--tags | yes | Only run tasks/roles with one of these tags. |
--threads | yes | Number of parallel threads. |
--url | yes | — |
--user | yes | SSH user (defaults to $JET_SSH_USER or $USER). |
--version | yes | — |
-E | yes | — |
-e | yes | Inject extra variables from a YAML file or quoted JSON. |
-i | yes | Inventory path; may be given multiple times (later paths overlay earlier ones). |
-m | yes | — |
-p | yes | Playbook path(s); the automation content to run. |
-r | yes | — |
-t | yes | Number of parallel threads. |
-u | yes | SSH user (defaults to $JET_SSH_USER or $USER). |
-v | no | Increase verbosity (-v, -vv, -vvv). |
-vv | no | — |
-vvv | no | — |