Setup
Installation
Download Q01SDK
q01sdk
can be installed in different OS:
- Linux
- macOS ARM
- macOS
- Windows
Click the link below or use a binary download (with curl or wget)
https://app.q01.io/api/v4/q01sdk/download?file=lin
curl -kfsSL https://app.q01.io/api/v4/q01sdk/download?file=lin -o ~/Downloads/q01sdk
or
wget -q https://app.q01.io/api/v4/q01sdk/download?file=lin -O ~/Downloads/q01sdk
Click the link below or use a binary download (with curl or wget)
https://app.q01.io/api/v4/q01sdk/download?file=macarm
curl -kfsSL https://app.q01.io/api/v4/q01sdk/download?file=macarm -o ~/Downloads/q01sdk
or
wget -q https://app.q01.io/api/v4/q01sdk/download?file=macarm -O ~/Downloads/q01sdk
Click the link below or use a binary download (with curl or wget)
https://app.q01.io/api/v4/q01sdk/download?file=mac
curl -kfsSL https://app.q01.io/api/v4/q01sdk/download?file=mac -o ~/Downloads/q01sdk
or
wget -q https://app.q01.io/api/v4/q01sdk/download?file=mac -O ~/Downloads/q01sdk
Click the link below or use a binary download (with curl or wget)
https://app.q01.io/api/v4/q01sdk/download?file=win
curl -kfsSL https://app.q01.io/api/v4/q01sdk/download?file=win -o %USERPROFILE%\Downloads\q01sdk
or
wget -q https://app.q01.io/api/v4/q01sdk/download?file=win -O %USERPROFILE%\Downloads\q01sdk
Make the SDK Executable and Accessible
After downloading the q01sdk
binary, you need to make it executable and optionally move it to your local bin
directory so it can be used from anywhere in your terminal.
Make the binary executable
On Linux or macOS, run:
chmod +x ~/Downloads/q01sdk
Alternatively, for permissive execution:
chmod 777 ~/Downloads/q01sdk
Move it to your personal bin folder (optional)
To make the q01sdk
command globally accessible, move it to a folder already included in your PATH, such as ~/.local/bin or /usr/local/bin.
Example (Linux/macOS):
mv ~/Downloads/q01sdk ~/.local/bin/q01sdk
Or, for system-wide use (requires sudo):
sudo mv ~/Downloads/q01sdk /usr/local/bin/q01sdk
Example (Windows):
- Rename and move the binary (optional but recommended) Move the downloaded q01sdk.exe to a convenient folder, such as:
C:\Users\<YourUsername>\q01tools\
-
Add that folder to your system PATH
-
Open the Start Menu and search for "Environment Variables".
-
Click "Edit the system environment variables".
-
In the System Properties window, click "Environment Variables...".
-
Under User variables, select Path and click Edit.
-
Click New, and add the path to your tools directory:
C:\Users\<YourUsername>\q01tools\
- Click OK on all windows to save and apply the changes.
Local Environment (optional)
This configuration step is needed only to test a non production version of q01sdk tool!!
q01sdk env
Create a .env
file under the user home directory.
- Linux
- macOS ARM
- macOS
- Windows
mkdir ~/.q01sdk touch ~/.q01sdk/.env echo "Host="https://app.q01.io\"" > ~/.q01sdk/.env echo "Env="prod"" >> ~/.q01sdk/.env
mkdir ~/.q01sdk touch ~/.q01sdk/.env echo "Host="https://app.q01.io\"" > ~/.q01sdk/.env
mkdir ~/.q01sdk touch ~/.q01sdk/.env echo "Env="prod"" >> ~/.q01sdk/.env
- create the folder %USERPROFILE%.q01sdk
- create .env file with the following content
# %USERPROFILE%.q01sdk.env Host="https://app.q01.io" Env="prod"