Skip to main content

Quick Start Guide

Get your AI-powered workflow up and running in minutes with KaibanJS!

Try it Out in the Playground!

Before diving into the installation and coding, why not experiment directly with our interactive playground? Try it now!

Quick Demo​

Watch this 1-minute video to see KaibanJS in action:

Prerequisites​

  • Node.js (v14 or later) and npm (v6 or later)
  • An API key for OpenAI or Anthropic, Google AI, or another supported AI service.

Setup​

1. Run the KaibanJS initializer in your project directory:

npx kaibanjs@latest init

This command sets up KaibanJS in your project and opens the Kaiban Board in your browser.

2. Set up your API key:

  • Create or edit the .env file in your project root
  • Add your API key (example for OpenAI):
VITE_OPENAI_API_KEY=your-api-key-here

3. Restart your Kaiban Board:

npm run kaiban

Using Your Kaiban Board​

  1. In the Kaiban Board, you'll see a default example workflow.

  2. Click "Start Workflow" to run the example and see KaibanJS in action.

  3. Observe how agents complete tasks in real-time on the Task Board.

  4. Check the Results Overview for the final output.

Customizing Your Workflow​

  1. Open team.kban.js in your project root.

  2. Modify the agents and tasks to fit your needs. For example:

    import { Agent, Task, Team } from 'kaibanjs';

    const researcher = new Agent({
      name: 'Researcher',
      role: 'Information Gatherer',
      goal: 'Find latest info on AI developments'
    });

    const writer = new Agent({
      name: 'Writer',
      role: 'Content Creator',
      goal: 'Summarize research findings'
    });

    const researchTask = new Task({
      description: 'Research recent breakthroughs in AI',
      agent: researcher
    });

    const writeTask = new Task({
      description: 'Write a summary of AI breakthroughs',
      agent: writer
    });

    const team = new Team({
      name: 'AI Research Team',
      agents: [researcher, writer],
      tasks: [researchTask, writeTask]
    });

    export default team;

  3. Save your changes and the Kaiban Board will automatically reload to see your custom workflow in action.

Deploying Your Kaiban Board​

To share your Kaiban Board online:

  1. Run the deployment command:
npm run kaiban:deploy

  1. Follow the prompts to deploy your board to Vercel.

  2. Once deployed, you'll receive a URL where your Kaiban Board is accessible online.

This allows you to share your AI-powered workflows with team members or clients, enabling collaborative work on complex tasks.

Quick Tips​

  • Use npm run kaiban to start your Kaiban Board anytime.
  • Press Ctrl+C in the terminal to stop the Kaiban Board.
  • Click "Share Team" in the Kaiban Board to generate a shareable link.

Flexible Integration​

KaibanJS isn't limited to the Kaiban Board. You can integrate it directly into your projects, create custom UIs, or run agents without a UI. Explore our tutorials for React and Node.js integration to unleash the full potential of KaibanJS in various development contexts.

Next Steps​

  • Experiment with different agent and task combinations.
  • Try integrating KaibanJS into your existing projects.
  • Check out the full documentation for advanced features.

For more help or to connect with the community, visit kaibanjs.com.

We Love Feedback!

Is there something unclear or quirky in the docs? Maybe you have a suggestion or spotted an issue? Help us refine and enhance our documentation by submitting an issue on GitHub. We're all ears!