@popcraft/cli 0.0.0-stage → 0.2.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/CHANGELOG.md +16 -0
- package/LICENSE +21 -0
- package/README.md +29 -2
- package/dist/popcraft.mjs +391947 -0
- package/package.json +40 -3
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# @popcraft/cli
|
|
2
|
+
|
|
3
|
+
Released together with the other @popcraft packages, at one version, from Conventional Commits: each release's notes are
|
|
4
|
+
on [GitHub Releases](https://github.com/getpopcraft/popcraft-app/releases), written from its commits. A breaking change (a
|
|
5
|
+
new major) also gets an entry here, saying what breaks and how to move.
|
|
6
|
+
|
|
7
|
+
## 0.1.0
|
|
8
|
+
|
|
9
|
+
- `popcraft new` and `popcraft run`: every PopCraft command on a `.popcraft` file, by id, agent tool name or plugin
|
|
10
|
+
method, with flags from its parameters; `--batch` for many in one go; saved only when a command edits the document.
|
|
11
|
+
- Designs in code: `write_design` builds a design from a design-kit script here, in a sandbox, with its checks;
|
|
12
|
+
`--look` renders the review (every size, chosen moments, a light and a dark brand kit) through the app. `run_script`
|
|
13
|
+
runs JavaScript over the document as one undo step. The kit is `@popcraft/kit`.
|
|
14
|
+
- Exports and `vision.lookAt` in a headless editor (puppeteer, optional); `--parts` looks at a tall page part by part.
|
|
15
|
+
- Cloud files (`cloud:<key>`, `push`, `pull`), the REST API (`popcraft api`, `login`), marketplace publishing
|
|
16
|
+
(`publish`) and the desktop app (`open`, `run --ui`, `tabs`), and its local plugins, themes, fonts, skills and agents.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 PopCraft
|
|
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,3 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @popcraft/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `popcraft` command line: [PopCraft](https://popcraft.app) from a terminal, a CI job or an AI agent. It runs the
|
|
4
|
+
same commands the editor, its agent and plugins run, on `.popcraft` files, cloud files and the desktop app.
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
npm i -g @popcraft/cli # Node 25 or newer
|
|
8
|
+
npm i -g puppeteer # optional: renders and exports
|
|
9
|
+
popcraft new poster.popcraft --name Poster
|
|
10
|
+
popcraft run poster.popcraft write_design --size ig-post --script @poster.js
|
|
11
|
+
popcraft run poster.popcraft export.nodes --format PNG --out poster.png
|
|
12
|
+
popcraft --help
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Designs written as scripts use the design kit, [`@popcraft/kit`](https://www.npmjs.com/package/@popcraft/kit), which
|
|
16
|
+
this package depends on; install it in your project too for types while you write them.
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
In [getpopcraft/examples](https://github.com/getpopcraft/examples): [a launch in three sizes from one script](https://github.com/getpopcraft/examples/tree/main/cli/build-a-design),
|
|
21
|
+
[translated copies of a design](https://github.com/getpopcraft/examples/tree/main/cli/translate).
|
|
22
|
+
|
|
23
|
+
## Documentation
|
|
24
|
+
|
|
25
|
+
- [Command line](https://popcraft.app/docs/api/cli): every subcommand and flag.
|
|
26
|
+
- [Designing with an AI agent](https://popcraft.app/docs/api/agents) and the
|
|
27
|
+
[design reference](https://popcraft.app/docs/api/design-reference).
|
|
28
|
+
- [Packages](https://popcraft.app/docs/api/packages): what each PopCraft package is for.
|
|
29
|
+
|
|
30
|
+
Release notes: [CHANGELOG.md](CHANGELOG.md).
|