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 ebe3797
Browse filesBrowse the repository at this point in the historyBrowse files
docs(cli): README states each cloud command's credential source and flags, and os serve --ui as the help does
Patch round 1. The Cloud section said every cloud command reads os cloud
login's session or --token/OS_CLOUD_API_KEY and --server/OS_CLOUD_URL; os
environments * take -u/--url and -t/--token (env OS_TOKEN) and use the os login
session instead. os serve --ui enables the bundled Console portal, not
"Studio UI". The changeset now counts five false claims.
Claude-Session: https://claude.ai/code/session_018gA1pE6eJtwHhqx72G8U9X
Co-authored-by: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .changeset/21310-cli-readme-flags.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
'@objectstack/cli': patch
3
3
---
4
4
5
-
The published README now describes the `os` that ships. Three of its claims were false.
5
+
The published README now describes the `os` that ships. Five things it said were false.
6
6
7
7
Clause-②: no
8
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`.
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
+
-**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.
11
+
-**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".
12
+
-**Cloud credentials and flags.** The README said every cloud command takes its credentials from `os cloud login` or from `--token` / `OS_CLOUD_API_KEY` and `--server` / `OS_CLOUD_URL`. That holds only for `os package publish` and `os plugin publish`. `os environments list`, `show`, `create`, `bind` and `switch` take `-u, --url` (env `OS_CLOUD_URL`) and `-t, --token` (env `OS_TOKEN`), and otherwise use the `os login` session in `~/.objectstack/credentials.json` — never the `os cloud login` session. With only `os cloud login` done they exit 1 with `Authentication required`. The README now has a per-command table, and its typical publish flow says so at the `os environments create` step.
13
+
-**`os serve --ui`.** The README said it enables "Studio UI". It enables the bundled Console portal at `/_console/` when `@object-ui/console` is installed, which is what `os serve --help` says.
10
14
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.
15
+
**What changes for an operator.** Nothing at runtime. No command, flag, environment variable, exit code or help page changes.
`os package install` is not a cloud command: it installs into a running runtime
130
+
(`-r, --runtime`, env `OS_RUNTIME_URL`, default `http://localhost:3000`) and signs
131
+
in there with `--email` / `--password` (env `OS_RUNTIME_EMAIL` /
132
+
`OS_RUNTIME_PASSWORD`).
112
133
113
134
### Plugin Management
114
135
@@ -215,7 +236,7 @@ There are no short forms: `os -h` and `os -v` exit 2 with `command -h not found`
215
236
216
237
-`-p, --port <port>` — Server port. Resolution: `--port` › `$OS_PORT` › `$PORT` › `3000`. With `--dev` a busy port auto-hops to the next free one; in production mode it's a hard error (never silently drifts).
217
238
-`--dev` — Run in development mode (load devPlugins, pretty logging)
218
-
-`--ui` — Enable Studio UI
239
+
-`--ui` — Enable the bundled Console portal at `/_console/` when `@object-ui/console` is installed (default: true)
0 commit comments