From 1b18e1bc8234af941cf42786a1ce15d9d2d51725 Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 22 Aug 2026 01:13:11 +0000 Subject: [PATCH] docs(cli): correct three more stale `os projects` mentions in README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit packages/cli/README.md described an `os projects` command surface as still resolving in three prose sites, beyond the Architecture tree node #10881 already renamed: - :75 command table claimed `os projects create` is a registered alias of `os environments create` — no `aliases` field exists on any of the five environments/*.ts commands or the oclif package.json block, so reworded as the pre-rename spelling instead. - :98 called `os projects bind ...` a "legacy" path that "still binds" — replaced with the real invocation, `os environments bind`. - :278 Typical Workflow used `os projects bind` directly with no caveat; same replacement, plus "Cloud Project" -> "Cloud environment" in the trailing comment on the same line (ADR-0006: "Project" now means only the npm/monorepo sense). Verified against the built binary: old spellings still fail (`Error: Command projects:create not found.` / `projects:bind not found.`, exit 2), new spellings resolve (`os environments create --help` / `os environments bind --help`, exit 0). Fixes #10927 Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_019bmVFqoQPq63zhKrxdYG1r --- .changeset/cli-readme-drop-projects-prose.md | 33 ++++++++++++++++++++ packages/cli/README.md | 6 ++-- 2 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 .changeset/cli-readme-drop-projects-prose.md diff --git a/.changeset/cli-readme-drop-projects-prose.md b/.changeset/cli-readme-drop-projects-prose.md new file mode 100644 index 0000000000..08b2eac010 --- /dev/null +++ b/.changeset/cli-readme-drop-projects-prose.md @@ -0,0 +1,33 @@ +--- +"@objectstack/cli": patch +--- + +docs(cli): correct three more stale `os projects` mentions in the README prose (#10927) + +Follow-up to #10881, which renamed the Architecture source-tree node. This +covers the three remaining places in `packages/cli/README.md` that described +an `os projects` command surface as if it still resolved: + +- The Cloud command table (`:75`) claimed `os projects create` was a + registered **alias** of `os environments create`. It is not: none of the + five files in `packages/cli/src/commands/environments/` (`list.ts`, + `show.ts`, `create.ts`, `switch.ts`, `bind.ts`) declares an `aliases` static + field, and neither does the `oclif` block in `packages/cli/package.json`. + Reworded to name it as the pre-rename spelling instead: "was `os projects + create` before the v5.0 project → environment rename (ADR-0006, no + aliases)". +- The Plugin Management prose (`:98`) called `os projects bind ...` a + "legacy" path that "still binds" an artifact — implying a working + fallback. Replaced with the real current invocation, `os environments + bind ...`. +- The Typical Workflow example (`:278`) used `os projects bind ...` directly, + with no caveat at all. Same replacement, and the trailing comment ("Bind to + a Cloud Project") is updated to "Cloud environment" to match — "Project" + now means only the npm/monorepo sense post-rename (ADR-0006). + +Verified against the built binary (`packages/cli/bin/run.js`), matching the +falsification standard from triage: the old spellings still fail — +`Error: Command projects:create not found.` / `Error: Command projects:bind +not found.` (exit 2, both) — and the new spellings resolve — `os environments +create --help` and `os environments bind --help` both exit 0 and print their +real flag/argument help. diff --git a/packages/cli/README.md b/packages/cli/README.md index a5225633fd..5c1a68f934 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -72,7 +72,7 @@ come from `os cloud login` (stored in `~/.objectstack/cloud.json`) or the |---------|-------------| | `os cloud login` | Authenticate to ObjectStack Cloud (browser or `--email/--password`); writes `~/.objectstack/cloud.json` | | `os cloud whoami` / `os cloud logout` | Inspect / clear the stored cloud session | -| `os environments create --org --name ` | Provision a new environment (alias: `os projects create`) | +| `os environments create --org --name ` | Provision a new environment (was `os projects create` before the v5.0 project → environment rename; ADR-0006, no aliases) | | `os environments list` / `show ` | List / inspect your environments | | `os package publish [artifact]` | Publish `dist/objectstack.json` as a versioned package in your org | @@ -95,7 +95,7 @@ review) or `--auto-approve` (platform admins only). Set `OS_CLOUD_URL` (or ### Plugin Management -Runtime plugins (declared in `objectstack.config.ts` `plugins`) are loaded automatically by `os serve` / `os dev`. There is no `os plugin` command group in v1; runtime plugins are bundled into the build artifact. To distribute a build, publish it as a package with `os package publish` (see [Cloud — publish & install](#cloud--publish--install)); the legacy `os projects bind --artifact dist/objectstack.json` path still binds an artifact directly into an environment without going through the package registry. +Runtime plugins (declared in `objectstack.config.ts` `plugins`) are loaded automatically by `os serve` / `os dev`. There is no `os plugin` command group in v1; runtime plugins are bundled into the build artifact. To distribute a build, publish it as a package with `os package publish` (see [Cloud — publish & install](#cloud--publish--install)); the `os environments bind --artifact dist/objectstack.json` path still binds an artifact directly into an environment without going through the package registry. ### Quality @@ -275,7 +275,7 @@ os generate view customer # 4. Add a list view os validate # 5. Validate everything os dev # 6. Start dev server os compile # 7. Build for production -os projects bind --artifact dist/objectstack.json # 8. Bind to a Cloud Project +os environments bind --artifact dist/objectstack.json # 8. Bind to a Cloud environment ``` ## Architecture