boxel-cli
Skills for working with Boxel realms via @cardstack/boxel-cli.
Plugin boxel-cli from marketplace cardstack-boxel in review-bench/cardstack_boxel. Commands read from the repo's manifest — 1 month ago.
What it installs
Skills (15)
boxel-apiUse when calling Boxel realm-server APIs from code — primarily federated search across realms. Documents the boxel-cli programmatic surface (`BoxelCLIClient`) and the matching CLI commands. Read this whenever you need to query a realm's index.
boxel-commandUse when running a Boxel host command via the realm server's prerenderer — invoking commands like `get-card-type-schema`, `evaluate-module`, `instantiate-card`, or any other module exposed at `@cardstack/boxel-host/commands/.../default`. Documents `boxel run-command` and the matching `client.runComm
boxel-designBoxel UI design discovery. Use when designing or redesigning a Boxel app, choosing a visual direction, or pushing past default look-and-feel before generating code.
boxel-developmentAuthoring Boxel cards. Use when creating or editing .gts card definitions, .json card instances, or answering questions about CardDef / FieldDef / templates / Boxel patterns. Covers the full .gts authoring surface — imports, fields, formats (isolated/embedded/fitted/atom/edit), styling, and common p
boxel-file-structureFile and directory layout rules for Boxel workspaces. Use when placing .gts definitions or .json instances on disk, choosing module paths in adoptsFrom, or wiring linksTo / linksToMany relationships in JSON. Covers naming conventions, relative module paths, and the linksTo-vs-contains cardinal rule.
boxel-ui-guidelinesEnsures boxel-ui components are used in templates and theming guidelines are followed
catalog-listingcatalog-listing
dev-bfm-syntaxBFM reference: render surfaces, base syntax, :card/::card directives, mermaid, math ($...$ / $$...$$), alerts, footnotes, and code highlighting.
dev-file-defHow to use FileDef, ImageDef, MarkdownDef, and related types for file fields in Boxel cards
dev-markdown-formatAuthoring `static markdown` templates: defaults, markdownEscape, markdown-helpers toolkit, delegation, and pitfalls.
file-opsSingle-file operations against a Boxel realm. Use when the user wants to read, write, list, delete, lint, or touch (force-reindex) one file in a realm by URL — without a full sync.
profileManage saved boxel-cli profiles (credentials for users / environments). Use when the user wants to list profiles, add a new profile, switch the active profile, remove a profile, or migrate from a legacy .env file.
realm-historyLocal checkpoint history plus realm-indexing control. Use when the user wants to view / restore / create checkpoints in `.boxel-history/`, wait for a realm to finish indexing, or cancel a running indexing job.
realm-syncMove files between local disk and a Boxel realm. Use when the user wants to push local changes up, pull a realm down, do a bidirectional sync, watch a realm for continuous remote-to-local mirroring, create or remove a realm, or list realms accessible to the active profile.
searchFederated search across one or more Boxel realms. Use when the user wants to find cards by type, field value, or full-text query, optionally constrained to specific realms.
Maintain boxel-cli?
This page updates itself from your repo. Add the badge to your README, or get it Featured to pin it above the organic results with a followed link to your site.