CLI

The ui:* Artisan commands fetch registry items, manage installed code, and keep your project in sync with upstream without overwriting your local edits. Run them from your Laravel application root after requiring jml/brok.

php artisan ui:install [--alpine]

This command takes no arguments. Pass --alpine to write the Alpine.js bootstrap without prompting. It detects your project stack (Laravel version, Tailwind, Vite, Alpine, Livewire, dark-mode config) and then:

• Writes ui.json and ui-lock.json if they do not already exist.
• Copies resources/css/ui.css, resources/js/ui/index.js, and resources/views/components/ui/_styles.php into your project (existing files are preserved).
• Appends the CSS and JS imports to your entrypoints when they can be detected (resources/css/app.css / resources/js/app.js).
• Prints a manual step for any entrypoint it could not detect automatically.

Re-running the command is safe — existing files and imports are never overwritten or duplicated.

php artisan ui:list [<filter>] [--pro] [--type=<kind>] [--stability=<stability>] [--json]

The default output groups items by kind: components, blocks, pages, bundles, and themes. Use this before ui:add when you know roughly what you need but not the exact registry name.

php artisan ui:build "analytics dashboard with filters" [--type=page] [--limit=8] [--pro] [--json]

Searches authored registry knowledge as well as item names and descriptions. The first result is the recommended starting point; JSON mode returns matched terms, scores, alternatives, and exact install commands for agents and scripts.

php artisan ui:manifest [--json]

Describes every ui:* command, argument, option, mutation flag, response type, example, and stable error code. Integrations should inspect this manifest before constructing commands.

php artisan ui:foundation [--check] [--dry-run] [--yes] [--ours|--theirs]

Updates resources/css/ui.css and _styles.php from portable bases stored in ui-lock.json. Registry items declare a minimum compatible foundation version.

php artisan ui:theme ./brok-theme.json [--name=custom] [--dry-run] [--force] [--json]

Validates token names and values, writes resources/css/themes/<name>.css, and maintains a deduplicated import in resources/css/ui.css. Registry presets use the normal ui:add themes/<name> flow.

php artisan ui:show <item> [--skeleton] [--json]

Shows the item's type, license, stability, version, dependencies, files, and usage. Prefix authenticated Pro names with pro/; use --skeleton for its compact regions, responsive contract, states, and composed primitives; combine it with --json for agents.

php artisan ui:add [<item>] [--force] [--pin] [--dry-run]

Fetches the item JSON from the registry, validates file hashes, writes the target files into your project, and records the installed version and hash in ui-lock.json. Registry dependencies declared by the item are resolved and installed recursively (with a cycle guard). Any JS files placed under resources/js/ui/ are automatically added as imports to resources/js/ui/index.js. Required npm packages declared by the item are printed as a warning at the end.

Requires ui.json to be present — run ui:install first. Pro items can be prefixed with pro/ (e.g. pro/data-table) and require a stored auth token from ui:auth.

php artisan ui:update [<item>] [--check] [--dry-run] [--interactive] [--yes] [--force] [--major]

For each item, the command compares the installed file against both the cached upstream base and the latest registry version. Files you have not edited are updated automatically. Files you have edited are merged with a three-way merge when possible; when a merge has conflicts, the incoming file and a unified diff are written to .jml/updates for you to review — the local file is never silently overwritten.

php artisan ui:pin [<item>] [--unpin] [--list]

Pinned items are skipped by bulk updates. Pass --unpin with an item to resume updates, or --list without an item to show all pins.

php artisan ui:remove <item> [--force] [--dry-run]

Use --dry-run to preview deletion. The command refuses to remove an item that another installed item still depends on; --force skips the confirmation prompt, not dependency safety.

php artisan ui:resolve [<item>] [--theirs|--ours|--edit|--list]

List pending conflicts, accept incoming files, keep local files, or open them in $EDITOR. A successful resolution records the incoming version as the next merge base and removes its staging files.

php artisan ui:diff [<item>]

This command has no options. For each file it prints two unified diffs: one between the cached upstream base and your local file (your edits), and one between the cached base and the current registry version (what has changed upstream). Use this to understand what you would be merging before running ui:update.

php artisan ui:status [--json]

This command takes no arguments. Pass --json for machine-readable per-item drift state. It checks whether the configured registry endpoint is reachable, then lists every item recorded in ui-lock.json with its installed version, the latest available version, and a status label (e.g. current, update available, local changes). A good first step before running ui:update on a large project.

php artisan ui:doctor [--offline] [--json]

This command takes no arguments. Pass --offline to skip network reachability checks or --json for machine-readable checks and advisories. It runs a series of environment checks and prints a pass/fail result for each:

• Laravel application base path is available.
• Brok package config (config/ui.php) is loaded.
• Generated component, block, config-file, lock-file, and cache paths are set to the expected defaults.
• The resources/ directory exists.

Exits with a non-zero status if any check fails, making it suitable for CI health checks.

php artisan ui:skill [--check|--update] [--json]

Writes the Claude Code skill and Cursor/AGENTS guidance while preserving user-authored rules outside Brok's marker section. Use --check in CI and --update after package upgrades; --force remains an alias for update.

php artisan ui:auth [<license>] [--registry=<url>] [--label=<text>] [--machine=<hash>]

Sends the license key and a machine fingerprint to the Pro license server's activation endpoint. On success the returned bearer token is stored locally (the path is printed after authentication), and subsequent ui:add pro/<item> calls attach it automatically when fetching from the Pro registry.