From da2478a8b3c5dcda658424904bf58d6c0e15e506 Mon Sep 17 00:00:00 2001 From: os-zhuang Date: Wed, 10 Jun 2026 19:53:48 +0500 Subject: [PATCH] =?UTF-8?q?docs(packages):=20add=20the=20CLI=20publish?= =?UTF-8?q?=E2=86=92install=20path;=20note=20`os=20cloud=20login`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The Installing table omitted the most common developer path — the one-step `os package publish --env --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 --- content/docs/build/packages.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/content/docs/build/packages.mdx b/content/docs/build/packages.mdx index 7e56675..baaf200 100644 --- a/content/docs/build/packages.mdx +++ b/content/docs/build/packages.mdx @@ -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 --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)) |