Secret Commands

Every command the secret module offers, from its declarations, in order of the resource each acts on. Each command's help says the same.

Keeper

lnk secret keeper create

Keep your secrets under a user of their own (lnk-secrets), which no program of yours runs as: made once, with sudo

lnk secret keeper create [--yes]

It takes --yes, boolean: Say yes to what it would ask. It answers secret.ended.

Secret

lnk secret add

Give a secret kept (lnk secret create) to a workload here, such as an agent (--to agent:main), once for each flag: the grant names the service it acts as

lnk secret add <name> --to <to>

It takes name, position 1, string, required: The secret's name, or its ID, secret: (lnk secret list). It takes --to, list of string, required: A workload here it is given to, : (agent

), once for each. It answers secret.granted.

lnk secret create

Keep a secret: its value asked without echo, or read from its input's first line, given to no one yet (lnk secret add)

lnk secret create <name> [--basic-user <basic-user>] [--format <format>] [--header <header>] [--internet-host <internet-host>] [--json] [--yes]
  • --basic-user, string: The user name of HTTP Basic's credentials, with the secret as its password: the base64 of :, as git over HTTPS takes a token (x-access-token for GitHub)
  • --format, string: The header's value, {} where the secret goes [default: Bearer {} for Authorization, Basic {} with --basic-user, {} for any other]
  • --header, string: The header it goes in: Authorization, or one named for an API key (X-Api-Key) [default: Authorization]
  • --internet-host, string: The one host the proxy adds it to requests for (api.stripe.com); left out, it's kept plain, for what a module keeps alone
  • --json, boolean: Print the answer as JSON for other programs
  • name, position 1, string, required: The secret's name, a variable's (NPM_TOKEN)
  • --yes, boolean: Say yes to what it would ask

It answers secret.kept.

lnk secret delete

Delete a secret, by its name or its ID (secret:), from this machine, its value and its grants, and from each box a move gave a copy to; its ID is never given again

lnk secret delete [name] [--here] [--json]
  • --here, boolean: From this machine alone, and nothing to remove isn't an error: what remove runs on each box
  • --json, boolean: Print the answer as JSON for other programs
  • name, position 1, string: The secret's name, or its ID (secret:)

It answers secret.deleted.

lnk secret list

List every secret and credential kept here: each secret's name, how it's given and where it's granted, and where each credential a module holds is kept and what it may do, never a value

lnk secret list [--json] [--to <to>]

It takes --json, boolean: Print the answer as JSON for other programs. It takes --to, string: Only the secrets given to this workload, : (agent

). It answers secret.listed.

lnk secret remove

Stop giving a secret to a workload: it stays kept, and given to the rest

lnk secret remove <name> --to <to>

It takes name, position 1, string, required: The secret's name, or its ID, secret: (lnk secret list). It takes --to, list of string, required: A workload here it is no longer given to, : (agent

), once for each. It answers secret.granted.

lnk secret show

Show how one secret is given and where it is granted, never its value

lnk secret show <name> [--json]

It takes --json, boolean: Print the answer as JSON for other programs. It takes name, position 1, string, required: The secret's name, or its ID, secret: (lnk secret list). It answers secret.secret.