Skip to main content
A Portal Definition is the portal JSON resource graph. The local portal/ directory is your authoring workspace. Remote operations act on either the working definition or an immutable portal version.

​
Create or clone a project

Create a new portal project:
Or clone the provisioned repository for an existing definition:
When names are ambiguous, identify the definition with --id.

​
Install and pull

Pull writes the remote working definition to portal/ and updates the generated synchronization state in .portal-sync/. Do not edit .portal-sync/.

​
Preview locally

The portal development command serves the local resource graph, normally at http://localhost:5173. Use this command for the supported preview.

​
Edit and validate

Edit only the required files under portal/. Keep each file’s $schema value and use its file name as the resource slug.

​
Update the working definition

Pull again if the remote definition may have changed, then push the reviewed local changes:
Push changes the remote working definition. It does not make that definition live. Create and activate a version only after the complete draft is ready for release.
Push can partially succeed. Read the command result, inspect the remote and local state, fix the reported problem, and rerun the command.

​
Release the definition

Version creation snapshots the working definition. Activation makes a selected immutable version live.

Understand the release lifecycle

Learn how working definitions, versions, and activation remain separate.