Skip to content

docs(cli): drop phantom os codemod v2-to-v3 and stale projects/ tree node#10929

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 21, 2026
+31 −9
Merged

docs(cli): drop phantom os codemod v2-to-v3 and stale projects/ tree node #10929

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
30 changes: 30 additions & 0 deletions .changeset/cli-readme-drop-phantom-codemod.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
---
"@objectstack/cli": patch
---

docs(cli): drop the phantom `os codemod v2-to-v3` claim and stale `projects/` tree node (#10881)

`packages/cli/README.md` is this package's published README, and it carried two
false claims about what the CLI can do.

Its "Code Transforms" section tabled `os codemod v2-to-v3` in the exact same
format as the ~60 real commands above it, and the Architecture source-tree
listing showed a matching `src/commands/codemod/v2-to-v3.ts`. Neither the
command nor the file has ever existed: `packages/cli/src/commands/` has no
`codemod/` directory, and oclif (which resolves commands by globbing
`dist/commands/**/*.js`) returns `command codemod:v2-to-v3 not found` (exit 2).
Removed rather than marked "not yet available", because a reader-facing
row/node with that exact name and shape would still misdescribe the one
concrete plan for this space: #9591 (`os migrate meta --write`, on hold,
targeting v18) is a differently-scoped, differently-named command over the
mechanical retired-key set, not a "v2 config to v3 format" transform — so there
is no accurate future command to point the row at. The "not yet available"
information already lives in `content/docs/protocol/backward-compatibility.mdx`
and `docs/DX_ROADMAP.md`; this brings the package README in line with the tool
itself, which lost the same false prescription in #10882.

The same source-tree listing also showed a `projects/` node under
`src/commands/` with `list/show/create/switch/bind` — stale since the v5.0
`project` → `environment` rename (ADR-0006, no aliases). Renamed to
`environments/`, matching the real directory; the subcommand file list was
already accurate and is unchanged.
10 changes: 1 addition & 9 deletions packages/cli/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,12 +112,6 @@ Runtime plugins (declared in `objectstack.config.ts` `plugins`) are loaded autom
|---------|-------------|
| `os explain [schema]` | Display human-readable explanation of an ObjectStack schema |

### Code Transforms

| Command | Description |
|---------|-------------|
| `os codemod v2-to-v3` | Migrate ObjectStack v2 config to v3 format |

## Configuration

The CLI looks for `objectstack.config.ts` (or `.js`, `.mjs`) in the current directory:
Expand DownExpand Up@@ -296,14 +290,12 @@ os projects bind <id> --artifact dist/objectstack.json # 8. Bind to a Cloud Pro
│ ├── compile.ts # os compile
│ ├── validate.ts # os validate
│ ├── generate.ts # os generate (alias: g)
│ ├── projects/ # os projects <subcommand>
│ ├── environments/ # os environments <subcommand>
│ │ ├── list.ts
│ │ ├── show.ts
│ │ ├── create.ts
│ │ ├── switch.ts
│ │ └── bind.ts
│ ├── codemod/ # os codemod <subcommand>
│ │ └── v2-to-v3.ts
│ └── ...
├── src/utils/ # Shared utilities
└── package.json # oclif config under "oclif" key
Expand Down
Loading