letthemquibble 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +40 -15
  3. package/dist/quibble.js +2247 -454
  4. package/package.json +2 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Andrew Repine
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,41 +1,66 @@
1
1
  # letthemquibble
2
2
 
3
- Quibble lets coding agents file complaints about the project they work in. An
4
- agent that loses time to a slow build, a broken script or a confusing document
5
- runs one command instead of working around the problem in silence. Maintainers
6
- read the aggregate and turn it into improvements.
3
+ Quibble lets coding agents file complaints about the project they work in. When
4
+ an agent loses time to a slow build, a flaky test or a confusing document, it
5
+ runs one command instead of quietly working around the problem. Maintainers
6
+ read the complaints in aggregate and fix what hurts most.
7
7
 
8
- The npm name is `letthemquibble`, because `quibble` is taken.
8
+ This package is the `quibble` CLI. It is published as `letthemquibble` because
9
+ `quibble` is taken on npm.
9
10
 
10
11
  ## Install
11
12
 
12
- Node 22 or later is required.
13
+ You need Node 22 or later.
13
14
 
14
15
  ```sh
15
16
  npm install -g letthemquibble
16
17
  ```
17
18
 
18
- ## File a complaint
19
+ ## Quick start
20
+
21
+ With no endpoint configured, Quibble runs in local mode and appends complaints
22
+ to `~/.quibble/complaints.jsonl`. No server or account is needed.
19
23
 
20
24
  ```sh
25
+ cd ~/code/myproject
26
+ quibble init -t build -t tests -t docs
21
27
  quibble complain "the build takes 4 minutes" -s high -t build
22
28
  quibble list
23
29
  quibble summary
24
30
  ```
25
31
 
26
- Local mode needs no server and no account. It appends one JSON line per
27
- complaint to `$QUIBBLE_HOME/complaints.jsonl`, which defaults to
28
- `~/.quibble/complaints.jsonl`.
32
+ `quibble init` writes a `.quibblerc` and prints a short section for you to
33
+ paste into your `CLAUDE.md` or `AGENTS.md`. It tells the agent when to
34
+ complain and how, for example:
35
+
36
+ ```
37
+ quibble complain "what went wrong, and what you expected" -s medium -t build --agent claude
38
+ ```
39
+
40
+ `quibble snippet --append CLAUDE.md` appends the same section to a file
41
+ (`AGENTS.md` names the agent `codex`), `quibble snippet --skill` writes it as a
42
+ Claude Code skill, and `--agent <name>` names any other agent.
43
+
44
+ Complaints that share a headline fold into one row of `quibble list`.
45
+ `quibble show <id>` prints one in full, and any unique prefix of at least 6
46
+ characters stands for an id.
29
47
 
30
- ## Set a project up
48
+ ## Remote mode
49
+
50
+ To share complaints with a team, point the CLI at a hosted API. Create an
51
+ account in its web app first, then:
31
52
 
32
53
  ```sh
33
- quibble init --project demo --org acme --endpoint https://api.example.com -t build
54
+ quibble init --org acme --endpoint https://api.example.com -t build
55
+ quibble login
34
56
  ```
35
57
 
36
- `init` writes a `.quibblerc` and prints a paragraph to paste into a `CLAUDE.md`
37
- or an `AGENTS.md`, so an agent knows the command and the allowed tags. With an
38
- endpoint, run `quibble login` once.
58
+ For CI, a maintainer runs `quibble token create ci`, and the job sets the two
59
+ lines it prints, `QUIBBLE_ENDPOINT` and `QUIBBLE_TOKEN`, instead of logging in.
60
+ A complaint that cannot reach the API waits in `~/.quibble/unsent.jsonl` and
61
+ goes out with the next remote command, or with `quibble retry`.
62
+
63
+ Run `quibble --help` for every command.
39
64
 
40
65
  ## More
41
66