@plenary/cli 0.3.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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Patrick DeLoughry
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,33 @@
1
+ # @plenary/cli
2
+
3
+ The `plenary` command: a client for the Plenary API from a shell, a script,
4
+ or CI. Sync model and form YAML with an instance, manage entries and media,
5
+ and call any endpoint.
6
+
7
+ ```sh
8
+ npm install --save-dev @plenary/cli
9
+ npx plenary init # writes plenary.json (no secrets)
10
+ export PLENARY_API_KEY=pln_prv_…
11
+ npx plenary status
12
+ ```
13
+
14
+ ```sh
15
+ plenary metadata pull # instance → models/ and forms/
16
+ plenary metadata diff # what push would change
17
+ plenary metadata push # apply (never deletes)
18
+
19
+ plenary entries list post --where status=published --limit 20
20
+ plenary entries create post --data '{"title":"Hello"}' --slug hello --publish
21
+ plenary entries export post > posts.ndjson
22
+
23
+ plenary media upload hero.jpg
24
+ plenary forms entries export contact > contact.ndjson
25
+ plenary api GET models
26
+ ```
27
+
28
+ Configuration comes from flags, `PLENARY_*` variables, a `.env`, then
29
+ `plenary.json`. The credential is an API key; what the CLI may do is that
30
+ key's grants. `--json` on any command prints the API's JSON; exit 1 is an
31
+ API error, 2 a usage error.
32
+
33
+ Full reference: `docs/CLI.md` in the Plenary repository.