Search…
CLI Installation
Next, install the Gretel CLI and Python client. Both the CLI and Python SDK are bundled in a single Python package.
The Gretel CLI requires Python 3.7 or greater and Docker (for local Gretel Workers).
If you are using a system such as Ubuntu 18.04, etc with a version of Python less than 3.7 installed, you should upgrade to a newer version. We’ve provided a script that has been tested with Ubuntu 18.04 and will install Python 3.8 and PIP as the new defaults for the system.
Be sure to run a source ~/.bashrc from your terminal once the script completes.
Gretel Beta2 will require gretel-client version 0.8.0 or greater.
Once appropriate versions of Python and PIP are installed, you can install Gretel’s Python tools.
1
pip install -U gretel-client
Copied!

CLI Configuration

Next, configure the CLI, this can be done by simply running:
1
gretel configure
Copied!
Accept the default for the Endpoint.
The Default Runner is set for cloud, if you need workers to run on your own machine(s) you may change this value to local.
When prompted for your Gretel API Key, paste the key you created in the above steps.
When prompted for your Default Project, paste the Project Name you created in the above steps.
At this point, your configuration should have been written to your home directory. To validate the connection to Gretel Cloud, try running:
1
gretel projects search --limit 10
Copied!
This should return JSON output that shows existing projects you have in your account.
At this point, you should be ready to run Gretel jobs on your local system.
The first time you run the gretel models create command, the CLI application will trigger a download of Gretel's containers to your system. This may take a few minutes. As we update our service and software, running jobs may also trigger the downloading of updated containers.
Copy link