Skip to content

Commands

Terminal window
loadout <command> [flags]
loadout help <command>
CommandWhat it does
initCreate your configuration
applyRender the shell file
doctorReport anything that would not work here
describeWhat a command does, how to call it, what it needs
catalogWhat the shipped set contains
uiLocal web interface
binManage executables on your PATH
credSecrets in your OS keychain
envPrint export lines for the active credentials
identitySwitch git author, SSH key and credentials together
syncKeep your configuration in git across machines
scanCheck your config for anything credential-shaped
updateUpdate loadout itself
uninstallRemove everything loadout put here
versionPrint the version

Create your configuration. Asks a short series of questions with detected values offered as defaults.

FlagDefaultEffect
--defaultsfalseAccept all defaults without asking
--forcefalseOverwrite an existing configuration

Render your configuration into the shell file. The only command that writes the file your shell sources.

FlagDefaultEffect
--shellzshDialect to generate: zsh or bash
--platformcurrentTarget platform: linux or darwin
--stdoutfalseWrite 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.

Check that everything your configuration asks for actually works here.

FlagDefaultEffect
-v, --verbosefalseList passing checks too
Terminal window
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.

Show what the shipped catalog contains.

Open the local web interface. Runs until you stop it.

FlagDefaultEffect
--port0Port to listen on; 0 picks a free one
--no-openfalseDo not launch a browser
--print-urlfalsePrint only the URL, for scripting

Manage the executables loadout keeps on your PATH.

SubcommandWhat it does
bin listWhat is installed, what is pending, where it came from
bin install [name...]Install declared binaries and scripts
bin remove <name>Remove a managed binary
FlagApplies toEffect
--forceinstallReinstall even when already current

Manage secrets stored in your OS keychain.

SubcommandWhat it does
cred listDeclared 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
FlagApplies toEffect
--stdinsetRead the value from stdin instead of prompting

Print export lines for the active credentials, reading values from the keychain.

Terminal window
eval "$(loadout env)"
FlagDefaultEffect
--identity—Render the environment for this identity’s entries
--quietfalseSuppress diagnostics, for use in shell startup

Manage which git author, SSH key and credentials are active.

SubcommandWhat it does
identity listThe configured identities, and which is active
identity activate <id>Switch this identity’s credential entries
FlagApplies toEffect
--exportactivateAlso print export statements for the new values

Keep your configuration in a git repository across machines.

SubcommandWhat it does
sync init [remote-url]Turn the config directory into a git repository
sync remote [url]Show or set the remote
sync statusShow what would be synced
sync pushCommit and push your configuration
sync pullPull configuration from the remote
FlagApplies toEffect
-m, --messagepushCommit message

Check your configuration for anything that looks like a live credential, without touching git. The same scan runs automatically before sync push commits.

Update loadout to the latest release.

FlagDefaultEffect
--checkfalseReport whether an update exists, install nothing
--forcefalseInstall the latest even when versions cannot be compared
--release$LOADOUT_VERSIONInstall a specific release
--base-url$LOADOUT_BASE_URLFetch from a mirror

Remove everything loadout has put on this machine. Lists without removing unless --yes.

FlagDefaultEffect
--yesfalseActually remove things
--keep-configfalseKeep ~/.config/loadout for a reinstall
--keep-credentialsfalseLeave the keychain untouched, and do not ask

Print the version. Reports a development build when the binary was not produced by the release process.