Skip to Content
OrbixDocs
Block SDK · Guides

Publish a block

Publish blocks privately, to your team, or to the Orbix Marketplace from Block Studio.

All block publishing happens inside Block Studio (app.orbix.so). There is no CLI publish command and remote third-party script URLs are not accepted at runtime.

Before you publish

Run through this checklist before clicking Publish:

  1. Block ID namespace: Confirm manifest.id uses your own lowercase identifier (such as acme.sprint-board or sprint-board). Any ID starting with com.orbix. is rejected at publish and install time with ReservedNamespaceError (RESERVED_NAMESPACE).
  2. Capabilities match placed usage: Studio Preview runs with authorPreview: true. Review every SDK hook your block calls and list the required capabilities in manifest.capabilities (remembering that declaring a key such as storage replaces its default array).
  3. Read-only support: Toggle props.isReadOnly in your component and verify buttons and inputs disable cleanly.
  4. Theme compatibility: Switch Orbix between a dark theme (obsidian) and a light theme (paper) to verify contrast and --orbix-* fallbacks.
  5. Schema migrations: If you are publishing an update that changes stored state fields, bump schemaVersion and keep all prior migrations steps in place.

Publishing from Block Studio

Open the Publish modal

Open your project in Block Studio, save your latest edits (Save), and click Publish in the top-right toolbar.

Fill in listing details

Set your block's display name, icon, cover swatch or image, short tagline, and Markdown description. Verify the version string follows SemVer (1.0.0, 1.1.0, 2.0.0).

Choose a visibility target

Select one of the three publishing targets:

TargetWhere it is storedWho can use it
PrivateBundled locally into your browser (IndexedDB + localStorage metadata index) and restored automatically on reload.Only you on this browser workspace.
TeamBundled and synced to your selected team workspace in Supabase (flushCloudSave).Members of the selected Orbix team.
MarketplaceBundled and published as a Marketplace listing in Supabase.Any Orbix user who installs the block from the Marketplace.

Verify in a real document

After publishing completes, open any document, type / followed by your block's name or slashShortcut, and insert it onto the page. Test every interactive action once on the document page to confirm community-tier capability checks pass outside Studio Preview.

How Marketplace install permissions work

When another user installs your block from the Marketplace, Orbix does not show surprise runtime permission popups mid-click. Instead:

  1. Static code analysis (BlockCodeAnalyzer): Orbix scans your bundled source and manifest to detect requested permissions (network and detected outbound domains, workspace, cross_block_data, clipboard, ai, storage).
  2. Install-time review (BlockPermissionSheet): Before installation completes, the user sees the detected permissions and domains with individual toggles.
  3. Grant registration (BlockPermissionStore): Confirming installation persists the user's chosen grants and registers the block's egress context in orbixEgressFirewall. Note that if a block requests workspace or cross_block_data permissions, BlockPermissionStore strips network egress to enforce the data air-gap.

On this page