Get Started with the edgesoftware CLI

Use the information in this section to try out the edgesoftware CLI commands.

To begin:

1. Open a terminal window.
2. Go to the edge_insights_vision/ directory.
3. Try out the following commands.

Get Help or List the Available Commands

• Command:

  ./edgesoftware --help

• Response:

  Usage: edgesoftware [OPTIONS] COMMAND [ARGS]...
  A CLI wrapper for management of Intel® Edge Software Hub packages
  
  Options:
    -v, --version   Show the version number and exit.
    ––help          Show this message and exit.
  
  Commands:
    download  Download modules of a package.
    export    Exports the modules of a package.
    install   Install modules of a package.
    list      List the modules of a package.
    log       Show log of CLI events.
    pull      Pull Docker image.
    uninstall Uninstall the modules of a package.
    update    Update the modules of a package.
    upgrade   Upgrade a package.
  

View the Software Version

• Command:

  ./edgesoftware --version

• Response: The edgesoftware version, build date, and target OS.

List the Package Modules

• Command:

  ./edgesoftware list

• Response: The modules installed and status.
  
  
  

List Modules Available for Download

• Command:

  ./edgesoftware list --default

• Response: All modules available for download for that package version, modules ID and version.
  
  
  

Display the CLI Event Log

• Command:

  ./edgesoftware log

• Response: CLI event log information, such as:
  • target system information (hardware and software)
  • system health
  • installation status
  • modules you can install
  
  
  

See the Installation Event Log for a Module

• Command:

  ./edgesoftware log <MODULE_NAME>

  You can specify multiple <MODULE_NAME> arguments by listing them with a space between each.

  NOTE:

  To find the module names, use

  ./edgesoftware list

• Response: The installation log for the module.
  
  
  

Uninstall the Module

The edgesoftware CLI lets you uninstall individual modules.

Command:

./edgesoftware uninstall <Module-ID>

Uninstall the Package

The edgesoftware CLI lets you uninstall the package.

Command:

./edgesoftware uninstall -a

Upgrade the Package

The edgesoftware CLI lets you upgrade the package. To check the available package for installation, use the command:

upgrade /edgesoftware <PACKAGE_ID>

During the upgrade process, the current package is uninstalled completely, and the new package gets installed.

Command:

./edgesoftware list –v

./edgesoftware upgrade <PACKAGE_ID>

Summary and Next Steps

By following this guide, you tried a few commands to familiarize yourself with the features of the edgesoftware CLI.

Go to Single and Multi-object Detection with Hardware Acceleration to run your first inference application using Edge Insights for Vision.

Go to Intel® Edge Software Configurator Documentation to learn how to use the tool to manage Edge Software Packages, create and manage Containers and Virtual Machines.