Reference · Displai
DeepSight Toolkit command-line arguments for Windows
Look up the command-line arguments for launching DeepSight Toolkit on Windows, picking a video source, and running it at startup.
When to use this
Section titled “When to use this”Use this reference when you need to launch the DeepSight Toolkit from the command line on Windows, automate multiple instances at startup, or configure camera sources programmatically.
Command syntax
Section titled “Command syntax”The full command structure is:
DeepSight-Toolkit [--file <videofile> | --capture <camera-id> | --stream <stream-url>] --camera-name <camera-name> [--deepsight-license] <key> --config-path <config-dir> [--hide] [--auto-play]Required arguments
Section titled “Required arguments”You must provide at least one video source and a camera name:
| Argument | Description |
|---|---|
--capture <camera-id> | Numeric ID of the camera to capture. The first detected camera (e.g., built-in laptop camera) is ID 0, the second is ID 1, and so on. |
--file <videofile> | Full path to a video file to analyze. |
--stream <stream-url> | RTSP URL of a video stream to analyze, such as one from an IP camera. |
--camera-name <camera-name> | A name you assign to your camera to help identify it in reports. |
Optional arguments
Section titled “Optional arguments”| Argument | Description |
|---|---|
--deepsight-license <license-key> | Your DeepSight Toolkit license key. |
--config-path <config-dir> | The directory where the settings file and log files are stored. You must have write permissions for this location. A warning appears if permissions are missing or the path is invalid. |
--hide | Hides the interface; the Toolkit runs in the background. |
--auto-play | Automatically starts analyzing when launched. |
--help (or -?, -h) | Displays command-line argument options. |
--version (or -v) | Displays Toolkit version information. |
Examples
Section titled “Examples”Capture from the first detected camera:
DeepSight-Toolkit --capture 0 --camera-name "Lobby Camera" --deepsight-license YOUR_KEY --config-path "C:\DeepSight\Config"Analyze a video file:
DeepSight-Toolkit --file "C:\Videos\sample.mp4" --camera-name "Sample Video" --config-path "C:\DeepSight\Config"Stream from an RTSP camera in the background:
DeepSight-Toolkit --stream "rtsp://192.168.1.100:554/stream" --camera-name "Front Entrance" --hide --auto-play --config-path "C:\DeepSight\Config"Autorun at startup
Section titled “Autorun at startup”An example autorun.bat script is provided with the Toolkit. You can use command-line arguments to auto-start multiple instances when your machine launches.
Place your batch script in the Windows Startup folder or configure it as a scheduled task to run at login.
Verify
Section titled “Verify”- Run your command in a Windows command prompt or PowerShell.
- If using
--hide, check Task Manager for theDeepSight-Toolkitprocess. - Verify that log files appear in the directory specified by
--config-path. - If using
--auto-play, confirm that analysis starts immediately without manual intervention.
If it doesn’t work
Section titled “If it doesn’t work”Warning dialog about write permissions or invalid path:
- Ensure the account running the Toolkit has write access to the
--config-pathdirectory. - Use a directory outside system-protected folders (e.g., avoid
C:\Program Files).
Camera not detected (wrong camera-id):
- Built-in laptop cameras are typically ID 0. External USB cameras are assigned IDs 1, 2, etc., in the order they were connected.
- Disconnect other cameras, then reconnect the desired camera to ensure it receives ID 0.
License key not accepted:
- Verify your key has no extra spaces or characters.
- If the issue persists, escalate to support for license validation.
RTSP stream fails to connect:
- Confirm the RTSP URL is correct and accessible from the machine.
- Check firewall rules and network connectivity.
Related articles
Section titled “Related articles”- Run multiple instances of DeepSight Toolkit on Windows Run a separate DeepSight Toolkit instance for each camera on one Windows machine by adding a line per camera to start.bat.
- DeepSight Toolkit resources and getting started guide Follow the five-step DeepSight Toolkit trial flow, from download and installation to sample video testing and CMS integration.
- DeepSight Toolkit license types (Sightcorp) Compare DeepSight Toolkit’s time-based and session-based licenses, including when each one needs an internet connection.
Still having trouble?
Text the 24/7 line or email support.