Quickstart Guide

Orchestrate Intelligence.
Ship Faster.

Get a working pipeline up and running in 10 minutes with the BotMatrix CLI. Copy, paste, deploy.

Read the Docs →
BotMatrix CLI terminal session showing successful deployment Terminal View

Prerequisites

Before you begin, ensure you have the following installed locally on your machine:

  • Node.js Version 18 or higher (LTS). You can verify this by running node --version in your terminal.
  • BotMatrix CLI The command-line interface for managing your pipelines.
  • Free Account A BotMatrix account to host your pipeline. Sign up at botmatrix.com/signup.

Build Your First Pipeline

Step 1: Install the CLI

If you haven't already, install the BotMatrix CLI globally via npm: 

npm install -g @botmatrix/cli

Step 2: Initialize a Project

Create a new directory and initialize your first pipeline using the init command: 

botmatrix init my-first-bot

Select Node.js Runtime when prompted. This scaffolds a project structure with a triggers.yaml and src/index.ts.

Step 3: Define a Trigger

Open triggers.yaml and add a cron trigger to run your bot every 5 minutes: 

triggers:
  - id: daily_summary
    type: cron
    schedule: '*/5 * * * *'

Step 4: Write the Handler

Edit src/index.ts. Here is a simple handler that returns a greeting: 

import { BotMatrix } from '@botmatrix/sdk';

export default async handler (ctx) => {
  const timestamp = new Date().toISOString();
  
  return {
    status: 'success',
    message: `Hello, world! Timestamp: ${timestamp}`
  };
};

Step 5: Deploy

Go to your project root and deploy to production: 

botmatrix deploy --env production

You will see a success message confirming your pipeline is live. You can verify execution logs in the BotMatrix Dashboard.

What to Read Next

Managing Secrets → Chaining Pipeline Steps → Setting Up Alerting →