@fui-org/fui-cli 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -6
- package/dist/fui.js +158 -156
- package/package.json +1 -1
- package/skills/fui/SKILL.md +1 -1
package/README.md
CHANGED
|
@@ -15,19 +15,50 @@ Design: [docs/specs/2026-09-28-fui-cli-v1-design.md](docs/specs/2026-09-28-fui-c
|
|
|
15
15
|
|
|
16
16
|
## Install
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
### 1. Install Bun
|
|
19
|
+
|
|
20
|
+
`fui` runs on [Bun](https://bun.com) 1.4 or later. Skip this step if `bun --version` already prints 1.4 or later.
|
|
21
|
+
|
|
22
|
+
macOS and Linux:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
curl -fsSL https://bun.sh/install | bash
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
On macOS you can use Homebrew instead:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
brew install oven-sh/bun/bun
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Windows (PowerShell):
|
|
35
|
+
|
|
36
|
+
```powershell
|
|
37
|
+
powershell -c "irm bun.sh/install.ps1 | iex"
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Open a new terminal so `PATH` picks up Bun, then check it:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
bun --version
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
To upgrade an older Bun, run `bun upgrade`.
|
|
47
|
+
|
|
48
|
+
### 2. Install fui
|
|
19
49
|
|
|
20
50
|
```bash
|
|
21
51
|
bun add -g @fui-org/fui-cli
|
|
52
|
+
fui --version
|
|
22
53
|
```
|
|
23
54
|
|
|
24
|
-
This puts `fui` on your `PATH
|
|
55
|
+
This puts `fui` on your `PATH`, in `~/.bun/bin` on macOS and Linux and in `%USERPROFILE%\.bun\bin` on Windows. To run it once without installing:
|
|
25
56
|
|
|
26
57
|
```bash
|
|
27
58
|
bunx --package @fui-org/fui-cli fui --help
|
|
28
59
|
```
|
|
29
60
|
|
|
30
|
-
A global install updates itself. At most once an hour, a command starts a background check against the npm registry. When a newer release exists, the check runs `bun add -g @fui-org/fui-cli@<latest>`. The command you ran is never delayed, and the next run prints one line saying what changed
|
|
61
|
+
A global install updates itself. At most once an hour, a command starts a background check against the npm registry. When a newer release exists, the check runs `bun add -g @fui-org/fui-cli@<latest>`. The command you ran is never delayed, and the next run prints one line saying what changed and refreshes the Claude skills.
|
|
31
62
|
|
|
32
63
|
- `fui update` updates now; `fui update --check` only reports.
|
|
33
64
|
- Turn it off with `fui config set auto-update off` or `FUI_AUTO_UPDATE=0`.
|
|
@@ -63,12 +94,25 @@ bun publish --otp <code>
|
|
|
63
94
|
|
|
64
95
|
## Use with an AI agent
|
|
65
96
|
|
|
97
|
+
A global install gives each AI agent on the machine two skills:
|
|
98
|
+
|
|
99
|
+
- `fui/SKILL.md` teaches the agent the commands, output format, exit codes and safety rules. `fui skill` prints the same guide.
|
|
100
|
+
- `fui-skill/` is the FUI domain skill from Fui MCP 1.4.0, unchanged: module.json, components, tAPI and SP references, design systems.
|
|
101
|
+
|
|
102
|
+
| Agent | Found when this folder exists | Skills go to |
|
|
103
|
+
| ----------- | ------------------------------------ | ------------------------------ |
|
|
104
|
+
| Claude Code | `~/.claude` (or `CLAUDE_CONFIG_DIR`) | `~/.claude/skills` |
|
|
105
|
+
| Codex | `~/.codex` (or `CODEX_HOME`) | `~/.agents/skills` |
|
|
106
|
+
| Antigravity | `~/.gemini/antigravity` | `~/.gemini/antigravity/skills` |
|
|
107
|
+
|
|
108
|
+
The skills are written on the first `fui` run after install, right after every update, and on the first run after you install another agent. On Windows, `~` is `%USERPROFILE%`. Each install replaces both folders, so keep your own notes elsewhere. Turn it off with `FUI_AUTO_SKILLS=0`.
|
|
109
|
+
|
|
110
|
+
To install by hand, for an agent not installed yet, or into another folder:
|
|
111
|
+
|
|
66
112
|
```bash
|
|
67
|
-
fui skill install
|
|
113
|
+
fui skill install [--agent claude,codex,antigravity|all] [--dir <skills-root>]
|
|
68
114
|
```
|
|
69
115
|
|
|
70
|
-
This writes `~/.claude/skills/fui/SKILL.md`, which teaches the agent the commands, output format, exit codes and safety rules. `fui skill` prints the same guide.
|
|
71
|
-
|
|
72
116
|
## Quick tour
|
|
73
117
|
|
|
74
118
|
```bash
|