biblioplex 0.2.0 → 0.2.1
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.
- package/README.md +66 -0
- package/package.json +1 -7
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# biblioplex
|
|
2
|
+
|
|
3
|
+
Manage your [Biblioplex](https://biblioplex.bensonperry.com) Magic: The Gathering
|
|
4
|
+
collection from the terminal — search, edit, import/export, and recover, with
|
|
5
|
+
first-class machine-readable output for scripts and agents.
|
|
6
|
+
|
|
7
|
+
## install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g biblioplex
|
|
11
|
+
# or
|
|
12
|
+
brew install benson/tap/biblioplex
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Installs two commands: `biblioplex` and the short alias `bp`. Requires Node.js ≥ 22.
|
|
16
|
+
|
|
17
|
+
## quick start
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
bp login # sign in via your browser (read-only by default)
|
|
21
|
+
bp summary # overview: unique/total counts, value, containers
|
|
22
|
+
bp search "finish=foil order by price desc" --limit 10
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## auth
|
|
26
|
+
|
|
27
|
+
- **interactive** (people): `bp login` opens your browser (OAuth 2.0 + PKCE). Add
|
|
28
|
+
`--write` to allow changes; `bp logout` clears local credentials.
|
|
29
|
+
- **headless / CI** (no browser): set `BIBLIOPLEX_TOKEN` to a personal access token
|
|
30
|
+
created in the Biblioplex web app (account menu → access tokens).
|
|
31
|
+
|
|
32
|
+
## commands
|
|
33
|
+
|
|
34
|
+
| | |
|
|
35
|
+
| --------------------------- | ------------------------------------------------------------------- |
|
|
36
|
+
| **read** | `summary` `search` `ls` `deck` `value` `prices` `history` `resolve` |
|
|
37
|
+
| **write** (needs `--write`) | `add` `rm` `move` `edit` `import` `export` |
|
|
38
|
+
| **recover** | `undo` `recover` |
|
|
39
|
+
| **auth** | `login` `logout` `whoami` |
|
|
40
|
+
|
|
41
|
+
Run `bp help` or `bp <command> --help` for usage.
|
|
42
|
+
|
|
43
|
+
### writes are previewed
|
|
44
|
+
|
|
45
|
+
Every change shows a dry-run preview and asks for confirmation. Pass `--yes` to
|
|
46
|
+
skip the prompt or `--dry-run` to preview without applying. Changes apply
|
|
47
|
+
server-side with automatic recovery points, so `bp undo` and `bp recover` can roll
|
|
48
|
+
them back.
|
|
49
|
+
|
|
50
|
+
## for scripts & agents
|
|
51
|
+
|
|
52
|
+
- `--json` on any command emits a stable envelope: `{ "ok": true, "data": … }` or
|
|
53
|
+
`{ "ok": false, "error": … }`.
|
|
54
|
+
- meaningful exit codes: `0` ok · `2` usage · `3` auth/scope · `4` not found ·
|
|
55
|
+
`5` conflict · `75` rate-limited / retryable.
|
|
56
|
+
- override the API origin with `BIBLIOPLEX_API_ORIGIN` (e.g. a local dev worker).
|
|
57
|
+
|
|
58
|
+
## notes
|
|
59
|
+
|
|
60
|
+
- cloud-first: the CLI operates on your live Biblioplex collection (the web app is
|
|
61
|
+
the source of truth).
|
|
62
|
+
- zero runtime dependencies.
|
|
63
|
+
|
|
64
|
+
## license
|
|
65
|
+
|
|
66
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "biblioplex",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Manage your Biblioplex Magic: The Gathering collection from the terminal.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"mtg",
|
|
@@ -13,12 +13,6 @@
|
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"author": "Benson Perry",
|
|
15
15
|
"homepage": "https://biblioplex.bensonperry.com",
|
|
16
|
-
"repository": {
|
|
17
|
-
"type": "git",
|
|
18
|
-
"url": "git+https://github.com/benson/biblioplex.git",
|
|
19
|
-
"directory": "apps/cli"
|
|
20
|
-
},
|
|
21
|
-
"bugs": "https://github.com/benson/biblioplex/issues",
|
|
22
16
|
"type": "module",
|
|
23
17
|
"engines": {
|
|
24
18
|
"node": ">=22"
|