Skip to content

Commit a9502c0

Browse files
os-zhuangclaude
andauthored
docs(packages): install is an in-environment action, not a publish flag (#21)
Follow-up to #20. The Installing table led with the CLI `os package publish --env <id> --install` one-liner, which framed install as a publish-time flag. That's backwards: a person installs from inside the target environment's Marketplace (no env id, confirmed by their environment login). Lead with the Console marketplace path; demote `--env --install` to a clearly labelled CI shortcut. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent e5ef190 commit a9502c0

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

content/docs/build/packages.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,22 @@ the compiled `dist/objectstack.json` directly to the target install
112112

113113
## Installing
114114

115+
Installing is an **in-environment** action — distinct from publishing. You
116+
publish a package once (to the catalog), then install it from *inside* the
117+
target environment, where the install is confirmed and authorized by your
118+
environment login. You never need to know an environment id to install.
119+
115120
| Path | How |
116121
|---|---|
117-
| CLI (cloud-managed) | `os package publish --env <id> --install [--seed-sample-data]` — publish a version and install it into a cloud environment in one step |
118-
| Console | Marketplace tab → pick package → Install |
122+
| Console (recommended) | Sign in to the environment → **Marketplace** → pick the package → **Install**. Installs into the current environment. |
119123
| REST | `POST /api/v1/marketplace/install-local` (body: `{ packageId, versionId? }`) |
120124
| Air-gapped | Mount the compiled `dist/objectstack.json` artifact (see [Air-gapped](/docs/deploy/air-gapped)) |
121125

126+
> **CI shortcut.** Pipelines that deploy to a *known* environment can publish
127+
> and install in one step: `os package publish --env <id> --install
128+
> [--seed-sample-data]`. This is a convenience for automation, not the path a
129+
> person uses — interactive installs happen in the environment's Marketplace.
130+
122131
Install merges the package's metadata into the live kernel, registers
123132
its objects with ObjectQL, and seeds initial data on first install —
124133
no restart needed. Cached installs are re-registered on the next boot,

0 commit comments

Comments
 (0)