Skip to content
Bifröst Orbit
Sign in

CMS Orbit CLI

Your space, from the terminal. Reviewed like code.

npx cms-orbit covers what developers do outside the editor. Keep content types and components in your repository, move content and media as files, run migrations with a dry run first and start a website from a starter, signed in as you with your own role.

Read the CLI guide

A session with Northwilds

From sign-in to migration in six commands

Sign in in the browser, write the schema to files, add a field, see the change and push it. Then pull the trips as JSON and try a migration without saving anything.

  • Every push shows the diff and asks first
  • Content is saved as drafts unless you pass --publish
  • Each change is in the audit trail with your name
TerminalShell
$ npx cms-orbit loginSigned in to https://app.bifrostorbit.com/cms as Ingrid Lund (ingrid@northwilds.com).$ npx cms-orbit schema initWrote 12 content types and 34 components of Northwilds to cms/schema.# Add a season field to cms/schema/components/trip-hero.ts$ npx cms-orbit schema diffComponents  ~ trip-hero (Trip hero)      + field season (select)0 to add, 1 to change, 0 to remove.$ npx cms-orbit schema pushApply 1 change to Northwilds? [y/N] yApplied 1 of 1 change.Undo with: cms-orbit schema rollback 2026-11-15T09-30-00-000Z-schema-push$ npx cms-orbit content pull --folder tripsPulled 32 entries into cms/content.$ npx cms-orbit migrations run cms/migrations/2026-11-15-hero.ts --dry-runDry run: 9 of 41 entries would change for the hero component. Nothing was saved.

Every command

Everything outside the editor

One command line for the schema, content, media, taxonomies and migrations of your spaces. It comes with the JavaScript SDK from 0.16.0, and runs with npx.

Sign in as you

Sign in once in your browser. The command line then acts as you, with your role, until you sign out.

Schema as code

Your content types and components as TypeScript files: init, validate, diff, push and roll back.

Components on their own

Pull and push components as JSON files, one per component, with the same checks as a schema push.

Types for every SDK

TypeScript, PHP, Swift or Kotlin, from the space or from your local schema files.

Content as files

Find, pull, push and validate entries as JSON files. Pushes save drafts and report conflicts.

Media and taxonomies

Files with their alt text and focus point, and taxonomies with their terms, as JSON or CSV.

Migrations

Generate a typed script, try it as a dry run first, and roll the drafts back if you need to.

Regions and languages

List a space's regions with their prefixes, currencies and time zones, or pull them to a file.

Start a project

Set up a starter for your framework, already connected to your space and with a public key.

Signed in as you

No shared keys on developers' laptops

cms-orbit login opens CMS Orbit's sign-in in your browser. You sign in as you always do, check what the command line asks for and select Allow. From then on it can do what you can do, in every organisation you belong to, with your role's permissions there.

What it changes is recorded as you, marked "(command line)", in the audit log and in each page's history. It renews itself each hour while you use it, ends after 30 days without use, and you can sign out any computer under Your account.

Schema as code

Schema changes in the same pull request

schema init writes each content type and component as a TypeScript file, typed so your editor completes the settings and field types. Change the schema in the same commit as the components that render it, and review both together.

types generate --from cms/schema writes the types from the files themselves, so they follow the schema before you push.

cms/schema/components/trip-hero.tsTypeScript
import type { CmsComponentDefinition } from "@bifrost-orbit-cms/sdk";export default {  key: "trip-hero",  name: "Trip hero",  group: "Trips",  fields: [    { key: "heading", name: "Heading", type: "text", required: true },    { key: "season", name: "Season", type: "select", options: [{ label: "Summer", value: "summer" }, { label: "Winter", value: "winter" }] },    { key: "photo", name: "Photo", type: "asset" },  ],  mainHeading: "heading",} satisfies CmsComponentDefinition;

Safe by default

Push without holding your breath

The diff comes first

A schema push shows every change field by field and asks before applying anything.

Checked before it's sent

Nothing is pushed while validate finds a mistake in your files.

Content isn't dropped

Removing a field that holds values, or changing its type, is refused unless you pass --allow-destructive.

Every push can be undone

A snapshot is saved before anything changes, and schema rollback puts back what that push changed.

Staging unless you say so

Content commands work on Staging and save drafts. Publishing needs a flag and a role that may publish.

Nobody's work overwritten

When someone changed an entry since you pulled it, the push reports a conflict and saves nothing for it.

Migrations

Change hundreds of entries, and see it first

migrations generate hero writes a script for a component or content type, with its fields typed. Your function gets every block of that type, at any depth, and returns it changed.

  • run --dry-run shows each entry's changes and saves nothing
  • A real run saves a snapshot of every draft it changes first
  • rollback last puts the drafts back
cms/migrations/2026-11-15-hero.tsTypeScript
export const target = { component: "hero" } as const;export default function migrate(block: Block<HeroFields>): Block<HeroFields> | null {  if (block.fields.size === "large") block.fields.size = "full";  return block;}

Start a project

A connected website in four commands

  1. 01

    Sign in

    Run npx cms-orbit login and allow the command line in your browser.

  2. 02

    Create the project

    npx cms-orbit project create northwilds-site --framework nextjs --create-key

  3. 03

    Keys already in place

    The env file holds the Delivery API address, your region and a public key for Staging.

  4. 04

    Run it

    npm install and npm run dev, and your space's first page renders.

Starters

A starter for your framework

Each starter is the finished code of a quickstart in the docs. The command points it at your space, and asks which framework when you don't say.

Next.js
React
Astro
Nuxt
Vue
SvelteKit
Angular
Laravel
Symfony

Scripts and CI

Made for pipelines too

A management token in CI

Set ORBIT_TOKEN and CI uses the token, even on a machine where someone is signed in.

JSON when you want it

Commands that answer with data can print only JSON, ready to pipe into jq or another tool.

Retried, made once

Requests that meet 429 or 503 are tried again, and an Idempotency-Key makes each change only once.

Fails the build

Entries that fail validation exit with 1, and so can a schema diff that finds differences, so the pipeline stops.

Logs and reports

Every change is logged on your computer, and bulk commands write a report with every result.

Credentials kept private

Stored in your own config folder, readable only by you. The command line never prints a token.

Questions

About the CMS Orbit CLI

Do we need to install the CMS Orbit CLI?

No. It comes with the JavaScript SDK, @bifrost-orbit-cms/sdk, from version 0.16.0, so npx cms-orbit runs it straight away. To pin a version, add the SDK to your project and call it from your package.json scripts. It needs Node.js where you run it, not in your website or app, so PHP, Swift and Kotlin projects use it too.

What can the command line do in our organisation?

What the person who signed in can do, with their role's permissions in each organisation they belong to. If their role changes, so does what the command line can do. Every change is recorded as them, marked (command line), in the audit log and in each page's history. Creating management tokens and handing over an organisation stay in the browser.

Can a command change our live website by accident?

Content commands work on Staging unless you pass --environment production, and they save drafts: nothing goes live unless you pass --publish and your role may publish there. The schema is shared by every environment of a space, so schema push shows the changes and asks first, refuses to drop fields that hold content unless you pass --allow-destructive, and saves a snapshot that schema rollback puts back.

Can we run it in CI?

Yes. Create a management token and set it as ORBIT_TOKEN; a token always comes before a stored sign-in. --yes applies without asking, --json prints only JSON, and schema diff --exit-code fails the build when your files and the space differ. Requests that meet 429 or 503 are tried again, and every change carries an Idempotency-Key, so a retried change is made only once.

How do we end a sign-in on a lost laptop?

Under Your account in CMS Orbit, each computer where you ran cms-orbit login is listed with when it was last used. Sign it out there, or choose Sign out everywhere. Owners and administrators see everyone's command-line sign-ins on the organisation's Management tokens page. A sign-in that isn't used ends by itself after 30 days.

From the blog

More for developers

All posts
CMS Orbit

4 min read

CMS Orbit now speaks PHP, Swift and Kotlin

Laravel and Symfony websites and native iOS and Android apps get official SDKs too. All four are typed, open source and read the same content.

Guides

3 min read

Live preview for your website in four steps

Show editors their draft on the real website, updating as they type. Here are the four small pieces your website needs, and what each one does.

CMS Orbit

4 min read

Reviews, approvals and an audit trail, built in

How CMS Orbit keeps content right: reviews on every plan, approval steps and review dates on Growth, approved claims, emergency publishing and a record of every change.

Put your schema in the repository today.

Start a trial, run npx cms-orbit login and write your space's schema to files. The trial is free for 14 days.

Read the CLI guide