AIWIZE Combiner CLI

The AIWIZE Combiner CLI (aiwize-combiner-cli) is a powerful development tool for building and debugging vertical AI agents (modules) for the AIWIZE Browser ecosystem. It provides essential utilities for local development, module bootstrapping, and running a development backend server.

🚀 Quick Start

# Install the CLI globally
npm install -g aiwize-combiner-cli

# Bootstrap a new module project
aiwize-combiner-cli bootstrap my-module

# Start the development backend server
aiwize-combiner-cli start

🛠️ Key Features

• Module Bootstrapping: Quickly create new AIWIZE modules with proper structure and dependencies
• Self-contained Development Backend: The CLI bundles a pre-built version of the AIWIZE Combiner backend so you can run it instantly — no separate checkout or build necessary.
• Project Templates: Generate modules from multiple templates (e.g., base, aiwize-simple, aiwize-chat) using the new --template flag
• Flexible Port Management: Defaults to port 22003 (the port used by the browser) but can be overridden with --port.

📋 Commands

bootstrap [name]

Creates a new AIWIZE module project by cloning the official module template.

aiwize-combiner-cli bootstrap [name]

If you don't provide the module name as an argument, the CLI will prompt you to enter one.

Optional flags:

• --path <directory>: Directory where the new module should be created (defaults to the current working directory)
• --skip-name: Clone the template into a sub-folder called app without renaming anything (keeps original package.json, manifest.json, and git branch names)
• --template <template>: Which template to use. Currently available:
  • simple (default) → module-example-aiwize-simple branch
  • aiwize-simple (alias of simple) → module-example-aiwize-simple branch
  • aiwize-chat → module-example-aiwize-chat branch
  • base → main branch

If you omit --template, the CLI defaults to the simple template.

This command (without --skip-name):

• Creates a new directory named after your module
• Clones the official AIWIZE browser module template into that directory
• Updates package.json → name field to your module name
• Updates manifest.json → id field to your module name
• Renames the default git branch to your module name

When --skip-name is used the CLI skips the rename steps above and simply clones the selected template into an app directory.

start

Launches the self-contained backend server packaged with the CLI.

This command:

• Sets MODULES_PATH to the directory where you execute the command, so the backend can discover your local modules automatically.
• Starts the server on port 22003 by default (override with --port).
• Streams all logs directly to your terminal.

# default port 22003
aiwize-combiner-cli start

# custom port
aiwize-combiner-cli start --port 3000

Tip: Make sure the chosen port is free so the AIWIZE Browser can connect to your development backend.

🔄 Development Workflow

1. Create New Module

   aiwize-combiner-cli bootstrap my-module
   cd my-module

2. Install Dependencies

   npm install

3. Start Development Backend

   aiwize-combiner-cli start

4. Launch AIWIZE Browser

   • The browser will automatically detect and connect to your development backend
   • Your module will be loaded in the browser's panel system

📦 Template Repository

All templates live in a single GitHub repository but on different branches. The CLI clones the correct branch automatically:

| Template name | Git branch | Description | | ------------- | ---------- | ----------- | | base | main | Minimal starting point | | aiwize-simple / simple | module-example-aiwize-simple | Opinionated starter with examples | | aiwize-chat | module-example-aiwize-chat | Chat-oriented starter |

Repository: module-example

🤝 Contributing

We welcome contributions! Please check our contribution guidelines for details on how to submit pull requests, report issues, and contribute to the project.

📝 License

MIT License - see the LICENSE file for details.