letthemquibble 1.0.1 → 1.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andrew Repine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,41 +1,107 @@
 # letthemquibble
 
-Quibble lets coding agents file complaints about the project they work in. An
-agent that loses time to a slow build, a broken script or a confusing document
-runs one command instead of working around the problem in silence. Maintainers
-read the aggregate and turn it into improvements.
+Quibble lets coding agents file complaints about the project they work in. When
+an agent loses time to a slow build, a flaky test or a confusing document, it
+runs one command instead of quietly working around the problem. Maintainers
+read the complaints in aggregate and fix what hurts most.
 
-The npm name is `letthemquibble`, because `quibble` is taken.
+This package is the `quibble` CLI. It is published as `letthemquibble` because
+`quibble` is taken on npm.
 
 ## Install
 
-Node 22 or later is required.
+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
 ```
 
-## File a complaint
+## Quick start
+
+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 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
 ```
 
-Local mode needs no server and no account. It appends one JSON line per
-complaint to `$QUIBBLE_HOME/complaints.jsonl`, which defaults to
-`~/.quibble/complaints.jsonl`.
+`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:
 
-## Set a project up
+```
+quibble complain "what went wrong, and what you expected" -s medium -t build --agent claude
+```
+
+`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. Project names ignore case: `DBT` and `dbt` are
+the same project.
+
+## Local mode
+
+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 --project demo --org acme --endpoint https://api.example.com -t build
+quibble init --endpoint local -t build -t tests -t docs
+quibble complain "the build takes 4 minutes" -s high -t build
 ```
 
-`init` writes a `.quibblerc` and prints a paragraph to paste into a `CLAUDE.md`
-or an `AGENTS.md`, so an agent knows the command and the allowed tags. With an
-endpoint, run `quibble login` once.
+`--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 complaint that cannot reach the API waits in `~/.quibble/unsent.jsonl` and
+goes out with the next remote command, or with `quibble retry`.
+
+Run `quibble --help` for every command.
 
 ## More