---
name: lgui-setup
description: "Initialize LGUI configuration and project directories after plugin installation, diagnose an LGUI workspace, or restore its pinned dependencies. Use for starting browser-first FairyGUI UI work; do not use for unrelated Node or Unity projects."
license: MIT
compatibility: "Node.js 24.18+ and Git; network access for explicit dependency restoration."
---

Start here after installing LGUI. Inputs: the user's chosen absolute workspace directory, whether to restore dependencies, and whether Unity support is needed.

1. Resolve [the CLI](../../tools/lgui.mjs) from this installed skill's location. Its absolute location is stable within this installed version, independent of the shell working directory. Never derive the plugin from the user's cwd, write into its cache, or assume host placeholder variables are expanded in this Markdown.
2. If no destination was supplied, ask for a workspace directory before writing anything. A request merely asking what LGUI is should receive an explanation, not initialization. Keep temporary validation directories separate too.
3. For a new UI run `node <absolute-cli> init --workspace <absolute-workspace>`: the default is a blank FairyGUI/TypeScript project, `.lgui/workspace.json` and `.lgui/project.json`. Use `--template inventory` only when the user selects the reference example. Existing differing files or a different template stop initialization; preserve user edits. For an existing workspace, skip init and run doctor. Older workspaces need an explicit [project manifest migration](../../docs/projects.md).
4. Run `doctor`, then `bootstrap --dry-run` through the same CLI and workspace, unless the user limited the request to doctor alone. Explain the three dependency roots and report missing tools. A null `unityEditorOverride` only means UNITY_EDITOR is unset: it does not detect whether Unity is installed or licensed. When dependency restoration is requested, run `bootstrap --install`; add `--unity` only for native work.
5. Read `.lgui/project.json`, then run its `build-web` and `serve` entries. The blank starter serves `/`; the inventory recipe serves `/fidelity/`. Report the URL from doctor and how to stop the process. For editor work run `editor` separately and continue with lgui-edit. A diagnosis-only request stops after reporting results.

Every command after the command name uses `--workspace <absolute-workspace>`. Output: workspace/config location, dependency status, tested URL, and unresolved prerequisites. Blank initialization supplies an editable minimal UI, not a design generator or configured Unity application. Unity requires a project, build methods, platform adapter and validation entry in the project manifest. It never installs or activates Unity. See [project configuration](../../docs/projects.md) and [setup details](references/setup.md).