Getting started
Learn how to install, configure and update Digibeectl.
This documentation presents the steps that must be performed for Digibeectl to be installed and working correctly.
Download the configuration file
Follow the steps below to get the configuration file:
Log in to Digibee Integration Platform.
Click on the Administration button.
Click in Digibeectl in the menu on the left side of the screen.
Click on the Create button.
Give a title to your token.
Insert a list of permissions to be granted to this token.
Set an expiration period for your token. The period ranges from 1 hour to 1 year.
Save your permissions list and expiration period.
Copy the Encryption Key generated by the Platform using the copy icon and save it to further use. Then, create the file password.
Save the password and download the file.
Run the installation
Digibeectl is available as a ‘tar.gz’ file for MacOs and Linux.
To install the file, open a terminal window and run the command line below:
Use the following command line after install Digibeectl. Replace the words “
path/file.json” by the configuration file address and the words "encryption key" and "encryption password" by the data you set before when downloading the configuration file:
Customizing the configuration directory
By default, Digibeectl stores its configuration files in the ~/.digibeectl/ directory. However, you can customize this location by setting the DIGIBEECTL_PATH environment variable. Use the following commands to specify your preferred directory:
Unix-based systems (Linux, macOS): Run the command in the terminal or add it to your shell configuration file.
Download the updates
To update Digibeectl, run the installation line again. To do this, open a terminal window and type:
Last updated
Was this helpful?