diff --git a/README.md b/README.md index 869aa7e..2f2cfe0 100644 --- a/README.md +++ b/README.md @@ -165,11 +165,18 @@ cosigner-cli logs -f | `backup` | Encrypted backup of the instance (must be stopped) | | `restore` | Restore a backup into an empty directory | | `export` | Write `.mshare` files for Fystack Recovery (must be stopped) | -| `update` | Verify and install a newer release | -| `version` | Print CLI and runtime versions | +| `update` | Update the **runtime** (container image) to a newer signed release | +| `self-update` | Update **cosigner-cli** itself to a newer signed release | +| `version` | Print CLI and runtime versions (`--check` looks up the newest) | +| `help environment` | List every environment variable the CLI reads | Global flags: `--home DIR` (or `COSIGNER_HOME`), `--docker CMD`. +For scripts and agents: `version`, `doctor`, `update` and `self-update` take `--json` (the +document goes to stdout, progress to stderr). `update --check` and `self-update --check` exit +with status `10` when a newer release exists. Commands never prompt without a terminal: they +fail, and a `hint:` line names the flag or variable to set (for example `--yes`). + ## Approval callback `callback add` connects a paired cosigner to your approval callback. It generates the cosigner's @@ -236,7 +243,7 @@ COSIGNER_PASSWORD_FD=3 cosigner-cli start 3< /run/secrets/cosigner-pw | Variable | Used by | | ------------------------------- | ----------------- | | `COSIGNER_PASSWORD_FD` | storage password | -| `COSIGNER_RECOVERY_PASSWORD_FD` | `backup`/`restore` | +| `COSIGNER_RECOVERY_PASSWORD_FD` | `backup`/`restore`/`update` | `COSIGNER_PASSWORD` / `COSIGNER_RECOVERY_PASSWORD` also work but leak into the environment. Avoid them. @@ -244,16 +251,19 @@ COSIGNER_PASSWORD_FD=3 cosigner-cli start 3< /run/secrets/cosigner-pw ```bash cosigner-cli stop -cosigner-cli backup --out /secure/backups/cosigner.enc +cosigner-cli backup # -> ./backups/backup--