📁 Configuration & CLI Usage

Allsafe-flow lets you define and manage your development services using a simple YAML configuration file. Each service can be started, stopped, or restarted individually or all at once — with color-coded logs, environment variable support, and optional health checks.

First, install Allsafe-flow globally to use the CLI anywhere on your system:

npm install -g allsafe-flow

Below is an example configuration and a full list of CLI commands.

📄 Example Configuration (devflow.config.yaml)

You can generate this file using:

allsafe-flow init

Then edit it like so:

# Allsafe-flow Configuration
# This is a sample configuration file

services:
  - name: frontend
    command: npm run dirt-dev
    #cwd: ./frontend
    #healthCheck: http://localhost:3000
    color: green
    # env:  # Uncomment to add environment variables
    #   PORT: 3000

  - name: backend
    command: python manage.py runserver
    #cwd: ./backend
    #healthCheck: http://localhost:8000/health
    color: blue

📝 Config Field Descriptions

• name: Unique name for the service
• command: Command to run the service
• cwd (optional): Directory to run the command in
• healthCheck (optional): URL to check if the service is healthy
• color: Log color for the service output (green, blue, yellow, etc.)
• env (optional): Environment variables passed to the service

🧾 Command Line Reference

| Command | Description | Example | | ----------------------------- | ---------------------------------------------------------------- | ------------------------------ | | allsafe-flow start | Start all configured services | allsafe-flow start | | allsafe-flow start <name> | Start a specific service by name | allsafe-flow start backend | | allsafe-flow stop | Stop all running services | allsafe-flow stop | | allsafe-flow stop <name> | Stop a specific running service | allsafe-flow stop frontend | | allsafe-flow restart | Restart all services | allsafe-flow restart | | allsafe-flow restart <name> | Restart a specific service | allsafe-flow restart backend | | allsafe-flow status | Show the status of all running services | allsafe-flow status | | allsafe-flow status <name> | Show the status of a specific running service | allsafe-flow status frontend | | allsafe-flow init | Create a sample devflow.config.yaml file in the current folder | allsafe-flow init | | allsafe-flow --help | Display help menu | allsafe-flow --help | | allsafe-flow --version | Show the current version | allsafe-flow --version |