@freecodecamp/universe-cli 0.5.1 → 0.6.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 +3 -43
- package/dist/index.cjs +844 -106
- package/dist/index.js +180 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ universe <command>
|
|
|
19
19
|
|
|
20
20
|
<details>
|
|
21
21
|
<summary>
|
|
22
|
-
Download the latest binary from
|
|
22
|
+
Download the latest binary from <a href="https://github.com/freeCodeCamp-Universe/universe-cli/releases">Releases</a>:
|
|
23
23
|
</summary>
|
|
24
24
|
|
|
25
25
|
```sh
|
|
@@ -91,9 +91,7 @@ The CLI resolves a GitHub identity in this order — first match wins:
|
|
|
91
91
|
1. `gh auth token` shell-out (laptop with `gh` installed)
|
|
92
92
|
1. Device-flow stored token at `~/.config/universe-cli/token`
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
The proxy validates whatever it receives via GitHub `GET /user`, then authorizes against the registry server-side (Valkey-backed; the `sites_yaml` backend was retired in artemis `f115198`). Run `universe whoami` to see which slot resolved; inspect the sites you can deploy to with `universe sites ls --mine`.
|
|
94
|
+
CI runners must export `$GITHUB_TOKEN` explicitly. artemis validates the bearer via GitHub `GET /user`, then authorizes server-side against the Valkey-backed registry. Run `universe whoami` to see which slot resolved; inspect the sites you can deploy to with `universe sites ls --mine`.
|
|
97
95
|
|
|
98
96
|
## Configuration (`platform.yaml`)
|
|
99
97
|
|
|
@@ -109,45 +107,7 @@ No credential fields. The proxy holds the R2 admin key; the CLI never reads or w
|
|
|
109
107
|
|
|
110
108
|
## Common flows
|
|
111
109
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
```sh
|
|
115
|
-
# 1. Authenticate (laptop, first time)
|
|
116
|
-
universe login
|
|
117
|
-
|
|
118
|
-
# 2. Identity + how many sites you can deploy to
|
|
119
|
-
universe whoami
|
|
120
|
-
|
|
121
|
-
# 3. List your authorized sites (intersects registry with your GH teams)
|
|
122
|
-
universe sites ls --mine
|
|
123
|
-
|
|
124
|
-
# 4. From your site repo: deploy to preview (reads ./platform.yaml)
|
|
125
|
-
universe static deploy
|
|
126
|
-
|
|
127
|
-
# 5. Inspect recent deploys for the current site
|
|
128
|
-
universe static ls
|
|
129
|
-
|
|
130
|
-
# 6. Promote preview to production
|
|
131
|
-
universe static promote
|
|
132
|
-
|
|
133
|
-
# 7. Roll production back to a past deploy
|
|
134
|
-
universe static rollback --to 20260427-141522-abc1234
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
Registry admin (staff team only — gated server-side by artemis's `REGISTRY_AUTHZ_TEAM`, default `staff`):
|
|
138
|
-
|
|
139
|
-
```sh
|
|
140
|
-
# Register a new site (defaults --team to staff)
|
|
141
|
-
universe sites register hello-universe --team bots,staff
|
|
142
|
-
|
|
143
|
-
# Add or replace the teams list on an existing site
|
|
144
|
-
universe sites update hello-universe --team bots,staff,curriculum
|
|
145
|
-
|
|
146
|
-
# Delete a site from the registry (R2 bytes age out via cleanup cron)
|
|
147
|
-
universe sites rm hello-universe
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
CI (GitHub Actions) — pass `$GITHUB_TOKEN` explicitly (slot 1). The OIDC slot will return once artemis grows an OIDC verifier. Full operator walkthrough: [`docs/STAFF-GUIDE.md`](docs/STAFF-GUIDE.md).
|
|
110
|
+
Full operator walkthrough (login → deploy → promote → rollback, CI shape, registry admin, troubleshooting) lives in [`docs/STAFF-GUIDE.md`](docs/STAFF-GUIDE.md).
|
|
151
111
|
|
|
152
112
|
## Environment overrides
|
|
153
113
|
|