sdx-cli 0.2.1 → 0.2.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 +31 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
</p>
|
|
18
18
|
|
|
19
19
|
<p align="center">
|
|
20
|
+
<a href="#install-from-npm">Install from npm</a> •
|
|
20
21
|
<a href="#one-command-setup">One-Command Setup</a> •
|
|
21
22
|
<a href="#daily-workflow">Daily Workflow</a> •
|
|
22
23
|
<a href="#for-codex-agents">For Codex Agents</a> •
|
|
@@ -36,6 +37,28 @@ You use it to:
|
|
|
36
37
|
|
|
37
38
|
v1 remains manual-triggered. SDX can open draft notice PRs when you run publish commands, but it does not autonomously mutate runtime infrastructure.
|
|
38
39
|
|
|
40
|
+
## Install from npm
|
|
41
|
+
Prerequisite: Node.js `20+`.
|
|
42
|
+
|
|
43
|
+
Choose one install mode:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# A) No install, run directly (recommended for first run)
|
|
47
|
+
npx --yes sdx-cli@latest --help
|
|
48
|
+
|
|
49
|
+
# B) Global install
|
|
50
|
+
npm install -g sdx-cli
|
|
51
|
+
sdx --help
|
|
52
|
+
|
|
53
|
+
# C) Project-pinned install (recommended for teams)
|
|
54
|
+
npm install --save-dev sdx-cli
|
|
55
|
+
npx sdx --help
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Team recommendation:
|
|
59
|
+
- use `bootstrap quick` once per org workspace,
|
|
60
|
+
- then run `./scripts/sdx ...` so the workspace stays pinned to one CLI version.
|
|
61
|
+
|
|
39
62
|
## One-Command Setup
|
|
40
63
|
### Org Initialization
|
|
41
64
|
Run this to initialize SDX for a GitHub org:
|
|
@@ -239,6 +262,14 @@ This repo uses Changesets and releases from `main`.
|
|
|
239
262
|
- Publish prerequisites:
|
|
240
263
|
- configure npm auth for CI (`NPM_TOKEN` repo secret),
|
|
241
264
|
- allow workflow pushes to `main` under your branch protection policy.
|
|
265
|
+
- use an npm automation token with package `Read and write` and 2FA bypass enabled for CI publish.
|
|
266
|
+
|
|
267
|
+
Set npm token secret (maintainers):
|
|
268
|
+
|
|
269
|
+
```bash
|
|
270
|
+
gh secret set NPM_TOKEN --repo dana0550/system-desiigner
|
|
271
|
+
gh secret list --repo dana0550/system-desiigner | rg NPM_TOKEN
|
|
272
|
+
```
|
|
242
273
|
|
|
243
274
|
Maintainer commands:
|
|
244
275
|
|