Skip to content

docs(cli): correct three more stale os projects mentions in README#10968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-elon merged 1 commit into from
Aug 22, 2026
+36 −3
Merged

docs(cli): correct three more stale os projects mentions in README #10968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/cli-readme-drop-projects-prose.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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.
6 changes: 3 additions & 3 deletions packages/cli/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 <id> --name <n>` | Provision a new environment (alias: `os projects create`) |
| `os environments create --org <id> --name <n>` | Provision a new environment (was `os projects create` before the v5.0 project → environment rename; ADR-0006, no aliases) |
| `os environments list` / `show <id>` | List / inspect your environments |
| `os package publish [artifact]` | Publish `dist/objectstack.json` as a versioned package in your org |

Expand All@@ -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 <id> --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 <id> --artifact dist/objectstack.json` path still binds an artifact directly into an environment without going through the package registry.

### Quality

Expand DownExpand Up@@ -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 <id> --artifact dist/objectstack.json # 8. Bind to a Cloud Project
os environments bind <id> --artifact dist/objectstack.json # 8. Bind to a Cloud environment
```

## Architecture
Expand Down
Loading