@polyhedral/cli 0.1.0-beta.2 → 0.1.0-beta.3
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 +28 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,18 +29,43 @@ polyhedral dev
|
|
|
29
29
|
| Command | Description |
|
|
30
30
|
| --------------------- | ------------------------------------------------ |
|
|
31
31
|
| `polyhedral login` | Authenticate with your API key |
|
|
32
|
+
| `polyhedral logout` | Remove stored credentials |
|
|
33
|
+
| `polyhedral whoami` | Show current login status |
|
|
32
34
|
| `polyhedral init` | Scaffold a new template project |
|
|
33
35
|
| `polyhedral dev` | Watch file, auto-push on save, open live preview |
|
|
34
|
-
| `polyhedral push` | Validate and
|
|
36
|
+
| `polyhedral push` | Validate, upload, and publish a new version |
|
|
35
37
|
| `polyhedral pull` | Download a template to a local file |
|
|
38
|
+
| `polyhedral delete` | Delete a template |
|
|
36
39
|
| `polyhedral list` | List all your custom sheet templates |
|
|
37
|
-
| `polyhedral
|
|
40
|
+
| `polyhedral versions` | List version history for a template |
|
|
41
|
+
| `polyhedral validate` | Check a template file for syntax errors (offline)|
|
|
42
|
+
|
|
43
|
+
### Push Options
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
polyhedral push # Patch bump (default)
|
|
47
|
+
polyhedral push --minor # Minor version bump
|
|
48
|
+
polyhedral push --major --changelog "breaking changes description"
|
|
49
|
+
polyhedral push -f # Skip confirmation prompt
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Global Options
|
|
53
|
+
|
|
54
|
+
| Flag | Description |
|
|
55
|
+
| ---------- | ----------------------------------------------------- |
|
|
56
|
+
| `--json` | Output structured JSON (skips prompts, useful for CI) |
|
|
57
|
+
| `--version`| Show CLI version |
|
|
58
|
+
| `--help` | Show help |
|
|
59
|
+
|
|
60
|
+
Commands that modify data (`push`, `pull`, `delete`) prompt for confirmation. Use `--force` / `-f` to skip, or `--json` which implies `--force`.
|
|
38
61
|
|
|
39
62
|
## How It Works
|
|
40
63
|
|
|
41
64
|
Templates are JSX files using the Polyhedral SDK component library. The CLI wraps the [REST API](https://polyhedral.co/developers/api) to manage templates from the terminal.
|
|
42
65
|
|
|
43
|
-
The `dev` command is the main workflow: it pushes your template, opens the preview page, and watches for file changes. When you save, it validates and pushes automatically. The preview page uses realtime subscriptions, so it updates without a manual refresh.
|
|
66
|
+
The `dev` command is the main workflow: it pushes your template, opens the preview page, and watches for file changes (including `polyhedral.json`). When you save, it validates locally and pushes automatically. The preview page uses realtime subscriptions, so it updates without a manual refresh.
|
|
67
|
+
|
|
68
|
+
Validation runs offline using Babel — no network connection or login required.
|
|
44
69
|
|
|
45
70
|
## Docs
|
|
46
71
|
|