CLI Reference

This page summarizes the collector CLI flags.

Command Shape

ms-teams-agent [--config <path>] [options]

The collector uses a single binary command style (no sub-commands).

Binary Names by OS

Linux: ms-teams-agent.bin
Windows: ms-teams-agent.exe

Global Flags

Flag	Purpose
`--version`	Print version and exit
`--config <path>`	Start continuous collection
`--ignore_state`	Run one cycle and ignore state file
`--call_id <ID>`	Process one call and exit
`--enable_boot_start`	Install as a Linux systemd service
`--disable_boot_start`	Remove the Linux systemd service
`--service_name_suffix=<suffix>`	Add suffix for named service instances
`--force_service_creation`	Replace an existing service with same name

# Print version
./ms-teams-agent.bin --version

# Start continuous collection
./ms-teams-agent.bin --config ./conf/config.yaml

# First run without previous state
./ms-teams-agent.bin --config ./conf/config.yaml --ignore_state

# Debug a single call
./ms-teams-agent.bin --config ./conf/config.yaml --call_id "<CALL_ID>"

# Print version
.\ms-teams-agent.exe --version

# Start continuous collection
.\ms-teams-agent.exe --config .\conf\config.yaml

# First run without previous state
.\ms-teams-agent.exe --config .\conf\config.yaml --ignore_state

# Debug a single call
.\ms-teams-agent.exe --config .\conf\config.yaml --call_id "<CALL_ID>"

Service Flags (Linux)

# Install and start service
sudo ./ms-teams-agent.bin --config /absolute/path/to/config.yaml --enable_boot_start

# Remove service
sudo ./ms-teams-agent.bin --config /absolute/path/to/config.yaml --disable_boot_start

# Named instance
sudo ./ms-teams-agent.bin --config /path/to/config-prod.yaml --enable_boot_start --service_name_suffix=-prod