Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
CLI commands for Flock synthetic population generation: connect to a database, learn distributions, generate a population, and seed the data.
flock is a Pro command delivered through the Flock desktop app, not the free community CLI. If you installed only dotnet tool install --global Pidgeon.CLI, the flock subcommand is not present. It requires a Pidgeon account sign-in.pidgeon flock connect --provider <type> --connection <str>
| Flag | Type | Default | Description |
|---|---|---|---|
--provider <type> | string | postgres | Database provider: postgres, sqlserver, mysql |
--connection <str> | string | required | Database connection string |
pidgeon flock connect \
--provider postgres \
--connection "Host=localhost;Port=5432;Database=ehr;Username=dev;Password=${DB_PASSWORD}"
mysql provider; postgresql and mssql are accepted as aliases.pidgeon flock schema [--classify] [--visualize]
| Flag | Type | Default | Description |
|---|---|---|---|
--classify | flag | false | Classify tables by healthcare domain |
--visualize | flag | false | Emit the schema as a Mermaid ER diagram |
pidgeon flock learn [--sample <n>]
| Flag | Type | Default | Description |
|---|---|---|---|
--sample <n> | int | 500 | Number of rows to sample per table |
pidgeon flock learn --sample 500
pidgeon flock generate [options]
| Flag | Type | Default | Description |
|---|---|---|---|
--count, -c <n> | int | 100 | Number of patients to generate |
--format, -f <fmt> | string | sql | Output format: sql, csv, hl7, fhir, pas-bundle |
--schema <path> | string | optional | Path to a SQL DDL or JSON schema |
--state <abbr> | string | optional | State abbreviation for geographic focus (for example TX, CA) |
--seed <n> | int | random | Seed for reproducible output |
--profile <name> | string | optional | Use a learned data profile |
--output, -o <path> | string | stdout | Output directory for generated files |
--from-config <name> | string | optional | Run a saved population config (supersedes --count / --format / --state / --seed / --profile) |
# Generate 1000 patients as SQL
pidgeon flock generate --count 1000 --format sql --output ./seed-data/
# Generate as FHIR Bundles
pidgeon flock generate --count 500 --format fhir --output ./fhir-data/
# Reproducible output
pidgeon flock generate --count 1000 --format csv --seed 42
pidgeon flock seed --target <type> --connection <str> [options]
| Flag | Type | Default | Description |
|---|---|---|---|
--target <type> | string | postgres | Database provider: postgres, sqlserver, mysql |
--connection <str> | string | required | Target database connection string |
--dry-run | flag | false | Generate SQL without executing |
--from <path> | string | optional | Seed records written by flock generate -o instead of the in-process job |
# Preview what would be inserted
pidgeon flock seed --target postgres --connection "Host=localhost;Database=ehr;..." --dry-run
# Seed from a directory that generate wrote
pidgeon flock seed --target postgres --connection "Host=localhost;Database=ehr;..." --from ./seed-data/
pidgeon flock cleanup --provider <type> --connection <str>
| Flag | Type | Default | Description |
|---|---|---|---|
--connection <str> | string | required | Target database connection string |
--provider <type> | string | postgres | Database provider |
pidgeon flock cleanup --provider postgres --connection "Host=localhost;Database=ehr;..."
pidgeon flock status