@aifabrix/builder

中文文档
2.67.1发布于 2026/10/29MITCommonJS近 30 天下载 2672

AI Fabrix Builder — CLI and developer scripts (pnpm + af)

原始使用文档
文档目录11 节
  1. Why AI Fabrix Builder?
  2. Prerequisites
  3. Install the CLI
  4. Goal 1: Install the platform (one command)
  5. Dev vs pro installation (setup profile)
  6. Configure an LLM provider
  7. Goal 2: External system integration
  8. Goal 3: Build your own application
  9. Documentation
  10. Requirements
  11. License

AI Fabrix - Builder

npm version License: MIT

Open developer runtime for AI Fabrix ecosystem. Install the AI Fabrix platform and test it locally. Then add external integrations or build your own applications.

← Full documentation: docs/README.md (table of contents for all guides)

Contributor quick start (miso ↔ dataplane ↔ builder): QUICK-START.md


Why AI Fabrix Builder?

  • Build perspective: Everything is driven by declarative config and JSON schemas—no hidden logic, AI assistant–friendly.
  • Industry standards and security: Follow industry standards and high security (e.g. ISO 27k); no secrets in version control.
  • Full lifecycle in your version control: Configuration, apps, and integrations live in your own VCS (GitHub, GitLab, Azure DevOps).
  • One tool from day one: Single CLI for local infra, app and integration creation, build, run, and deploy—same workflow for apps and integrations.
  • Consistency and production readiness: Schema-driven; deploy apps and integrations to the same controller/dataplane; production-ready secrets with kv:// and Azure Key Vault.
  • Application development: Use miso-client (TypeScript and Python) to talk to the dataplane and controller. The repo includes both TypeScript and Python SDKs; see templates/applications/dataplane/README.md and the repo for usage.

Prerequisites

  • Node.js 22+ – Supported CLI floor; Node.js 24.22.1 is the recommended current runtime.
  • Docker Desktop – Full access to Docker (containers for infra and platform).
  • Secrets before platform: Add an AI tool key (OpenAI or Azure OpenAI) in setup or with aifabrix secret set before the platform needs them. See Infrastructure.

Install the CLI

npm install -g @aifabrix/builder

Alias: You can use af instead of aifabrix in any command.

Customer integration repositories can install the Agent Kit (Cursor, Codex, and Claude Code) with:

aifabrix agent-kit install

See Agent Kit commands.


Goal 1: Install the platform (one command)

Get Postgres, Redis, Keycloak, Miso Controller, and Dataplane running on your machine.

aifabrix setup

That is the whole story for most developers. The command detects whether infra is already running:

SituationWhat happens
Fresh machineShort wizard → pull images → up-infra → up-platform
Already installedMode menu (3 choices): re-install (destroys volumes), wipe data (DBs only), or update images (keeps data) — each path pulls fresh Docker images before restart

Grab a coffee — setup pulls infrastructure and platform images (a few minutes on first run or after image updates). When setup finishes, the CLI stores platform-controller in config.yaml (absolute Miso URL for your machine). Sign in with username admin and your admin password. If you were already logged in to that controller URL, setup keeps your session; otherwise it prompts for device login like a fresh install.

Controller URL: Local Docker without Traefik uses http://localhost: + port 3000 + developerId×100. With Traefik and remote-server, use the public URL shown in the Platform Ready footer (path /miso/*). See Infrastructure guide.

→ Step-by-step detail, ports, and dev / pro installation profiles: Infrastructure guide

Dev vs pro installation (setup profile)

These names match how we talk about environments elsewhere (dev, tst, pro). Here they mean how you install locally, not which cloud environment you deploy to later.

ProfileBest forAdmin emailAdmin passwords
dev (default)Local development, training, labsYou enter onceOne password for Postgres, pgAdmin, Keycloak, and platform login
proProduction-style or hardened installsSameAutogenerate strong passwords (shown once) or enter manually

Default: dev (one email, one password). Pro is available in the setup wizard or non-interactively:

aifabrix setup --installation pro --pro-password-mode autogen

Use --pro-password-mode manual to enter passwords yourself (one password for all roles, or separate infra / Keycloak / platform passwords via up-infra flags).

Admin credentials are stored in ~/.aifabrix/admin-secrets.env (encrypted when you configure a secrets encryption key). App and integration secrets stay in ~/.aifabrix/secrets.local.yaml.

Configure an LLM provider

aifabrix setup does not collect LLM credentials. Store the selected provider value under its standard address in your local or shared secrets store:

aifabrix secret set openai/apiKey <your-openai-secret-key> --shared

The same pattern applies to azure-openai/apiKey, azure-openai/endpoint, and anthropic/apiKey. When an integration manifest references the matching kv:// address, aifabrix upload resolves the value from local or shared storage and pushes it to the Dataplane without placing the value in the manifest. Miso onboarding can also configure these standard addresses directly.

Remove the platform completely: aifabrix teardown. Command details: Infrastructure commands.


Goal 2: External system integration

Create and deploy an external system (e.g. HubSpot): wizard or manual setup, then validate and deploy.

Example: HubSpot:

  • Create: aifabrix create hubspot-test (external is the default; or aifabrix wizard for guided setup). For a web app use aifabrix create my-app --type webapp.
  • Configure auth and datasources under integration/hubspot-test/.
  • Validate: aifabrix validate hubspot-test
  • Deploy: aifabrix deploy hubspot-test

→ External systems guide · Wizard


Goal 3: Build your own application

Create, configure, and run your own AI Fabrix application locally or deploy it (create app → configure → build → run / deploy).

→ Your own applications


Documentation

All guides and references are listed in docs/README.md (table of contents).


Requirements

  • Docker Desktop – For running containers
  • Node.js 22+ – Supported CLI floor; Node.js 24.22.1 is recommended
  • Azure CLI – For deploying to Azure (optional)

License

© eSystems Nordic Ltd 2026 - All Rights Reserved

@aifabrix/builder is part of the AI Fabrix platform.

版本与发布记录

@aifabrix/builder 共发布 118 个版本,首次发布于 2025/10/27;过去 12 个月发布了 103 个版本。

版本发布日期距今
2.67.1latest2026/10/299 天前
2.67.02026/10/2810 天前
2.66.02026/10/2315 天前
2.65.12026/10/1622 天前
2.64.32026/10/1226 天前
2.64.22026/10/1226 天前

关于 @aifabrix/builder 的常见问题

@aifabrix/builder 是什么?

AI Fabrix Builder — CLI and developer scripts (pnpm + af)

如何安装 @aifabrix/builder?

在项目目录运行 npm install @aifabrix/builder,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 af、aifabrix,可以用 npx af 直接运行。

@aifabrix/builder 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/aifabrix__builder 是否存在。

@aifabrix/builder 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@aifabrix/builder 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aifabrix/builder 可以商用吗?

@aifabrix/builder 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aifabrix/builder 的下载量有多少?

根据 npm 官方下载统计,@aifabrix/builder 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,672 次,日均约 89 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aifabrix/builder 还在维护吗?

最新版本 2.67.1 发布于 2026/10/29(9 天前);至今共发布 118 个版本,其中过去 12 个月发布了 103 个;首次发布于 2025/10/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。