Overview
Use the cruxctl command line interface (CLI) to submit data pipeline jobs, validate dataset specification files, retrieve logs from Crux platform services, manage dataset deadlines, and perform more advanced technical tasks.
Prerequisites
To use cruxctl, set up the following software and utilities on the machine you plan to use:
Homebrew installed
Pyenv installed
Using Pyenv, install and switch to Python v3.11
Access to the Crux app (for an API Key)
Installation
Install cruxctl by performing the following operations:
Run the command
pip install cruxctl
Authentication with cruxctl
Log into the Crux app.
Go to the ⚙️ Settings > API Keys menu.
Copy your unique API key.
Run the following command to authenticate yourself with the CLI:
cruxctl auth login
When prompted, input the API key and hit enter.
Congratulations! You have successfully logged in and are ready to perform advanced data management operations. Your role and organization will be printed on your terminal.
Run the following command to learn about supported
cruxctlcommands:cruxctl --help