CLI

The Xentom CLI is a powerful command-line interface that provides complete control over your Xentom installation, workflow management, and deployment processes. It's designed to integrate seamlessly into your development workflow and automation pipelines.

Overview

The Xentom CLI offers a comprehensive set of commands for:

Server Management - Start, stop, and configure your Xentom instance
Workflow Operations - Create, test, and deploy workflows from the command line
Integration Management - Install and configure integrations
Project Scaffolding - Generate boilerplate code and configurations
Deployment - Deploy workflows to production environments

Core Commands

Server Management

# Start the Xentom server
xentom start

# Start with custom configuration
xentom start --port 8080 --host 0.0.0.0

# Stop the server
xentom stop

# Check server status
xentom status

Workflow Commands

# List all workflows
xentom workflow list

# Create a new workflow
xentom workflow create my-workflow

# Run a specific workflow
xentom workflow run my-workflow

# Test a workflow without executing actions
xentom workflow test my-workflow

# Deploy a workflow
xentom workflow deploy my-workflow

Integration Management

# List available integrations
xentom integration list

# Install an integration
xentom integration install email-provider

# Configure integration settings
xentom integration configure email-provider

# Update integrations
xentom integration update

Project Management

# Initialize a new Xentom project
xentom init

Configuration

The CLI can be configured through various methods:

Configuration File

Create a .xentom.yml file in your project root:

server:
  port: 3000
  host: localhost

database:
  url: postgresql://localhost:5432/xentom

integrations:
  - name: email
    enabled: true
  - name: storage
    enabled: false

Environment Variables

Set configuration through environment variables:

export XENTOM_PORT=3000
export XENTOM_HOST=localhost
export XENTOM_DATABASE_URL=postgresql://localhost:5432/xentom

Command Line Flags

Override configuration with command-line flags:

xentom start --port 8080 --database-url postgresql://localhost:5432/xentom

Advanced Usage

Automation Scripts

The CLI is designed to work well in scripts and CI/CD pipelines:

#!/bin/bash
# Deploy script example

# Validate workflows
xentom validate || exit 1

# Run tests
xentom workflow test --all || exit 1

# Deploy to production
xentom workflow deploy --environment production

Development Workflow

Common development patterns:

# Start development server with hot reload
xentom start --dev --watch

# Create and test a new workflow
xentom workflow create user-onboarding
xentom workflow test user-onboarding
xentom workflow deploy user-onboarding --environment staging

Global Options

These options are available for most commands:

--verbose, -v - Enable verbose output
--quiet, -q - Suppress non-essential output
--config - Specify custom configuration file
--help, -h - Show help information

Getting Help

For detailed information about any command:

# General help
xentom --help

# Command-specific help
xentom workflow --help
xentom start --help

The CLI also includes built-in documentation and examples for each command, making it easy to discover and learn new features as you work.

On this page