@fui-org/fui-cli 1.0.4 → 1.1.0

package/README.md

@@ -1,17 +1,6 @@
 # fui
 
-A token-lean CLI for the FUI low-code platform, built with Bun. It is the successor to the Fui MCP server (`@fui-org/fui-mcp`).
-
-v1 covers the database workflow:
-
-- connections
-- SQL
-- schema
-- stored procedures
-
-It shares the Fui MCP workspace, so existing connections work immediately.
-
-Design: [docs/specs/2026-09-28-fui-cli-v1-design.md](docs/specs/2026-09-28-fui-cli-v1-design.md)
+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) and replaces the Fui MCP server.
 
 ## Install
 
@@ -52,115 +41,90 @@ bun add -g @fui-org/fui-cli
 fui --version
 ```
 
-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:
+This puts `fui` on your `PATH`, in `~/.bun/bin` on macOS and Linux and in `%USERPROFILE%\.bun\bin` on Windows.
 
-```bash
-bunx --package @fui-org/fui-cli fui --help
-```
+Already use Node.js 22 or later? `npm install -g @fui-org/fui-cli` works too. Also install Node.js 22+ on a Bun-only machine, because `fui` starts through `node`. Postgres and MySQL connections need Bun.
 
-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. Run `fui skill install` afterwards if you installed the skills.
+### 3. Set up
 
-- `fui update` updates now; `fui update --check` only reports.
-- Turn it off with `fui config set auto-update off` or `FUI_AUTO_UPDATE=0`.
-- A `bun link` checkout or a compiled binary never replaces itself; `fui update` prints the install command instead.
+Ask your FUI administrator for the API address and your API token, then:
 
-Remove with `bun remove -g @fui-org/fui-cli`.
+```bash
+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.
 
-### From source
+For real-browser checks (`fui module simulate --render`, `fui component preview`), install Playwright once:
 
 ```bash
-bun install
-bun link
+bun add -g playwright && bunx playwright install chromium
 ```
 
-`bun link` points `fui` at `src/cli.ts`, so source edits apply immediately.
+## Updates
 
-### Build outputs
+`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`.
 
-- `bun run build` writes `dist/fui.js`, a single minified bundle for Bun. This is the file the npm package ships; `prepack` runs it automatically.
-- `bun run build:bin` writes `dist/fui`, a standalone executable that runs without Bun installed.
-
-### Release
+## Use with an AI agent
 
-npm never accepts the same version twice, so bump before every publish (`patch` for fixes, `minor` for features):
+`fui` installs two skills for each AI agent it finds, and refreshes them after every update:
 
-```bash
-bun test && bun run typecheck && bun run lint && bun run format:check
-bun pm version patch --no-git-tag-version
-bun publish --otp <code>
-```
+- `fui` teaches the agent the commands and safety rules. `fui skill` prints it.
+- `fui-skill` holds the FUI domain rules: module.json, components, tAPI and stored procedures, design systems.
 
-`bun publish` packs `dist/fui.js`, `skills/` and `README.md`, and needs npm access to the `@fui-org` scope and 2FA on the account.
+| Agent       | Skills folder                  |
+| ----------- | ------------------------------ |
+| Claude Code | `~/.claude/skills`             |
+| Codex       | `~/.agents/skills`             |
+| Antigravity | `~/.gemini/antigravity/skills` |
 
-## Use with an AI agent
+Installed an agent later? The next `fui` run adds its skills. To install by hand:
 
 ```bash
-fui skill install
+fui skill install [--agent claude,codex,antigravity|all]
 ```
 
-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.
-
 ## Quick tour
 
 ```bash
+fui --help
+fui module get /my-project/my-module
+fui module validate
 fui db list
-fui query "SELECT TOP 5 * FROM tblX" --db lhu-docs/docs
+fui query "SELECT TOP 5 * FROM tblX" --db my-project/docs
 fui schema --search student
 fui sp get spAPI_Student_Select
-fui sp deploy spAPI_Student_Select
 fui file status
 ```
 
-## Parity with Fui MCP
-
-`fui` ports Fui MCP 1.4.0 tool by tool. The spec is [docs/specs/2026-09-28-fui-cli-v2-parity-design.md](docs/specs/2026-09-28-fui-cli-v2-parity-design.md).
-
-- **Source of truth:** `@fui-org/fui-mcp@1.4.0` is pinned as a dev dependency.
-- **Parity tests:** `test/parity/` runs its real tool handlers next to `fui` on twin workspaces. They compare the HTTP requests, the files written and the outcome byte for byte.
-- **What stays identical:** guards, confirmations, reading and pulling.
-- **What changes:** output is terse, and limits that exist only for the context window can be lifted with flags.
-
-Commands already ported, and the MCP tools still to come, are listed in the `fui` skill (`fui skill`).
+`fui <command> --help` shows the options of one command.
 
 ## Workspace location
 
-`fui` picks the workspace folder in this order:
-
-1. `--workdir <dir>`
-2. `FUI_MCP_WORKDIR` env var
-3. `fui config set workdir <dir>`, saved in `~/.config/fui/config.json` (respects `XDG_CONFIG_HOME`)
-4. `FUI_MCP_WORKDIR` of the Fui MCP server in `~/.claude.json` (project scope first, then user scope; respects `CLAUDE_CONFIG_DIR`)
-5. `~/.fui-mcp/workspaces`
+`fui` keeps projects in `~/.fui-mcp/workspaces`, the same folder Fui MCP uses. To use another folder:
 
 ```bash
-fui config                          # effective value and where it came from
 fui config set workdir ~/work/fui
-fui config unset workdir
 ```
 
-## Connections
-
-A dbToken is Base64 of a connection string. The engine is detected from the token:
-
-| Connection string                             | Engine          | Transport                                   |
-| --------------------------------------------- | --------------- | ------------------------------------------- |
-| `Server=...; Database=...; UID=...; PWD=...;` | MSSQL           | tAPI over HTTPS, the same path Fui MCP uses |
-| `postgres://...`                              | Postgres        | direct, through `Bun.SQL`                   |
-| `mysql://...`, `mariadb://...`                | MySQL / MariaDB | direct, through `Bun.SQL`                   |
-| `sqlite://...`, `file:...`                    | SQLite          | direct, through `Bun.SQL`                   |
+## Database connections
 
 Secrets are read only from stdin (`-`) or from an env var (`--*-env VAR`):
 
 ```bash
-printf %s "$TOKEN" | fui db add docs -p lhu-docs --token - --api-domain tapi.lhu.edu.vn
+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 PG_URL
+fui db list
 ```
 
-## Development
+A connection is an MSSQL string (through tAPI) or a `postgres://`, `mysql://` or `sqlite://` URL.
+
+## Uninstall
 
 ```bash
-bun test
-bun run typecheck
-bun run lint
-bun run format:check
+bun remove -g @fui-org/fui-cli
 ```
+
+With npm: `npm uninstall -g @fui-org/fui-cli`.