Arundo Edge CLI

The Arundo Edge CLI is a command-line interface for Arundo Edge. This powerful tool gives you the ability to install, configure, and troubleshoot Arundo Edge from a command line.

Tip

The Arundo Edge CLI is an ideal solution if you are running a headless Linux server or want to work through SSH or Telnet.


Getting There

Windows
  1. Open Command Prompt as an administrator.
  2. Browse to the directory where you installed the Arundo Edge CLI.

    • The default directory is C:\Program Files\ArundoEdge\cli
macOS
  1. Open Terminal.
  2. Browse to the directory where you installed the Arundo Edge CLI.
Linux
  1. Open a terminal.
  2. Browse to the directory where you installed the Arundo Edge CLI.

Commands

The Arundo Edge CLI operates by running commands from a command line. Here are the commands you can run:

Basics

Windows
Task Command
Display the version of Arundo Edge installed arundo-edge-cli-win-x64.exe -v
arundo-edge-cli-win-x64.exe --version
Display the status of all installed components arundo-edge-cli-win-x64.exe status
Display available commands arundo-edge-cli-win-x64.exe -h
arundo-edge-cli-win-x64.exe --help
Display help for a command arundo-edge-cli-win-x64.exe [command] -h
arundo-edge-cli-win-x64.exe install -h
macOS
Task Command
Display the version of Arundo Edge installed ./arundo-edge-cli-mac-x64 -v
./arundo-edge-cli-mac-x64 --version
Display the status of all installed components ./arundo-edge-cli-mac-x64 status
Display available commands ./arundo-edge-cli-mac-x64 -h
./arundo-edge-cli-mac-x64 --help
Display help for a command ./arundo-edge-cli-mac-x64 [command] -h
./arundo-edge-cli-mac-x64 install -h
Linux
Task Command
Display the version of Arundo Edge installed ./arundo-edge-cli-linux-x64 -v
./arundo-edge-cli-linux-x64 --version
Display the status of all installed components ./arundo-edge-cli-linux-x64 status
Display available commands ./arundo-edge-cli-linux-x64 -h
./arundo-edge-cli-linux-x64 --help
Display help for a command ./arundo-edge-cli-linux-x64 [command] -h
./arundo-edge-cli-linux-x64 install -h

Installation

Windows
Task Command
Install with default the configuration arundo-edge-cli-win-x64.exe install --path [path] --user [username] --password [password]
arundo-edge-cli-win-x64.exe install --path c:\ArundoEdge --user admin --password test1234
Install with a config file arundo-edge-cli-win-x64.exe install --path [path] --user [username] --password [password] --config [config file]
arundo-edge-cli-win-x64.exe install --path c:\ArundoEdge --user admin --password test1234 --config c:\ArundoEdge\config.json
Upgrade arundo-edge-cli-win-x64.exe upgrade
Uninstall arundo-edge-cli-win-x64.exe uninstall
macOS
Task Command
Install with the default configuration sudo ./arundo-edge-cli-mac-x64 install --path [path] --user [username] --password [password]
sudo ./arundo-edge-cli-mac-x64 install --path /users/downloads/ --user admin --password test1234
Install with a config file sudo ./arundo-edge-cli-mac-x64 install --path [path] --user [username] --password [password] --config [config file]
sudo ./arundo-edge-cli-mac-x64 install --path /users/downloads/ --user admin --password test1234 --config /users/arundoedge/config.json
Upgrade sudo ./arundo-edge-cli-mac-x64 upgrade
Uninstall sudo ./arundo-edge-cli-mac-x64 uninstall
Linux
Task Command
Install with the default configuration sudo ./arundo-edge-cli-linux-x64 install --path [path] --user [username] --password [password]
sudo ./arundo-edge-cli-linux-x64 install --path /users/downloads/ --user admin --password test1234
Install with a config file sudo ./arundo-edge-cli-linux-x64 install --path [path] --user [username] --password [password] --config [config file]
sudo ./arundo-edge-cli-linux-x64 install --path c/users/downloads/ --user admin --password test1234 --config /users/arundoedge/config.json
Upgrade sudo ./arundo-edge-cli-linux-x64 upgrade
Uninstall sudo ./arundo-edge-cli-linux-x64 uninstall

Configuration

Windows
Task Command
Validate a config file arundo-edge-cli-win-x64.exe validate --config [path]
arundo-edge-cli-win-x64.exe validate --config c:\ArundoEdge\config.json
macOS
Task Command
Validate a config file ./arundo-edge-cli-mac-x64 validate --config [path]
./arundo-edge-cli-mac-x64 validate --config /users/arundoedge/config.json
Linux
Task Command
Validate a config file ./arundo-edge-cli-linux-x64 validate --config [path]
./arundo-edge-cli-linux-x64 validate --config /users/arundoedge/config.json

Services

Windows

Arundo Edge service

Task Command
Start the service arundo-edge-cli-win-x64.exe edge start
Stop the service arundo-edge-cli-win-x64.exe edge stop
Restart the service arundo-edge-cli-win-x64.exe edge restart

MongoDB service

Task Command
Start the service arundo-edge-cli-win-x64.exe database start
Stop the service arundo-edge-cli-win-x64.exe database stop
macOS

Arundo Edge service

Task Command
Start the service sudo ./arundo-edge-cli-mac-x64 edge start
Stop the service sudo ./arundo-edge-cli-mac-x64 edge stop
Restart the service sudo ./arundo-edge-cli-mac-x64 edge restart

MongoDB service

Task Command
Start the service sudo ./arundo-edge-cli-mac-x64 database start
Stop the service sudo ./arundo-edge-cli-mac-x64 database stop
Linux

Arundo Edge service

Task Command
Start the service sudo ./arundo-edge-cli-linux-x64 edge start
Stop the service sudo ./arundo-edge-cli-linux-x64 edge stop
Restart the service sudo ./arundo-edge-cli-linux-x64 edge restart

MongoDB service

Task Command
Start the service sudo ./arundo-edge-cli-linux-x64 database start
Stop the service sudo ./arundo-edge-cli-linux-x64 database stop