Skip to content

docs(packages): add CLI publish→install path; note os cloud login #20

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): add CLI publish→install path; note os cloud login #20

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
11 changes: 7 additions & 4 deletions content/docs/build/packages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,23 @@ audit, identity, etc.
## Publishing

```bash
os cloud login # once: stores a cloud token in ~/.objectstack/cloud.json
os compile # → dist/objectstack.json
os package publish # → ObjectStack cloud catalog
```

`os package publish` uploads the compiled manifest to the cloud
control plane configured by `OS_CLOUD_URL`, authenticated with
`OS_CLOUD_API_KEY`. For private / air-gapped distribution, skip
publishing and hand the compiled `dist/objectstack.json` directly to
the target install (see Installing below). See [Marketplace](/docs/build/marketplace).
control plane configured by `OS_CLOUD_URL`. Authentication comes from
`os cloud login` (interactive) or, for CI, an `OS_CLOUD_API_KEY` bearer
token. For private / air-gapped distribution, skip publishing and hand
the compiled `dist/objectstack.json` directly to the target install
(see Installing below). See [Marketplace](/docs/build/marketplace).

## Installing

| 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 |
| 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)) |
Expand Down
Loading