Skip to content
SDK

SDK 0.16.0

  • npx cms-orbit login signs the command line in to CMS Orbit in your browser, as you, with your role's permissions in every organisation you belong to. It renews itself and lasts up to 30 days; cms-orbit logout ends it, and cms-orbit login --token stores a management token instead. cms-orbit user shows who you are signed in as, your organisations and the server, and cms-orbit signup opens the sign-up page.
  • Commands are grouped, such as cms-orbit logs list, with --help on every level and --json for scripts. cms-orbit logs and cms-orbit reports list and prune the log of what the command line changed and the reports bulk commands write. generate, import and promote work as before. See CMS Orbit CLI.
  • cms-orbit schema init writes your space's content types and components as TypeScript files in cms/schema/, one per definition and typed with the new CmsContentTypeDefinition and CmsComponentDefinition types, so your editor completes them. schema validate checks them without signing in (--remote also checks field types against the server), schema diff shows what would change, and schema push applies it: it shows the diff, asks unless you pass --yes, has --dry-run, refuses to remove fields holding values or change their types unless you pass --allow-destructive, never removes what entries use, and saves a snapshot first. schema rollback lists the snapshots and puts one back. --from-space compares with or copies from another space.
  • cms-orbit components pull and components push keep components as JSON files, one per component, with --only and the same safety as schema push.
  • cms-orbit types generate is generate with the same options, and --from cms/schema writes the types from a schema folder. cms-orbit languages list and languages pull show or write an environment's regions and languages, with address prefixes, currencies, time zones, defaults and fallbacks.
  • cms-orbit content find finds entries by type, folder, address, status, date and words, and by meaning with --meaning where Gravity is on, as a table or JSON Lines. content pull writes each entry's draft to a JSON file per entry, content push saves them back as drafts (--dry-run runs CMS Orbit's checks without saving), reports entries someone changed since you pulled them instead of overwriting them, and publishes only with --publish. content validate checks entries in a folder or in the space against the content types and components.
  • cms-orbit media pull and media push download and upload the media library with alt text, titles, captions, tags, focus points and media folders. Push takes a folder, a file or a web address, skips files the library has, and stops clearly when the plan's storage is full.
  • cms-orbit taxonomies pull, push and delete keep taxonomies and their terms as JSON or CSV files. Delete asks to confirm, refuses a taxonomy fields still use unless --force, and keeps a copy that push puts back.
  • cms-orbit migrations generate writes a typed migration file for a component or content type, migrations run applies it to drafts (--dry-run shows each entry's changes) after saving a snapshot, and migrations rollback puts the drafts back from it.
  • cms-orbit project create makes a website project from a starter for Next.js, React, Astro, Nuxt, Vue, SvelteKit, Angular, Laravel or Symfony, or the website template, with its env file pointed at your space and a public key.