Command-Line Interface (CLI)

Using the behaviorsim command-line tool for validation and batch simulation.

BehaviorSim provides a native CLI tool executable as behaviorsim.

Overview

terminal

behaviorsim --help

1. behaviorsim validate

Validates a YAML or JSON configuration file against the schema before execution:

terminal

behaviorsim validate config.yaml

2. behaviorsim run

Executes a simulation from a configuration file and outputs results to stdout or a file:

terminal

# Output to CSV
behaviorsim run config.yaml -o traces.csv --interactions 100 --seed 42

# Output to Apache Parquet
behaviorsim run config.yaml -o traces.parquet --sequences 50

Execution Flags

Flag	Short	Description
--output	-o	Target file path (.csv, .json, or .parquet). Default: stdout
--seed	-	Override RNG seed integer
--interactions	-	Number of interaction steps per sequence
--sequences	-	Number of sequences to generate
--profile	-	Target single profile override

Configuration File Example

simulation.yaml

# simulation.yaml
seed: 42
states:
  - name: "Active"
    description: "Engaged user"
  - name: "Idle"
    description: "Passive user"
distributions:
  - state: "Active"
    feature: "action_count"
    distribution: "poisson"
    params:
      lam: 6.0

PreviousPython API Reference

NextREST API Overview