@fluid-app/fluid-cli 0.1.64 → 0.1.65

package/README.md

@@ -25,6 +25,48 @@ fluid logout            # Remove stored authentication
 
 Profiles are stored at `~/.fluid/config.json`.
 
+`--shop <shop>` signs in to one company (`acme` or `acme.fluid.app`). For an
+admin, finishing the sign-in with a code sent for that shop also confirms a
+new company's signup.
+
+### Without a terminal
+
+`fluid login` asks for the email and code at a prompt, so a script or agent
+with no terminal signs in in two steps instead:
+
+```bash
+# 1. Email a code for one company and save the sign-in (prints how to finish)
+fluid login --send-code --email maya@acme.test --shop acme
+
+# 2. Finish with the emailed code from FLUID_LOGIN_CODE
+FLUID_LOGIN_CODE=123456 fluid login --code --email maya@acme.test --yes
+
+#    or read it from stdin with --code -
+echo 123456 | fluid login --code - --email maya@acme.test --yes
+```
+
+Step 1 needs `--shop`: the code is tied to that company, and only such a
+code confirms a new signup (the signup response names the shop as
+`fluid_shop`). Step 2 signs in to the same company; a `--shop` given there
+must match it.
+
+The code expires after 30 minutes, and five wrong codes lock it. Step 1
+saves the server's id for the sign-in under
+`~/.fluid/pending-logins/` until step 2 finishes it; the id alone cannot
+sign in. A code given as `--code 123456` works but is visible in shell
+history.
+
+Without a terminal (and with `--code -`, which takes stdin), step 2 needs
+`--yes`, which replaces a profile named after the company, or `--name
+<profile>`, which is refused before the code is spent if that profile
+exists. Either way the code is never used up on a profile it cannot write.
+`--json` prints one JSON object (`status` is `code_sent`, `signed_in` or
+`error`, with a `code` on errors).
+
+With no terminal, `fluid login` fails at once rather than waiting at a
+prompt, unless it has a token (`--token` or `FLUID_TOKEN`) or runs one of
+the two steps (`--send-code`, `--code`).
+
 ## Plugins
 
 Install plugins alongside the core CLI to add commands:
@@ -102,6 +144,7 @@ to turn it off.
 | Variable                | Description                                      |
 | ----------------------- | ------------------------------------------------ |
 | `FLUID_TOKEN`           | API token (alternative to `fluid login`)         |
+| `FLUID_LOGIN_CODE`      | Emailed code read by `fluid login --code`        |
 | `FLUID_API_BASE`        | API base URL (default: `https://api.fluid.app`)  |
 | `FLUID_CONFIG_DIR`      | Override config directory (default: `~/.fluid/`) |
 | `FLUID_NO_UPDATE_CHECK` | Turn off the daily update notice                 |