create-ai-portal

Create a new AI-Portal project with one command — like create-react-app or create-strapi-app.

AI-Portal is a self-hosted AI operations platform: chat, virtual assistants, RAG, multi-Agent. Configure via /setup and Admin; no .env file required by default.

• Repo: Lampx83/AI-Portal
• Docs & website: ai-portal-nine.vercel.app — hướng dẫn, tài liệu
• npm: create-ai-portal

Usage

npx create-ai-portal@latest

Creates an ai-portal-app folder in the current directory (or prompts for a folder name).

Or specify a folder name:

npx create-ai-portal@latest my-portal

The CLI will:

1. Download the latest AI-Portal from GitHub.
2. Extract it into your chosen folder (the create-ai-portal folder is omitted from the scaffold).
3. Ask whether to run Docker now; if yes, runs docker compose up -d.

When done, open http://localhost:3000 → /setup to complete first-time configuration.

After creating the project

1. http://localhost:3000 → redirects to /setup.
2. Step 1 — Language: Choose default language (vi, en, …).
3. Step 2 — Branding: Enter app name and upload logo (icon).
4. Step 3 — Database: Confirm or change Postgres database name, then run init.
5. Step 4 — Admin: Create the first admin account.
6. Step 5 — Central assistant: Configure LLM for Central (OpenAI / Gemini) or skip.

The rest (NEXTAUTH_SECRET, Azure AD, OpenAI key, Qdrant, locale packages, …) is configured in Admin → System settings (Settings). Values are stored in the database.

Adding Agents: Deploy your Agent API (see frontend/docs/README.md), then in Admin → Agents add alias + base URL. Adding applications: Follow the standard (GET /metadata) and add in Admin → Applications (see docs/APPLICATIONS.md).

Requirements

• Node.js 18+ — to run npx create-ai-portal.
• Docker & Docker Compose — to run the full stack (PostgreSQL, Qdrant, backend, frontend).

If you skip Docker when creating the project, run later:

cd <folder-name>
docker compose up -d

Publishing to npm

1. Đăng nhập npm (nếu chưa):

   npm login

   Nhập username, password, email và OTP (nếu bật 2FA).

2. Vào thư mục gói và publish:

   cd packages/cli/create-ai-portal
   npm publish

   Script prepublishOnly trong package.json sẽ tự tăng patch version (ví dụ 1.0.20 → 1.0.21) trước khi publish.

3. Publish với quyền public (gói scoped hoặc lần đầu):

   npm publish --access public

Sau khi publish, người dùng có thể chạy:

npx create-ai-portal@latest

More information

• Docs & website: ai-portal-nine.vercel.app — hướng dẫn, tài liệu đầy đủ.
• Vision & features: VISION.md in the AI-Portal repo.
• Developer guide: docs/DEVELOPERS.md.