Installation

Orbit lives in its own package — almasix-orbit — so you can add an admin panel without dragging it into every Almasix app by default.

Requirements

• Almasix
• almasix-conduit
• almasix-permission (for the default auth/permission middleware story)

Install

terminal

pip install almasix-orbit
smith orbit:install

orbit:install publishes assets, writes config/orbit.py, and scaffolds an OrbitPanelProvider for your first panel (default path /admin).

Scaffold more surfaces with Smith (canonical make:orbit-* names; orbit:* aliases work the same):

terminal

smith make:orbit-panel admin --path=admin   # alias: smith orbit:panel …
smith make:orbit-resource Post --panel=admin  # alias: smith orbit:resource …
smith make:orbit-field MoneyInput             # alias: smith orbit:field …
smith serve

Panels mount on a path prefix only — existing host routes (for example /) are left alone unless you intentionally set .path("/").

That pulls the panels meta-package and its orbit siblings (forms, tables, actions, …). Import paths always start with almasix.orbit:

from almasix.orbit import Panel, PanelRegistry, Resource, Page
from almasix.orbit.forms import Form, TextInput
from almasix.orbit.tables import Table, TextColumn

OrbitServiceProvider is discovered automatically through the almasix.providers entry-point group. Register the generated OrbitPanelProvider in config/app.py if your app does not auto-discover app providers.

Source: almasix-dev/almasix-orbit.

Optional assets

Want a local copy of the CSS/JS to poke at?

terminal

smith vendor:publish --tag=orbit-assets

That drops public/vendor/orbit/orbit.css and orbit.js. The panel shell already links /vendor/orbit/orbit.css and /vendor/orbit/orbit.js — publish when you’re ready to vendor or tweak. orbit:install can run this for you.

Prism layouts that host Orbit UI can also use:

resources/views/layouts/app.prism.html

@orbitStyles
@orbitScripts

Those directives set __orbit_styles / __orbit_scripts in the Prism context when the engine is bound.

Defaults

On register, the provider seeds in-memory config if nothing is set yet:

{
    "path": "/admin",
    "font": "Outfit",
    "brand": "Orbit",
}

Tune brand, path, and colors on the Panel instance itself — see Configuration & assets. Interactive pages are Conduit hosts (Livewire analogue); SDUI forms/tables paint into those hosts.

Next up: Quick start.