Skip to content

docs(packages): install is an in-environment action, not a publish flag #21

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-zhuang merged 1 commit into from
Jun 10, 2026
Merged

docs(packages): install is an in-environment action, not a publish flag #21

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
13 changes: 11 additions & 2 deletions content/docs/build/packages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,22 @@ the compiled `dist/objectstack.json` directly to the target install

## Installing

Installing is an **in-environment** action — distinct from publishing. You
publish a package once (to the catalog), then install it from *inside* the
target environment, where the install is confirmed and authorized by your
environment login. You never need to know an environment id to install.

| Path | How |
|---|---|
| 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 |
| Console | Marketplace tab → pick package → Install |
| Console (recommended) | Sign in to the environment → **Marketplace** → pick the package → **Install**. Installs into the current environment. |
| REST | `POST /api/v1/marketplace/install-local` (body: `{ packageId, versionId? }`) |
| Air-gapped | Mount the compiled `dist/objectstack.json` artifact (see [Air-gapped](/docs/deploy/air-gapped)) |

> **CI shortcut.** Pipelines that deploy to a *known* environment can publish
> and install in one step: `os package publish --env <id> --install
> [--seed-sample-data]`. This is a convenience for automation, not the path a
> person uses — interactive installs happen in the environment's Marketplace.

Install merges the package's metadata into the live kernel, registers
its objects with ObjectQL, and seeds initial data on first install —
no restart needed. Cached installs are re-registered on the next boot,
Expand Down
Loading