Note: Access to The RapidCompact CLI is only available for Enterprise Plans.
This minimalistic guide quickly summarizes all information to get started with the RapidCompact CLI.
Content
Shared Data with Licensing Server
Download
In order to obtain the CLI package for the OS of your choice, navigate to https://app.rapidcompact.com/cli.
In order to run RapidCompact, you will need an rpd_account.json file on your computer as well as an account with an Enterprise Plan on https://app.rapidcompact.com and a valid API token. Start with the account file first:
Account File Setup
Please download the file here. It then can be put in a place of your choosing, we would recommend creating a “rapidcompact” folder in your root directory. For example on windows this would be:
“C:\rapidcompact\rpd_account.json”
Here are the steps to set it up on Windows:
1.) Navigate to control panel / System&Security / System / Advanced System Settings / Environment Variables
Windows 10 Control Panel / System and Security
System and Security / System System / Advanced System Settings
Advanced System Settings / Environment Variables / New / RPD_ACCOUNTFILE
2.) Click on “New…” and name the environment variable “RPD_ACCOUNTFILE”, then you can either simply browse the rpd_account.json file or type in the exact path; In this example that is: “C:\rapidcompact\rpd_account.json”. This is it. You are almost all set!
Here are the steps to set it up on MacOS:
First of all the MacOS 10.15 Catalina Update introduced a change from the Commandline Tool "bash" to "zsh@.
To know which shell is being used, type this command in the terminal:
echo "$SHELL"
To switch to “zsh” type in the following command:
chsh -s /bin/zsh
To switch to “bash” type in the following command:
chsh -s /bin/bash
Similar to the windows setup you will need to save the rpd_account.json file somewhere on your system.
Let's assume your file is under /Users/YOUR_USER_NAME/Documents/ rpd_account.json
(replace the username, you can check what is your username in the terminal using the command "whoami").
To configure the environment variable, you can use the terminal:
For Catalina, if using "zsh" enter this command in the terminal (make sure the command is in one single line):
echo 'export RPD_ACCOUNTFILE=/Users/YOUR_USER_NAME/Documents/rpd_account.json' >> ~/.zshenv
When using the "bash" shell, use this instead:
echo 'export RPD_ACCOUNTFILE=/Users/YOUR_USER_NAME/Documents/rpd_account.json' >> ~/.bash_profile
After this, when you open a new terminal, rpdx should find the file. You can confirm the variable is set using this command:
echo $RPD_ACCOUNTFILE
Here are the steps to set it up on Linux:
Again, similar to the windows setup you will need to save the rpd_account.json file
somewhere on your system.
Let's assume your file is under /home/YOUR_USER_NAME/rpd_account.json
To configure the environment variable, use the following command:
export RPD_ACCOUNTFILE=/home/YOUR_USER_NAME/rpd_account.json
You can confirm the variable is set using this command:
echo $RPD_ACCOUNTFILE
API Token Generation
Log in on https://app.rapidcompact.com and navigate to your account settings on the top right corner -> API Tokens. Now name your token to your liking and hit “Create API Token”:
You can then copy the token string once (it won’t be accessible through the Web interface later, for security reasons) and then insert it into your account file, which you did set up before:
{
"host" : "api.rapidcompact.com",
"token" : "YOUR API TOKEN HERE"
}
In order to track usage and receive data for technical support the CLI will share some information with DGG. HTTPS license authentication request uses end-to-end encryption.
Shared Data to the DGG License Server:
- Your command line (commands and parameters)
- Your optimization settings
Data which is not shared with the DGG License Server:
- any 3D model data
- any texture data
- any statistics about your 3D model
- file names (obfuscated)
You should now be able to use the RapidCompact CLI by opening your systems’ command line and type “rpdx”.
Documentation
If you are looking for commands and what configurable parameter settings RapidCompact CLI has to offer, please have a look at the documentation portal here:
https://rapidcompact.com/doc/cli/index.html