CLI Reference

Use this page as a reference for collector global flags. The collector has no sub-commands.

Binary Names by OS

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

Command Shape

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

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

Core Execution Commands

Continuous collection

Linux

./ms-teams-agent.bin --config ./conf/config.yaml

Windows

.\ms-teams-agent.exe --config .\conf\config.yaml

Print version

Linux

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

Windows

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

State and Targeted Debug

Single cycle, ignore previous state

Linux

./ms-teams-agent.bin --config ./conf/config.yaml --ignore_state

Windows

.\ms-teams-agent.exe --config .\conf\config.yaml --ignore_state

Process one call ID

Linux

./ms-teams-agent.bin --config ./conf/config.yaml --call_id "<CALL_ID>"

Windows

.\ms-teams-agent.exe --config .\conf\config.yaml --call_id "<CALL_ID>"

Tip

Use --ignore_state for first validation and troubleshooting. Remove it for normal operations.

Service Flags (Linux)

Use absolute config paths for service actions.

# 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

# Replace an existing service with same name
sudo ./ms-teams-agent.bin --config /absolute/path/to/config.yaml --enable_boot_start --force_service_creation

For complete operational procedures, see Service Management.