@freecodecamp/universe-cli 0.8.0 → 0.8.1

package/LICENSE

@@ -1,13 +1,29 @@
-Copyright (c) freeCodeCamp
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+BSD 3-Clause License
+
+Copyright (c) 2014, freeCodeCamp.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+	list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+	this list of conditions and the following disclaimer in the documentation
+	and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+	contributors may be used to endorse or promote products derived from
+	this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,6 +1,6 @@
 # Universe CLI
 
-Static site deployment for the freeCodeCamp Universe platform.
+A CLI for freeCodeCamp staff and operators to deploy, manage and maintain constellation apps on the freeCodeCamp Universe Platform.
 
 ## Install
 
@@ -52,82 +52,23 @@ Verify:
 universe --version
 ```
 
-## CLI surface
-
-Top-level (cross-cutting):
-
-```sh
-universe login            # GitHub OAuth device flow → ~/.config/universe-cli/token
-universe logout           # delete stored token
-universe whoami           # echo current login + authorized-sites count
-universe --version        # CLI version
-```
-
-Static-site verbs (namespaced under `static`):
-
-```sh
-universe static deploy [--promote] [--dir <path>]
-universe static promote [--from <deployId>]
-universe static rollback --to <deployId>
-universe static ls [--site <site>]
-```
-
-Static-app registry (namespaced under `sites`, staff-gated writes):
-
-```sh
-universe sites ls [--mine]                          # list registered sites; `--mine` filters to your authorized set
-universe sites register <slug> [--team=<name>...]   # create new entry (staff; defaults --team to staff)
-universe sites update <slug> --team=<name>...       # replace teams list (staff)
-universe sites rm <slug>                            # delete entry (staff; R2 deploy bytes untouched)
-```
-
-Repository creation + approval queue (namespaced under `repo`):
+## Quickstart
 
 ```sh
-universe repo create [name] [--visibility public|private] [--template <repo>] [--description <text>] [--yes]
-                                                    # request a repo in freeCodeCamp-Universe (staff; prompts when run bare)
-universe repo ls [--status <state>] [--mine]        # list requests (default: pending; state ∈ pending|approved|active|rejected|failed|all)
-universe repo status <id>                           # show one request's lifecycle state
-universe repo approve <id> [--yes]                  # approve → creates the repo via the Apollo-11 App (admin)
-universe repo reject <id> [--reason <text>] [--yes] # reject a pending request (admin)
-```
-
-Repo requests enter an artemis-owned approval queue (independent of the legacy Windmill flow). The Apollo-11 GitHub App key lives in the cluster, never the CLI — the CLI only carries your GitHub bearer.
-
-All commands support `--json` for CI integration.
-
-## Identity (priority chain)
-
-The CLI resolves a GitHub identity in this order — first match wins:
-
-1. `$GITHUB_TOKEN` / `$GH_TOKEN` env (CI explicit)
-1. Device-flow stored token at `~/.config/universe-cli/token` (`universe login`)
-1. `gh auth token` shell-out (laptop fallback when no `universe login` token)
-
-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`.
-
-## Configuration (`platform.yaml`)
-
-Every site has a `platform.yaml` at its repo root. Minimal valid file:
-
-```yaml
-site: my-site
+universe login          # GitHub OAuth device flow
+# add a platform.yaml at your repo root with: site: my-site
+universe static deploy  # upload the build to a new preview deploy
+universe static promote # point production at that deploy
 ```
 
-Full schema reference (every field, defaults, validation rules): [`docs/platform-yaml.md`](docs/platform-yaml.md).
-
-No credential fields. The proxy holds the R2 admin key; the CLI never reads or writes one.
+## Docs
 
-## Common flows
+Start with the [Staff Guide](docs/STAFF-GUIDE.md). See the [command reference](docs/reference.md), the [`platform.yaml` schema](docs/platform-yaml.md), or [architecture & internals](docs/README.md).
 
-Full operator walkthrough (login → deploy → promote → rollback, CI shape, registry admin, troubleshooting) lives in [`docs/STAFF-GUIDE.md`](docs/STAFF-GUIDE.md).
+## License
 
-## Environment overrides
+Copyright © 2014 freeCodeCamp.org
 
-| Env                         | Default                                        | Purpose                                                    |
-| --------------------------- | ---------------------------------------------- | ---------------------------------------------------------- |
-| `UNIVERSE_PROXY_URL`        | `https://uploads.freecode.camp`                | Override proxy host (staging etc.)                         |
-| `UNIVERSE_GH_CLIENT_ID`     | _baked-in freeCodeCamp-Universe GitHub App id_ | Override GitHub App client id (fork tenants, `login` only) |
-| `GITHUB_TOKEN` / `GH_TOKEN` | —                                              | Slot 1 of identity chain                                   |
+The content of this repository is bound by the following license:
 
-The shipped binary embeds the `freeCodeCamp-Universe` GitHub App client id (public; device flow uses no `client_secret`), so `universe login` works out of the box for staff once the App is installed on their org. Fork operators and self-hosted mirror tenants set `UNIVERSE_GH_CLIENT_ID` to their own GitHub App's id — env value wins when set.
+- The computer software is licensed under the [BSD-3-Clause](LICENSE) license.

package/dist/index.cjs

@@ -25489,7 +25489,7 @@ var APP_DIR2 = "universe-cli";
 var CACHE_FILE = "update-check.json";
 var PKG_NAME = "@freecodecamp/universe-cli";
 var NPM_LATEST_URL = `https://registry.npmjs.org/${PKG_NAME}/latest`;
-var TTL_MS = 24 * 60 * 60 * 1e3;
+var TTL_MS = 6 * 60 * 60 * 1e3;
 var FETCH_TIMEOUT_MS = 3e3;
 function configBase2() {
   const xdg = process.env["XDG_CONFIG_HOME"];
@@ -25577,10 +25577,12 @@ function parseVersion(s) {
   if (nums.some((n) => Number.isNaN(n))) return null;
   return [nums[0], nums[1], nums[2]];
 }
-async function refreshIfStale(now = Date.now()) {
+async function refreshIfStale(now = Date.now(), options = {}) {
   if (isDisabled()) return;
-  const cache = await readCache();
-  if (cache !== null && now - cache.lastCheck < TTL_MS) return;
+  if (!options.force) {
+    const cache = await readCache();
+    if (cache !== null && now - cache.lastCheck < TTL_MS) return;
+  }
   const latest = await fetchLatest();
   if (latest === null) return;
   try {
@@ -25635,7 +25637,7 @@ function installExitNotice(current) {
 }
 
 // src/cli.ts
-var version2 = true ? "0.8.0" : "0.0.0";
+var version2 = true ? "0.8.1" : "0.0.0";
 function handleActionError(command, json2, err) {
   const ctx = { json: json2, command };
   const message = err instanceof Error ? err.message : "unknown error";
@@ -25650,11 +25652,17 @@ function findFirstPositional(args) {
   }
   return -1;
 }
-function run(argv = process.argv) {
+function isVersionRequest(args) {
+  return args.includes("--version") || args.includes("-v");
+}
+async function run(argv = process.argv) {
   installExitNotice(version2);
-  void refreshIfStale().catch(() => {
-  });
   const args = argv.slice(2);
+  const versionRequested = isVersionRequest(args);
+  if (!versionRequested) {
+    void refreshIfStale().catch(() => {
+    });
+  }
   const firstPosIdx = findFirstPositional(args);
   const namespace = firstPosIdx >= 0 ? args[firstPosIdx] : void 0;
   const isStatic = namespace === "static";
@@ -25947,6 +25955,9 @@ function run(argv = process.argv) {
     cli.version(version2);
     cli.parse(argv);
   }
+  if (versionRequested) {
+    await refreshIfStale(Date.now(), { force: true });
+  }
 }
 
 // src/lib/fatal.ts
@@ -25965,4 +25976,4 @@ function installFatalHandlers(onFatal = defaultOnFatal) {
 
 // src/index.ts
 installFatalHandlers();
-run();
+void run();

package/dist/index.js

@@ -2842,7 +2842,7 @@ var APP_DIR2 = "universe-cli";
 var CACHE_FILE = "update-check.json";
 var PKG_NAME = "@freecodecamp/universe-cli";
 var NPM_LATEST_URL = `https://registry.npmjs.org/${PKG_NAME}/latest`;
-var TTL_MS = 24 * 60 * 60 * 1e3;
+var TTL_MS = 6 * 60 * 60 * 1e3;
 var FETCH_TIMEOUT_MS = 3e3;
 function configBase2() {
   const xdg = process.env["XDG_CONFIG_HOME"];
@@ -2930,10 +2930,12 @@ function parseVersion(s) {
   if (nums.some((n) => Number.isNaN(n))) return null;
   return [nums[0], nums[1], nums[2]];
 }
-async function refreshIfStale(now = Date.now()) {
+async function refreshIfStale(now = Date.now(), options = {}) {
   if (isDisabled()) return;
-  const cache = await readCache();
-  if (cache !== null && now - cache.lastCheck < TTL_MS) return;
+  if (!options.force) {
+    const cache = await readCache();
+    if (cache !== null && now - cache.lastCheck < TTL_MS) return;
+  }
   const latest = await fetchLatest();
   if (latest === null) return;
   try {
@@ -2988,7 +2990,7 @@ function installExitNotice(current) {
 }
 
 // src/cli.ts
-var version = true ? "0.8.0" : "0.0.0";
+var version = true ? "0.8.1" : "0.0.0";
 function handleActionError(command, json, err) {
   const ctx = { json, command };
   const message = err instanceof Error ? err.message : "unknown error";
@@ -3003,11 +3005,17 @@ function findFirstPositional(args) {
   }
   return -1;
 }
-function run(argv = process.argv) {
+function isVersionRequest(args) {
+  return args.includes("--version") || args.includes("-v");
+}
+async function run(argv = process.argv) {
   installExitNotice(version);
-  void refreshIfStale().catch(() => {
-  });
   const args = argv.slice(2);
+  const versionRequested = isVersionRequest(args);
+  if (!versionRequested) {
+    void refreshIfStale().catch(() => {
+    });
+  }
   const firstPosIdx = findFirstPositional(args);
   const namespace = firstPosIdx >= 0 ? args[firstPosIdx] : void 0;
   const isStatic = namespace === "static";
@@ -3300,6 +3308,9 @@ function run(argv = process.argv) {
     cli.version(version);
     cli.parse(argv);
   }
+  if (versionRequested) {
+    await refreshIfStale(Date.now(), { force: true });
+  }
 }
 
 // src/lib/fatal.ts
@@ -3318,4 +3329,4 @@ function installFatalHandlers(onFatal = defaultOnFatal) {
 
 // src/index.ts
 installFatalHandlers();
-run();
+void run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freecodecamp/universe-cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "main": "dist/index.js",
   "scripts": {
     "test": "vitest run",
@@ -11,7 +11,7 @@
     "prepare": "husky"
   },
   "author": "Mrugesh Mohapatra <noreply@mrugesh.dev> (https://mrugesh.dev/)",
-  "license": "ISC",
+  "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/freeCodeCamp-Universe/universe-cli.git"
@@ -58,4 +58,4 @@
     "deployment",
     "freecodecamp"
   ]
-}
+}