Introduction

Latest CLI Version

The latest CLI release version: Latest Release

Using the CLI

Setting-up of Executable File

  • Extraction of file from a compressed file format

    In Linux:

    • There are multiple ways to extract a file from a compressed file. Here are the step-by-step instructions:

    • First method:

      1. Point the cursor on the compressed file.
      2. Right-click on it to trigger the context-menu (right-click menu).
      3. On the context menu select the Extract Here option to extract the file in the same directory or
        Select the Extract to option in order to extract the file into the current directory or directory of your choice.
    • Second method:

      1. Point the cursor on the compressed file.
      2. Left-Double-click on it to trigger a window that shows the extraction option.
      3. Select the Extract button to extract the file into the desired directory.
    • Third method:

      1. Open the terminal in the directory where the compressed file is stored.
      2. Type in the terminal command unzip een.zip to extract the file in the current directory.
      unzip een.zip
      

    In Windows:

    • Here are the step-by-step instructions:
      1. Point the cursor on the compressed file.
      2. Right-click on it to trigger context-menu(right-click menu).
      3. On the context menu select Extract All.
      4. A window is triggered that shows an input box which is used to insert the directory path to a chosen directory.
      5. After choosing a directory click on the Extract button, to extract the file to the chosen directory.

Notes:

  • For all commands with --no-prompt option it will skip all user confirmation prompts. This means it will also overwrite any existing files without any confirmation.

  • Open all the CSV file outputs in Google Sheets or Libre Office as Excel has formatting issues.

  • verbose mode : Use --verbose along with the commands to access the verbose mode.

  • Supported EEN TIME FORMATS :

    • 20230125062511.000
    • 2023-01-31
    • 2023-01-31T08:24:32
    • 2023-10-02T23:50:06.337+00:00
  • Execute this extracted file by mapping up the directory path of the een
    on the terminal

  • Each command should start ./.

    Examples:

    ./een --version
    
  • To check if the executable works fine

    • Run the command:
     ./een
    
    • Output:
    v<version number>
    
      usage: een [-v | --version] [-h | --help] <object> <command> [<args>]
    
      These are common een commands used in various situations:
    
      auth login              login to the account
      auth logout             logout of the account
    
      camera list             list all cameras
      camera status           list status of all cameras
    
      bridge list             list all bridges
      bridge availability     get bridge availability
    
      'een help' lists all the commands and options
      'een <command> help' lists the usage with options and descriptions
    

EEN Command Line Interface Manual

NAME

een - A command-line tool for managing and retrieving information related to cameras, bridges, users, and more in a cloud-based environment.

SYNOPSIS

een [OPTIONS] <object> <command> [ARGS]

DESCRIPTION

The een CLI provides various commands to interact with cameras, bridges, users, sites, and other resources. It offers multiple options for fetching information in different formats (CSV, tree structure, etc.) and supports both standard and v1 APIs.

Options:

  • --help, -h
    Displays the help information for the een command or a specific object.

  • --version
    Displays the current version of the een CLI.

COMMANDS

Version

een --version

Displays the version of the een tool.

Help

een help

Shows detailed help instructions. For shorter help on a specific object, use:

een <object> --help

EXAMPLES

een help
een --help
een -h
een auth --help
een camera list --help