Env Commands

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

Approval

lnk env approval add

Say yes, ahead of a run, to giving the environment file a secret it asks for

lnk env approval add <secret> --spec <spec>

It takes secret, position 1, string, required: The secret, by its name or its ID, secret: (lnk secret list). It takes --spec, path, required: The environment file (env.toml) that asks for it. It answers env.approval.

lnk env approval list

The secrets you've said yes to giving environment files

lnk env approval list [--json] [--spec <spec>]

It takes --json, boolean: Print the answer as JSON for other programs. It takes --spec, path: Only this environment file's. It answers env.approvals.

lnk env approval remove

Take back a yes: the environment file's next run isn't given the secret without asking again

lnk env approval remove <secret> --spec <spec>

It takes secret, position 1, string, required: The secret, by its name or its ID, secret: (lnk secret list). It takes --spec, path, required: The environment file (env.toml) that asks for it. It answers secret ID.

lnk env approval show

Whether you've said yes to giving the environment file a secret

lnk env approval show <secret> [--json] --spec <spec>
  • --json, boolean: Print the answer as JSON for other programs
  • secret, position 1, string, required: The secret, by its name or its ID, secret: (lnk secret list)
  • --spec, path, required: The environment file (env.toml) that asks for it

It answers env.found.

Env

lnk env check

Read an environment file, its specs and inputs, and print what it sets up and the hash its image is found by

lnk env check [--json] --spec <spec> [field flags]

It takes --json, boolean: Print the answer as JSON for other programs. It takes --spec, path, required: The environment file (env.toml). It reads the env spec, from a file or its field flags. It answers env.checked.

lnk env create

Make a box as an environment says

lnk env create [--box <box>] --cloud <cloud> [--name <name>] --spec <spec> [--yes] [field flags]
  • --box, path: The box file (box.toml) of the box made [default: the least that works]
  • --cloud, string, required: The cloud account (lnk cloud list)
  • --name, string: The box's name [default: the file's name and a number, app-1]
  • --spec, path, required: The environment file (env.toml)
  • --yes, boolean: Say yes to what it would ask

It reads the env spec, from a file or its field flags. It answers env.made.

lnk env reset

Put a service back as the image had it, with its reset command

lnk env reset <service> [place] [--on <on>] [--spec <file>] [field flags]
  • --on, string: The box (lnk box list) made from the environment
  • place, position 2, string: A cloud account, or here: short for --cloud or --here
  • service, position 1, string, required: The service, as the file names it

It reads the env spec, from a file or its field flags. It answers env.ended.

lnk env setup

Set a box or this machine up as an environment says, saving no image

lnk env setup [place] [--here] [--on <on>] --spec <spec> [--timeout <timeout>] [field flags]
  • --here, boolean: Set this machine up
  • --on, string: A box (lnk box list) to set up
  • place, position 1, string: Here, short for --here
  • --spec, path, required: The environment file (env.toml)
  • --timeout, string, duration: How long it may run, as 30m or 2h; reaching it fails the setup [default: none, only each stage's own]

It reads the env spec, from a file or its field flags. It answers env.ended.

Image

lnk env image create

Build and save an environment's image now

lnk env image create [place] [--cloud <cloud>] [--here] --spec <spec> [--timeout <timeout>] [--yes] [field flags]
  • --cloud, string: The cloud account to build it in (lnk cloud list), on a box made for it
  • --here, boolean: On a box alone (/etc/lnk/kind.toml): the stages run here, for the computer that made it to save
  • place, position 1, string: A cloud account, or here: short for --cloud or --here
  • --spec, path, required: The environment file (env.toml)
  • --timeout, string, duration: How long the build on a box made for it may run, as 30m or 2h; reaching it fails the build [default: none, only each stage's own]
  • --yes, boolean: Say yes to what it would ask

It reads the env spec, from a file or its field flags. It answers env.ended.