letthemquibble 1.1.0 → 2.0.0

package/README.md

@@ -10,7 +10,24 @@ This package is the `quibble` CLI. It is published as `letthemquibble` because
 
 ## Install
 
-You need Node 22 or later.
+On macOS or Linux:
+
+```sh
+curl -fsSL https://letthemquibble.com/install.sh | sh
+```
+
+On Windows, in PowerShell:
+
+```powershell
+irm https://letthemquibble.com/install.ps1 | iex
+```
+
+This installs a standalone binary that needs no Node. Run it again to update.
+`QUIBBLE_VERSION` pins a version and `QUIBBLE_INSTALL_DIR` picks the
+directory. On Alpine and other musl systems, run `apk add libstdc++ libgcc`
+first.
+
+With Node 22 or later you can install from npm instead:
 
 ```sh
 npm install -g letthemquibble
@@ -18,45 +35,77 @@ npm install -g letthemquibble
 
 ## Quick start
 
-With no endpoint configured, Quibble runs in local mode and appends complaints
-to `~/.quibble/complaints.jsonl`. No server or account is needed.
+Quibble talks to the hosted service at `https://api.letthemquibble.com` unless
+you name another endpoint. Create an account and an organization at
+<https://letthemquibble.com>, and have an admin create the project there.
+Then, in the repository:
 
 ```sh
 cd ~/code/myproject
-quibble init -t build -t tests -t docs
+quibble login
+quibble init --org acme
+quibble snippet --append CLAUDE.md --hook
 quibble complain "the build takes 4 minutes" -s high -t build
 quibble list
 quibble summary
 ```
 
-`quibble init` writes a `.quibblerc` and prints a short section for you to
-paste into your `CLAUDE.md` or `AGENTS.md`. It tells the agent when to
-complain and how, for example:
+`quibble login` opens the browser, where you check the code and approve the
+login. It needs no terminal, so a coding agent can start it too. Over SSH or
+in WSL, open the printed URL on any device where you are signed in, or pass
+`--no-browser` to print it alone. `quibble login --password` asks for the
+email, the password and, when two-factor sign-in is on, a code in the
+terminal instead.
+
+`quibble init` writes a `.quibblerc` and prints a short section for your
+`CLAUDE.md` or `AGENTS.md`. It tells the agent when to complain and how, for
+example:
 
 ```
 quibble complain "what went wrong, and what you expected" -s medium -t build --agent claude
 ```
 
-`quibble snippet --append CLAUDE.md` appends the same section to a file
+`quibble snippet --append CLAUDE.md` appends that section to a file
 (`AGENTS.md` names the agent `codex`), `quibble snippet --skill` writes it as a
 Claude Code skill, and `--agent <name>` names any other agent.
 
+When the allowed tags change, `quibble sync` rewrites that section in place
+in `CLAUDE.md`, `AGENTS.md` and the skill file, and leaves the rest of each
+file alone. `--hook` on `init`, `snippet` or `sync` adds a Claude Code
+`SessionStart` hook that runs `quibble sync --quiet` at the start of every
+new session, so the list stays current by itself.
+
 Complaints that share a headline fold into one row of `quibble list`.
 `quibble show <id>` prints one in full, and any unique prefix of at least 6
-characters stands for an id.
+characters stands for an id. Project names ignore case: `DBT` and `dbt` are
+the same project.
 
-## Remote mode
+## Local mode
 
-To share complaints with a team, point the CLI at a hosted API. Create an
-account in its web app first, then:
+Local mode keeps complaints on your machine, in
+`~/.quibble/complaints.jsonl`, with no server and no account. It is opt-in:
+pass `--local`, or set the endpoint to `local`.
 
 ```sh
-quibble init --org acme --endpoint https://api.example.com -t build
-quibble login
+quibble init --endpoint local -t build -t tests -t docs
+quibble complain "the build takes 4 minutes" -s high -t build
 ```
 
+`--endpoint local` writes `"endpoint": "local"` into `.quibblerc`, so every
+command in the project stays local. Each local filing says on stderr that
+nothing was sent.
+
+## Other servers and CI
+
+`--endpoint`, `QUIBBLE_ENDPOINT`, `.quibblerc` and `~/.quibble/config.json`
+take the API URL, the web URL or a bare host, such as
+`staging.example.com`. `quibble login --endpoint <url>` saves the endpoint
+in `~/.quibble/config.json` when that file names none yet, so you pass it
+once.
+
 For CI, a maintainer runs `quibble token create ci`, and the job sets the two
 lines it prints, `QUIBBLE_ENDPOINT` and `QUIBBLE_TOKEN`, instead of logging in.
+A plain `quibble login` refuses to run when `CI` is set.
 A complaint that cannot reach the API waits in `~/.quibble/unsent.jsonl` and
 goes out with the next remote command, or with `quibble retry`.
 
@@ -64,5 +113,6 @@ Run `quibble --help` for every command.
 
 ## More
 
+- <https://letthemquibble.com/help>: install, update, setup and login
 - <https://github.com/repineap/quibble>
 - <https://letthemquibble.com>