Eagle Eye Network’s CLI Tool For Enterprise Accounts
2025-10-01
Version 1.0
The Eagle Eye Networks Command Line Interface (CLI) is engineered for our most technical users who demand speed, precision, and efficiency at scale. This tool is the workhorse for System Integrators, IT Administrators, and Developers, enabling them to bypass the typical web interface limitations. It allows an authorized user to instantly manage an entire account by scripting complex operations, from bulk configuring hundreds of camera settings and automating video retrieval to executing fleet-wide health diagnostics and troubleshooting. The CLI transforms complex, repetitive tasks into seamless automation, ensuring maximum operational efficiency across large deployments. Please note that this powerful feature is exclusively available to accounts utilizing the Enterprise Edition.
Bulk System Edits & Management
Perform mass configuration updates (e.g. changing resolution on 50 cameras), bulk user management, and automated firmware updates across all devices.
Bulk Downloads & Data Retrieval
Script video downloads based on specific events or time ranges, and retrieve comprehensive system logs for debugging purposes.
Bulk Troubleshooting & Health Diagnostics
Instantly check the health/status (CPU, memory, uptime) of an entire fleet of bridges and cameras, and output results into filterable formats like CSV.
Follow the steps in this section to set up the CLI tool initially.
There are multiple ways to extract the file from the compressed (.zip) format:
Context Menu (GUI Method 1): Right-click the compressed file and select Extract Here (to extract to the same directory) or Extract to (to select a new directory).
Double-Click (GUI Method 2): Double-click the compressed file to open a window, and select the Extract button to choose the desired directory.
Terminal (CLI Method): Open the terminal in the directory where the compressed file is stored and run
Right-click on the compressed file.
Select Extract All from the context menu.
A window will prompt you to insert or confirm the directory path where you want the file extracted.
Click the Extract button to complete the process.
Once the executable file (een) is extracted, you must map its directory path in your terminal. All subsequent commands must be prefixed with ./ to run the local executable.
Navigate to the directory containing the extracted (een) file.
Run the following command to check if the executable is working correctly:
./een --version
If successful, the output should display the current version number, confirming your setup is complete.
CSV Outputs: Open all CSV file outputs in Google Sheets or Libre Office, as Excel has known formatting issues.
For help on setting up EEN’s CLI command line tool, and further information, please visit our developer portal
This section contains an overview of the syntax used in the Eagle Eye Networks’ CLI tool. It follows a simple structure:
./een <object> <command> <arguments>
NOTE: You must remove “<’ & “>’ after inserting your value in the designated placeholders when entering your CLI commands.
Syntax: Every command must begin with the executable file: ./een
Help: Use the built-in help function to explore specific commands:
For general help: ./een help
For help on a specific object (e.g., cameras): ./een camera --help
No Prompt: To run commands that typically require a confirmation (e.g., a deletion), you can use the --no-prompt option. Be careful, as this will overwrite or execute without confirmation.
Verbosity: For detailed output, use the --verbose flag along with your command.
Time Format: When specifying times (like for downloads), ensure you use a supported format, such as YYYYMMDDHHMMSS.000 or YYYY-MM-DDTHH:MM:SS
For additional commands, refer to our developer portal
Creating and running a custom script involves structuring your commands, saving them in a script file, and granting the file permission to execute.
Ensure your environment is set up and authenticate the executable before running the script.
Authenticate (Manual): Before executing any script, you must manually authenticate the CLI session in your terminal by running the login command:
Bash
./een auth login
2. Test Commands: Write and test each command line individually to ensure the syntax is correct and the desired output is achieved. Every EEN command must start with ./een.
Bash
# Example command to test
./een camera status --verbose --format csv
You will use a simple text file (e.g., a .sh file for Unix/Linux or a .bat file for Windows) to contain your sequence of EEN commands.
Open Editor: Use any text editor (like Nano, VS Code, or Notepad).
Add Commands: Paste your sequence of commands into the file. Remember to use the --no-prompt flag if the script must automatically confirm potentially destructive actions (like overwrites).
Example Script (Save as daily_reports.sh):
Bash
#!/bin/bash
# 1. Check bridge status and save data to a unique CSV file
./een bridge list --verbose --format csv > /tmp/bridge_status_$(date +%Y%m%d).csv
# 2. Get the current status for all cameras
./een camera status
# 3. Pull all archives created in the last 24 hours
./een media archives list --since 24h
On Unix-like systems, you must grant the file permission to be run as a program. This step can be skipped on Windows.
Change Directory (if necessary): Navigate to the folder where you saved your script file.
Bash
cd /path/to/your/script/folder
Grant Permission: Use the chmod command.
Bash
chmod +x daily_reports.sh
Once permissions are set, you can run the custom script manually or schedule it for future automation.
Run Manually: Execute the script using the executable prefix (./).
Bash
./daily_reports.sh
Automate (Schedule): Integrate this executable script with your system's scheduler (e.g., cron on Linux/macOS or Task Scheduler on Windows) to run unattended at specific intervals.
Crucial Note for Automations: When scheduling, ensure the user account running the script has a valid, active EEN CLI session token (obtained from the initial auth login step) to avoid authentication errors