@bigcommerce/catalyst 1.0.0-alpha.0 → 1.0.0-alpha.2
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 +33 -1
- package/dist/cli.js +1060 -496
- package/dist/cli.js.map +1 -1
- package/package.json +4 -3
- package/templates/open-next.config.ts +8 -2
- package/templates/public_headers +2 -0
package/README.md
CHANGED
|
@@ -1,3 +1,35 @@
|
|
|
1
1
|
# @bigcommerce/catalyst
|
|
2
2
|
|
|
3
|
-
CLI
|
|
3
|
+
CLI tool for Catalyst development and deployment.
|
|
4
|
+
|
|
5
|
+
## Developing the CLI
|
|
6
|
+
|
|
7
|
+
You'll need two terminal windows:
|
|
8
|
+
|
|
9
|
+
### Terminal 1 — Watch mode (rebuilds on changes)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
cd packages/catalyst
|
|
13
|
+
pnpm dev
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
This runs `tsup --watch` and rebuilds `dist/cli.js` on every source change.
|
|
17
|
+
|
|
18
|
+
### Terminal 2 — Run the CLI
|
|
19
|
+
|
|
20
|
+
From the `core/` directory, run the CLI using the absolute path to the built executable:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
cd core
|
|
24
|
+
pnpm exec <repo-root>/packages/catalyst/dist/cli.js <command>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For example:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm exec <repo-root>/packages/catalyst/dist/cli.js project list
|
|
31
|
+
pnpm exec <repo-root>/packages/catalyst/dist/cli.js logs tail
|
|
32
|
+
pnpm exec <repo-root>/packages/catalyst/dist/cli.js deploy
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Replace `<repo-root>` with the absolute path to your local clone of the `catalyst` repository.
|