You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4e7e91f
Browse filesBrowse the repository at this point in the historyBrowse files
docs(cli): README states the global flags, the os plugin group and two command rows as os does
The README listed -v/-h as global short flags (both exit 2), said there is no
os plugin command group (build/sign/publish are registered), described os init
as always using the current directory, and os dev as hot reload.
Claude-Session: https://claude.ai/code/session_018gA1pE6eJtwHhqx72G8U9X
Co-authored-by: Claude <noreply@anthropic.com>
The published README now describes the `os` that ships. Three of its claims were false.
6
+
7
+
Clause-②: no
8
+
9
+
**Short flags.** The README listed `-v, --version` and `-h, --help` as global options. `os -v` and `os -h` exit 2 with `command -v not found` / `command -h not found`, because only `--version` and `--help` are registered. It now lists `--version` and `--help` alone and says there is no short form. `-v` already belongs to commands of their own: it is `--verbose` on `os dev`, `os serve`, `os start` and `os doctor`, and `--version` on `os package publish` and `os package install`.
10
+
11
+
**The `os plugin` group.** The README said there is no `os plugin` command group. `os plugin build`, `os plugin sign` and `os plugin publish` are registered, and the README now lists them. It also says the group has no `install`, and that `os plugin` is a different thing from `os plugins`, which is not a command.
12
+
13
+
**Two command rows.**`os init [name]` creates a new directory of that name when a name is given, so it no longer says "in the current directory" for every case. `os dev` restarts the server after each rebuild, so it no longer says "with hot reload".
14
+
15
+
**What changes for an operator.** Nothing at runtime. No command, flag, exit code or help page changes.
Copy file name to clipboardExpand all lines: packages/cli/README.md
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,8 +39,8 @@ os compile
39
39
40
40
| Command | Description |
41
41
|---------|-------------|
42
-
|`os init [name]`| Initialize a new ObjectStack project in the current directory |
43
-
|`os dev [package]`| Start development mode with hot reload|
42
+
|`os init [name]`| Initialize a new ObjectStack project — in a new directory of that name when `name` is given, otherwise in the current directory |
43
+
|`os dev [package]`| Start development mode — watch sources, rebuild the artifact, and restart the server on change|
44
44
|`os serve [config]`| Start the ObjectStack server with plugin auto-detection |
45
45
46
46
### Build & Validate
@@ -112,7 +112,17 @@ review) or `--auto-approve` (platform admins only). Set `OS_CLOUD_URL` (or
112
112
113
113
### Plugin Management
114
114
115
-
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.
115
+
Runtime plugins (declared in `objectstack.config.ts``plugins`) are loaded automatically by `os serve` / `os dev`. 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.
116
+
117
+
A code-bearing plugin — a directory carrying an `objectstack.plugin.json` manifest — is packaged and shipped through the `os plugin` command group (ADR-0025 §3.4, build → sign → publish):
118
+
119
+
| Command | Description |
120
+
|---------|-------------|
121
+
|`os plugin build [dir]`| Compile a plugin into a signed-ready `.osplugin` artifact (`--entry`, `--out`, `--minify`) |
122
+
|`os plugin sign <artifact> --key <pem>`| Sign a built `.osplugin` with a publisher Ed25519 key, writing a detached `<artifact>.sig`|
123
+
|`os plugin publish [artifact]`| Publish a signed `.osplugin` to ObjectStack Cloud |
124
+
125
+
The group has no `install`: ADR-0025 records the code-plugin install half (download, verify, materialize, load) as not yet implemented. `os plugin` (singular) is unrelated to `os plugins` (plural), oclif's plugin manager, which this package does not ship — see [`os plugins` and `os help`](#os-plugins-and-os-help-not-commands).
116
126
117
127
### Quality
118
128
@@ -176,8 +186,13 @@ Common variables: `OS_DATABASE_URL`, `OS_DATABASE_DRIVER`,
176
186
177
187
### Global
178
188
179
-
-`-v, --version` — Show version number
180
-
-`-h, --help` — Show help
189
+
-`--version` — Show version number
190
+
-`--help` — Show help (`os --help`, or `os <command> --help` for one command)
191
+
192
+
There are no short forms: `os -h` and `os -v` exit 2 with `command -h not found` /
193
+
`command -v not found`. `-v` is a command's own flag instead — `--verbose` on `os dev`,
194
+
`os serve`, `os start` and `os doctor`, `--version <semver>` on `os package publish` and
0 commit comments