Using the platform externally
A command-line interface (CLI) is available, allowing access to certain functionalities of the platform remotely. It can be used to set up the environment and install the Python packages.
CLI installation
Linux
Download the CLI for your OS and architecture from the releases page. Extract the archive to find the dhcli
file, open a shell and access this path. Run dhcli -h
for a list of available commands.
MacOS
Download the CLI for your OS and architecture from the releases page. Extract the archive to find the dhcli
file, open a terminal and access this path. Run ./dhcli -h
for a list of available commands.
Alternatively, the CLI can be installed using Homebrew Tap:
brew tap scc-digitalhub/digitalhub-cli https://github.com/scc-digitalhub/digitalhub-cli
brew install dhcli
Windows
Download the CLI for your OS and architecture from the releases page. Extract the archive to find the dhcli.exe
file, open the command prompt and access this path. Run ./dhcli -h
for a list of available commands.
CLI usage
Run commands
Depending on the shell you are using, you may have to run the CLI with ./dhcli
.
The standard use flow of the CLI is as follows:
- Register your instance's configuration. This creates a
.dhcore.ini
file in your home directory (or, if not possible, in the current one), where the configuration will be stored, to be used and updated by subsequent commands.
dhcli register http://localhost:8080
- Log in. This will open a tab in your Internet browser, where you will have to carry out the log in procedure.
dhcli login
- If you wish to install the python packages,
init
will do so, matching the platform's version.
dhcli init
In-detail descriptions of available commands can be found in this dedicated section.