Skip to content

Commit e5ef190

Browse files
os-zhuangclaude
andauthored
docs(packages): add the CLI publish→install path; note os cloud login (#20)
The Installing table omitted the most common developer path — the one-step `os package publish --env <id> --install [--seed-sample-data]` for cloud-managed environments. Add it, and document `os cloud login` (interactive) vs `OS_CLOUD_API_KEY` (CI) as the two auth options for publishing. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent fde4a4a commit e5ef190

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

content/docs/build/packages.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,20 +98,23 @@ audit, identity, etc.
9898
## Publishing
9999

100100
```bash
101+
os cloud login # once: stores a cloud token in ~/.objectstack/cloud.json
101102
os compile # → dist/objectstack.json
102103
os package publish # → ObjectStack cloud catalog
103104
```
104105

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

111113
## Installing
112114

113115
| Path | How |
114116
|---|---|
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 |
115118
| Console | Marketplace tab → pick package → Install |
116119
| REST | `POST /api/v1/marketplace/install-local` (body: `{ packageId, versionId? }`) |
117120
| Air-gapped | Mount the compiled `dist/objectstack.json` artifact (see [Air-gapped](/docs/deploy/air-gapped)) |

0 commit comments

Comments
 (0)