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:
- Block ID namespace: Confirm
manifest.iduses your own lowercase identifier (such asacme.sprint-boardorsprint-board). Any ID starting withcom.orbix.is rejected at publish and install time withReservedNamespaceError(RESERVED_NAMESPACE). - Capabilities match placed usage: Studio Preview runs with
authorPreview: true. Review every SDK hook your block calls and list the required capabilities inmanifest.capabilities(remembering that declaring a key such asstoragereplaces its default array). - Read-only support: Toggle
props.isReadOnlyin your component and verify buttons and inputs disable cleanly. - Theme compatibility: Switch Orbix between a dark theme (
obsidian) and a light theme (paper) to verify contrast and--orbix-*fallbacks. - Schema migrations: If you are publishing an update that changes stored state fields, bump
schemaVersionand keep all priormigrationssteps 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:
| Target | Where it is stored | Who can use it |
|---|---|---|
| Private | Bundled locally into your browser (IndexedDB + localStorage metadata index) and restored automatically on reload. | Only you on this browser workspace. |
| Team | Bundled and synced to your selected team workspace in Supabase (flushCloudSave). | Members of the selected Orbix team. |
| Marketplace | Bundled 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:
- Static code analysis (
BlockCodeAnalyzer): Orbix scans your bundled source and manifest to detect requested permissions (networkand detected outbound domains,workspace,cross_block_data,clipboard,ai,storage). - Install-time review (
BlockPermissionSheet): Before installation completes, the user sees the detected permissions and domains with individual toggles. - Grant registration (
BlockPermissionStore): Confirming installation persists the user's chosen grants and registers the block's egress context inorbixEgressFirewall. Note that if a block requestsworkspaceorcross_block_datapermissions,BlockPermissionStorestripsnetworkegress to enforce the data air-gap.