@plinth-music/cli 0.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 +55 -0
  3. package/dist/cli.js +87000 -0
  4. package/package.json +48 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Plinth Music Ltd
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 ADDED
@@ -0,0 +1,55 @@
1
+ # plinth-cli
2
+
3
+ Plinth capstone sync daemon and CLI. Mirrors your Plinth workspace to `~/Plinth/<workspace>/` and keeps it bidirectionally synced. AI-native: pair with Claude Code or any LLM agent for context-aware artist management.
4
+
5
+ **Status: early access. `login` and `sync` (pull-only, documents) are implemented; the watcher and other entity types land in subsequent PRs. See V1_SPEC §5 M3 in the plinth monorepo for the full milestone plan.**
6
+
7
+ ## Commands
8
+
9
+ Implemented today:
10
+
11
+ - `plinth login --workspace <slug>` — issue a PAT in the browser, paste it back, store in the OS keychain (macOS Keychain / Linux Secret Service / Windows Credential Manager).
12
+ - `plinth sync [--workspace <slug>]` — one-shot pull of documents into `~/Plinth/<workspace>/`. Defaults to the active workspace if `--workspace` is omitted.
13
+
14
+ Planned (not yet implemented):
15
+
16
+ - `plinth start` — run the sync daemon (file watcher + cloud subscription).
17
+ - `plinth status` — print last-synced-at per entity type and pending changes.
18
+ - `plinth refresh-context` — regenerate `CLAUDE.md` from the current Plinth schema + workspace.
19
+ - `plinth export workspace` — generate an export bundle.
20
+ - `plinth update` — detect install method (brew vs npm-global) and upgrade in place.
21
+ - `plinth logout --workspace <slug>` — revoke local PAT reference, retain mirror files.
22
+
23
+ ## Install (once published)
24
+
25
+ Neither path is published yet.
26
+
27
+ ```sh
28
+ # npm (cross-platform)
29
+ npm i -g @plinth-music/cli
30
+
31
+ # Homebrew (macOS, signed + notarised)
32
+ brew install plinth-music/tap/plinth-cli
33
+ ```
34
+
35
+ ## Develop
36
+
37
+ Requires [Bun](https://bun.sh/) (latest).
38
+
39
+ ```sh
40
+ bun install
41
+ bun run build # produces dist/cli.js
42
+ bun test # builds, then runs the smoke test
43
+ bun run typecheck # strict tsc, no emit
44
+ ```
45
+
46
+ The built CLI is a standard Node-compatible ESM bundle with a `#!/usr/bin/env node` shebang. Run it directly:
47
+
48
+ ```sh
49
+ ./dist/cli.js --version
50
+ ./dist/cli.js --help
51
+ ```
52
+
53
+ ## License
54
+
55
+ MIT — see `LICENSE`.