Skip to content

Installation

Andrew Blackburn edited this page Aug 27, 2026 · 5 revisions

Installation

Orbit Cards is available directly from the default HACS repository. Manual installation is also available as a fallback.

HACS

  1. Open HACS in Home Assistant.
  2. Search for Orbit Cards.
  3. Select Orbit Cards, then choose Download.
  4. Refresh Home Assistant when the download is complete.
  5. Add one of the Orbit cards from the dashboard card picker.

Manual Install

  1. Download dist/orbit-cards.js from the repository release.

  2. Copy it to:

    /config/www/orbit-cards.js
    
  3. Optional: to use bundled orbit: icons with a manual install, copy dist/manifest.json and the dist/*.svg files beside orbit-cards.js in:

    /config/www
    
  4. In Home Assistant, go to Settings -> Dashboards -> Resources.

  5. Add this resource:

    /local/orbit-cards.js
    
  6. Set resource type to JavaScript module.

  7. Refresh Home Assistant.

Updating

After updating, refresh the browser or reload frontend resources.

Some browsers and Home Assistant apps cache frontend modules aggressively. If changes do not appear immediately, use a hard refresh or clear frontend cache.

Development Build

To test unreleased changes from the Dev branch without replacing the normal release, see Development Build. The development bundle uses separate -dev component types and can run alongside the HACS version.

Add To Dashboard

Orbit Cards appear in Home Assistant's card picker:

  • Orbit Area Card
  • Orbit Status Card
  • Orbit Action Card
  • Orbit Deck Card
  • Orbit Status Badge (from a dashboard badge or Heading card badge picker)

Home Assistant 2026.6 and newer can also suggest Orbit Cards from selected entities.

Clone this wiki locally