@pixelvibing/cli 0.0.1 → 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/README.md CHANGED
@@ -1,8 +1,35 @@
1
1
  # @pixelvibing/cli
2
2
 
3
- The command line for [PixelVibing](https://pixelvibing.com): generate pixel art
4
- sprites, tilesets and animations for games, and set up coding assistants to do the
5
- same.
3
+ The command line for [PixelVibing](https://pixelvibing.com): pixel art for your game,
4
+ generated on the platform and pulled into your repository, and the Skills that teach
5
+ Claude Code and Codex to do the same.
6
6
 
7
- **In development.** This version holds the package name and carries no executable code
8
- yet. The `pixel-vibing-cli` command arrives in a later release.
7
+ ```bash
8
+ npm install -g @pixelvibing/cli
9
+ cd my-game
10
+ pixel-vibing-cli setup
11
+ ```
12
+
13
+ `setup` signs you in in the browser, makes the directory a local project, which means a
14
+ `pixelvibing.json` and a `pixelvibing/` folder, links it to one of your platform
15
+ projects, and installs the Skills into `.claude/skills/` or `.codex/skills/`. It also
16
+ configures the remote MCP server in `.mcp.json` or `.codex/config.toml`, by a command
17
+ that prints the token's header when the harness connects, so the token is in no file.
18
+ Each step it finds done already is skipped.
19
+
20
+ | Command | What it does |
21
+ |---|---|
22
+ | `login`, `logout`, `whoami` | Keep an account token for this machine in the system's credential store, or remove it |
23
+ | `init`, `link` | Make a directory a local project, and name the platform project it generates for |
24
+ | `generate object\|creature\|level-design` | Make art on the platform, after saying its cost in credits, then pull it |
25
+ | `list`, `pull` | List the project's assets by kind, and pull one by id or name into `pixelvibing/out/` |
26
+ | `guide pull\|push\|revise\|show\|versions` | Read and write the project's style guide |
27
+ | `seal` | Seal `pixelvibing/out/` into `pixelvibing/build/assets.eac` |
28
+ | `export default\|pixi\|phaser\|godot` | Pack the art into sprite sheets and the map into placed sprites, for an engine |
29
+ | `update` | Replace the installed Skills with the ones this version ships, and bring the MCP server's entry to it |
30
+ | `mcp headers` | Print the header a harness sends the remote MCP server, from the kept token |
31
+ | `editor` | Open the PixelVibing desktop app on the project |
32
+
33
+ Every command takes `--help`, and `--json` for an answer a script reads. On a machine with
34
+ no credential store, such as a CI job, set `PIXELVIBING_TOKEN` to a token made in the
35
+ dashboard.