Commands
loadout <command> [flags]loadout help <command>| Command | What it does |
|---|---|
init | Create your configuration |
apply | Render the shell file |
doctor | Report anything that would not work here |
describe | What a command does, how to call it, what it needs |
catalog | What the shipped set contains |
ui | Local web interface |
bin | Manage executables on your PATH |
cred | Secrets in your OS keychain |
env | Print export lines for the active credentials |
identity | Switch git author, SSH key and credentials together |
sync | Keep your configuration in git across machines |
scan | Check your config for anything credential-shaped |
update | Update loadout itself |
uninstall | Remove everything loadout put here |
version | Print the version |
loadout init
Section titled “loadout init”Create your configuration. Asks a short series of questions with detected values offered as defaults.
| Flag | Default | Effect |
|---|---|---|
--defaults | false | Accept all defaults without asking |
--force | false | Overwrite an existing configuration |
loadout apply
Section titled “loadout apply”Render your configuration into the shell file. The only command that writes the file your shell sources.
| Flag | Default | Effect |
|---|---|---|
--shell | zsh | Dialect to generate: zsh or bash |
--platform | current | Target platform: linux or darwin |
--stdout | false | Write to stdout instead of the config directory |
--out | — | Write to this path instead of the default |
--platform renders for a machine you are not on, which is useful for inspecting what a configuration produces elsewhere. It does not change what your own shell gets.
loadout doctor
Section titled “loadout doctor”Check that everything your configuration asks for actually works here.
| Flag | Default | Effect |
|---|---|---|
-v, --verbose | false | List passing checks too |
loadout describe
Section titled “loadout describe”loadout describe [command]Explain what a command does, how to call it, and what it needs — with requirements resolved against this machine. With no argument, lists everything describable.
loadout catalog
Section titled “loadout catalog”Show what the shipped catalog contains.
loadout ui
Section titled “loadout ui”Open the local web interface. Runs until you stop it.
| Flag | Default | Effect |
|---|---|---|
--port | 0 | Port to listen on; 0 picks a free one |
--no-open | false | Do not launch a browser |
--print-url | false | Print only the URL, for scripting |
loadout bin
Section titled “loadout bin”Manage the executables loadout keeps on your PATH.
| Subcommand | What it does |
|---|---|
bin list | What is installed, what is pending, where it came from |
bin install [name...] | Install declared binaries and scripts |
bin remove <name> | Remove a managed binary |
| Flag | Applies to | Effect |
|---|---|---|
--force | install | Reinstall even when already current |
loadout cred
Section titled “loadout cred”Manage secrets stored in your OS keychain.
| Subcommand | What it does |
|---|---|
cred list | Declared credentials, which entry is active, which have values |
cred set <credential> <entry> | Store a value; prompts without echoing |
cred use <credential> <entry> | Make an entry the active one |
cred remove <credential> <entry> | Delete a stored value |
| Flag | Applies to | Effect |
|---|---|---|
--stdin | set | Read the value from stdin instead of prompting |
loadout env
Section titled “loadout env”Print export lines for the active credentials, reading values from the keychain.
eval "$(loadout env)"| Flag | Default | Effect |
|---|---|---|
--identity | — | Render the environment for this identity’s entries |
--quiet | false | Suppress diagnostics, for use in shell startup |
loadout identity
Section titled “loadout identity”Manage which git author, SSH key and credentials are active.
| Subcommand | What it does |
|---|---|
identity list | The configured identities, and which is active |
identity activate <id> | Switch this identity’s credential entries |
| Flag | Applies to | Effect |
|---|---|---|
--export | activate | Also print export statements for the new values |
loadout sync
Section titled “loadout sync”Keep your configuration in a git repository across machines.
| Subcommand | What it does |
|---|---|
sync init [remote-url] | Turn the config directory into a git repository |
sync remote [url] | Show or set the remote |
sync status | Show what would be synced |
sync push | Commit and push your configuration |
sync pull | Pull configuration from the remote |
| Flag | Applies to | Effect |
|---|---|---|
-m, --message | push | Commit message |
loadout scan
Section titled “loadout scan”Check your configuration for anything that looks like a live credential, without touching git. The same scan runs automatically before sync push commits.
loadout update
Section titled “loadout update”Update loadout to the latest release.
| Flag | Default | Effect |
|---|---|---|
--check | false | Report whether an update exists, install nothing |
--force | false | Install the latest even when versions cannot be compared |
--release | $LOADOUT_VERSION | Install a specific release |
--base-url | $LOADOUT_BASE_URL | Fetch from a mirror |
loadout uninstall
Section titled “loadout uninstall”Remove everything loadout has put on this machine. Lists without removing unless --yes.
| Flag | Default | Effect |
|---|---|---|
--yes | false | Actually remove things |
--keep-config | false | Keep ~/.config/loadout for a reinstall |
--keep-credentials | false | Leave the keychain untouched, and do not ask |
loadout version
Section titled “loadout version”Print the version. Reports a development build when the binary was not produced by the release process.