CLI

Downloads

The built-in CLI requires no install — it's part of every Etlworks deployment. This page covers the two adjacent surfaces: the REST endpoint that runs the same commands programmatically, and the separate External CLI for system administration.

Built-in CLI — nothing to download

If this is what you're here for, you're already done. Sign in to Etlworks, open CLI from the main navigation, hit Ctrl + Enter. Same engine, same 137 commands, same security model as the rest of the platform. See Quickstart for the language and conventions.

REST endpoint — POST /v1/cli

Every CLI script runs identically through the REST API. Send the script as a single string, get back an array of CliResponse objects — one per statement. Auth is the same Bearer token used by the broader REST API (API key or JWT).

POST /v1/cli

Documented under the REST API reference. Request shape: {"command": "<script>", "vars": {}}. Response: [{ command, stdout, stderr, exitCode }, …].

Quickstart → REST

REST API reference

The CLI endpoint is one of ~400 endpoints across 14 groups. Same auth, error format, and conventions across all of them.

Open REST docs

External CLI — system administration

A separate command-line tool used outside the application for system tasks: upgrading Etlworks instances, managing backups, controlling services. Not the same as the built-in CLI documented on this site — different scope, different audience, different commands.

External Etlworks CLI

For sysadmins / DevOps managing Etlworks deployments. The latest binary, install paths, and operations are documented in the support center.

Support center

On-prem installer

Self-host Etlworks (cloud + agent + UI) inside your network. Once installed, the built-in CLI is available identically to Etlworks Cloud — same commands, same REST endpoint, same auth.

Etlworks self-hosted

Linux, Windows, and Docker images. Request a download link and we'll provision your installer + license.

Request installer
Building automation around the CLI?

Bug, missing command, awkward UX, or a recipe worth adding to the examples page? product@etlworks.com — goes straight to the team that owns the CLI surface.