fui

A command-line tool for the FUI low-code platform: projects, modules, components, imports, users, rights, database connections, SQL, schema and stored procedures. It works with AI agents (Claude Code, Codex, Antigravity).

Install

1. Install fui

Needs Node.js 22 or later (node --version).

npm install -g @fui-org/fui-cli
fui --version

Or install with Bun

If you use Bun as your package manager, install fui with it instead. fui still runs on Node.js.

bun add -g @fui-org/fui-cli

2. Set up

Ask your FUI administrator for the API address and your API token, then:

fui config set api-base https://<fui-api-host>
printf %s "$FUI_TOKEN" | fui config set api-token -
fui project list

The token is read from stdin, so it never lands in your shell history. fui config shows the current settings.

For real-browser checks (fui module simulate --render, fui component preview), install Playwright once:

npm install -g playwright && npx playwright install chromium

Installed fui with Bun? Install Playwright the same way, so fui finds it: bun add -g playwright && bunx playwright install chromium.

Updates

fui updates itself in the background, at most once an hour, and prints one line after an update. fui update updates now, and fui update --check only reports. Turn it off with fui config set auto-update off.

Use with an AI agent

fui installs one skill, fui, for each AI agent it finds, and refreshes it after every update. It holds the commands, the safety rules and the FUI domain rules (module.json, components, tAPI and stored procedures, design systems); fui skill prints it. One AI agent handles each request from implementation through verification, without sub-agent hand-offs.

| Agent | Skills folder | | ----------- | ------------------------------ | | Claude Code | ~/.claude/skills | | Codex | ~/.agents/skills | | Antigravity | ~/.gemini/antigravity/skills |

For Claude Code it also installs the fui-target mod into ~/.claude/skills/fui-target. Once a session runs fui, a line above the prompt shows the session target, for example 🧩 monitor-manager › device-list · fui use.

Installed an agent later? The next fui run adds its skill. To install by hand:

fui skill install [--agent claude,codex,antigravity|all]

Work with one agent

Ask as usual, for example add a search box and an edit dialog to /my-project/students. The same agent understands the request, changes the UI and stored procedures, checks the result and fixes proven failures. Exact changes are handled directly; broader work gets a short internal plan without creating hand-off files. Checks run from cheapest to most expensive, and browser rendering is used only when pixels matter. After all assigned module work passes its checks, the agent publishes the module and deploys its SPs automatically. Say do not upload, local only, draft or preview first when you want it to stop before changing the server. Destructive operations and real-data writes still require explicit approval.

Quick tour

fui --help
fui module get /my-project/my-module
fui module validate
fui db list
fui query "SELECT TOP 5 * FROM tblX" --db my-project/docs
fui schema --search student
fui sp get spAPI_Student_Select
fui file status

fui <command> --help shows the options of one command.

Workspace location

fui keeps projects in ~/.fui/workspaces. To use another folder:

fui config set workdir ~/work/fui

The files in a workspace are described in docs/workspace-format.md.

Database connections

Secrets are read only from stdin (-) or from an env var (--*-env VAR):

printf %s "$TOKEN" | fui db add docs -p my-project --token - --api-domain tapi.example.edu.vn
fui db add local -p demo --conn-env SQLITE_URL
fui db list

A connection is an MSSQL string (through tAPI) or a sqlite:// URL. fui db add <apiName> saves it under a readable connection name (--name, suggested from the apiName and zone otherwise) in _db/_connections.json version 2.

Coming from Fui MCP

fui does not read Fui MCP's settings. Point it at your workspace and set the API once:

fui config set workdir <your Fui MCP workspace folder>
fui config set api-base https://<fui-api-host>
printf %s "$FUI_TOKEN" | fui config set api-token -

Connection files from before the multi-zone layout (_connections.json without "version": 2) are upgraded the first time fui reads them (the old file is kept in _history/). fui db migrate does the same for every project at once.

Uninstall

npm uninstall -g @fui-org/fui-cli

Installed with Bun: bun remove -g @fui-org/fui-cli.