@parity-app/cli 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andrew Craswell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,65 @@
-# Temporary Holding Version
+# @parity-app/cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The `parity` command drives the [Parity](https://github.com/betterapps-hq/parity) desktop app from a terminal or an
+agent. Parity is a design canvas that draws a project's real components, styled with its own tokens. The CLI reads the
+open project's designs, components and tokens, runs edits as one undoable step, takes screenshots, checks accessibility,
+and serves all of this as MCP tools.
+
+> **Pre-release.** Versions before 1.0 may change their commands and output between releases.
+
+## Install
+
+It needs Node 24. Run it without installing:
+
+```sh
+npx @parity-app/cli --help
+```
+
+or install it to get the `parity` command:
+
+```sh
+npm install --global @parity-app/cli
+```
+
+Most commands act on a running Parity app, on its active tab unless `--tab` names another. `parity lib` runs without the
+app.
+
+## Commands
+
+| Command                      | What it does                                                                               |
+| ---------------------------- | ------------------------------------------------------------------------------------------ |
+| `parity tabs`                | Lists the open projects.                                                                   |
+| `parity state`               | A tab's designs, selection, modes, components and tokens. Start here.                      |
+| `parity exec [file]`         | Runs a JavaScript snippet against the designs, from a file or stdin, as one undoable step. |
+| `parity screenshot <design>` | Renders a design in its states and modes, offscreen, as images.                            |
+| `parity problems <design>`   | Render errors, overflow, clipping and unknown components, per frame.                       |
+| `parity a11y <design>`       | Checks accessibility with axe-core, per frame.                                             |
+| `parity console`             | What the project's own code wrote to the console.                                          |
+| `parity tokens`              | The tokens styles can name, with their values per theme.                                   |
+| `parity components`          | The components designs can use, by library.                                                |
+| `parity props <Component>`   | A component's props, read from its source.                                                 |
+| `parity lib [package]`       | Writes a `.lib.par` describing a library's components, tokens and icons, or the app's.     |
+| `parity open <folder>`       | Opens a project in a new tab.                                                              |
+| `parity skill [file]`        | Prints the skill that teaches an agent to design with Parity.                              |
+| `parity mcp`                 | Serves these commands as MCP tools on stdio.                                               |
+
+`parity --help` lists every option. `problems` and `a11y` exit with 1 when they find something, so they can gate a
+script.
+
+## With an agent
+
+Add the MCP server to your agent's configuration:
+
+```json
+{
+  "mcpServers": {
+    "parity": { "command": "npx", "args": ["-y", "@parity-app/cli", "mcp"] }
+  }
+}
+```
+
+Then have the agent read the skill first, with the `read_skill` tool or `parity skill`.
+
+## Licence
+
+MIT. See [LICENSE](https://github.com/betterapps-hq/parity/blob/main/LICENSE).