credential
turnout credential <add|list|show|edit|remove> [...]turnout cred <...> # same thing, shorterA credential is a way to log in: a remote user, and whether it authenticates with a password or a private key file. The secret itself never lives here - it goes into the OS keyring under the credential’s name, managed with turnout pass.
Credentials are free-standing. One deploy account usually reaches several stands, so it is defined once and every server that accepts it points at the same name.
turnout credential add [NAME] [--user USER] [--auth password|key] [--key PATH]| Flag | Short | Description |
|---|---|---|
--user |
-u |
Remote user this logs in as |
--auth |
-a |
How it authenticates: password or key |
--key |
-K |
Private key file (implies --auth key) |
Passing --key is enough to mean key authentication; --auth is only needed to be explicit or to switch back.
turnout credential add # wizardturnout credential add prod-deploy --user deploy # password authturnout credential add pi --user pi --key ~/.ssh/id_ed25519With NAME or --user missing, an interactive wizard asks for each field.
list / show
Section titled “list / show”turnout credential list # one line per credential: name, user, auth kindturnout credential show prod-deployshow prints the user, the auth kind, the key file if there is one, whether a secret is stored, and which servers use it. It never prints the secret - use turnout pass copy for that.
Omit the name on a terminal and turnout offers a picker.
turnout credential edit prod-deploy # interactive wizardturnout credential edit prod-deploy --user deployerturnout credential edit pi --key ~/.ssh/id_ed25519_newturnout credential edit pi --auth password --key "" # back to a password| Flag | Short | Description |
|---|---|---|
--user |
-u |
Remote user |
--auth |
-a |
password or key |
--key |
-K |
Private key file (empty value removes it) |
Key authentication without a key file is refused at edit time rather than at connect time.
remove
Section titled “remove”turnout credential remove prod-deploy [--yes]Removes the credential and its stored secret. Servers that pointed at it are listed before the confirmation and cleared afterwards, so none is left naming something that is gone.
How authentication is attempted
Section titled “How authentication is attempted”For an auth = key credential, the key file is used, with the stored secret - if there is one - as its passphrase. An unprotected key needs no secret at all.
For an auth = password credential, the password stored in the OS keyring is sent to the server.