Development Computer Setup

Install the CLI

The first step to using the alwaysAI platform is to get your development computer set up with the alwaysAI Command-Line Interface (CLI). Choose your operating system below to get started:

The alwaysAI desktop software includes everything you need to create alwaysAI computer vision applications on your development host.

To verify that the alwaysAI CLI is fully installed and accessible, run:

$ aai -v

This should print a version string like 0.4.4.

Note: If you are following the Real-time Object Detector starter application guide and want to deploy to your local machine, you can skip the rest of these steps and head over to Get a Real-time Object Detector Running.

OpenSSH

Note: You can skip this step if you don’t plan to deploy to a remote device.

OpenSSH is a suite of secure networking utilities based on the Secure Shell (SSH) protocol. The alwaysAI CLI relies on OpenSSH for connecting to your edge device and related tasks like key generation. To check if your computer has OpenSSH installed already, open a terminal and enter:

$ ssh -V

This should print a version string like OpenSSH_7.9p1, LibreSSL 2.7.3. As of late 2018, Windows 10 supports OpenSSH out of the box. Check out this article on the Microsoft docs site for more information on installing OpenSSH on Windows.

Node.js

Node.js is an open-source cross-platform JavaScript run-time environment. To check if your development computer has Node.js installed already, open a terminal and enter:

$ node -v

This should print a version string like v12.5.0. The alwaysAI CLI requires Node.js v8.0.0 or greater. Node.js ships with npm, a package manager that we’ll use to install the alwaysAI CLI.

To install Node.js, visit https://nodejs.org/ and follow the instructions for your operating system.

Install the CLI

To install the alwaysAI CLI, open a terminal on your development machine and run:

$ sudo npm install --global alwaysai

Enter your user’s operating system password when prompted.

To verify that the alwaysAI CLI is fully installed and accessible, run:

$ aai -v

This should print a version string like 0.4.4.

Note: If you are following the Real-time Object Detector starter application guide and want to deploy to your local machine, you can skip the rest of these steps and head over to Get a Real-time Object Detector Running.

OpenSSH

Note: You can skip this step if you don’t plan to deploy to a remote device.

OpenSSH is a suite of secure networking utilities based on the Secure Shell (SSH) protocol. The alwaysAI CLI relies on OpenSSH for connecting to your edge device and related tasks like key generation. To check if your computer has OpenSSH installed already, open a terminal and enter:

$ ssh -V

This should print a version string like OpenSSH_7.9p1, LibreSSL 2.7.3. Most Linux distributions already have OpenSSH installed out of the box.

Node.js

Node.js is an open-source cross-platform JavaScript run-time environment. To check if your development computer has Node.js installed already, open a terminal and enter:

$ node -v

This should print a version string like v12.5.0. The alwaysAI CLI requires Node.js v8.0.0 or greater. Node.js ships with npm, a package manager that we’ll use to install the alwaysAI CLI.

To install Node.js, visit https://nodejs.org/ and follow the instructions for your operating system.

Install the CLI

To install the alwaysAI CLI, in a terminal on your development machine run:

$ sudo npm install --global alwaysai

Enter your user’s operating system password when prompted.

To verify that the alwaysAI CLI is fully installed and accessible, run:

$ aai -v

This should print a version string like 0.4.4.

If you encounter an error such as “EACCES: permission denied,” run the following command:

$ sudo chown -R $(whoami) ~/.config

OpenSSH

OpenSSH is a suite of secure networking utilities based on the Secure Shell (SSH) protocol. The alwaysAI CLI relies on OpenSSH for connecting to your edge device and related tasks like key generation. To check if your computer has OpenSSH installed already, open a terminal and enter:

$ ssh -V

This should print a version string like OpenSSH_7.9p1, LibreSSL 2.7.3. Although MacOS has OpenSSH installed out of the box, you can update or re-install it with package managers such as Homebrew.