In the next release of Designer Cloud Enterprise Edition after Release 6.0, the Alteryx command line interface tools will be removed from the product (End of Life). Before upgrading to that release or a later one, you must migrate your usage of the CLI to use the REST APIs. For more information, see CLI Migration to APIs.
Contents:
By default, the Alteryx® Command Line Interface (CLI) tools are installed on the Alteryx node during installation. You can use them from there.
Optionally, you can install the CLI tools on a separate server. For example, you might want to create a dedicated server from which you can run a set of predefined jobs on a periodic basis.
NOTE: The location from where you are running the CLI tools must be able to access the pre-installed instance of the Designer Cloud Powered by Trifacta platform.
This section describes how to download and install the CLI tools on a dedicated server.
Download
The Alteryx CLI installer is available through a separate file next to the software distribution provided by Alteryx Inc.
- *.RPM for CentOS/RHEL
- *.DEB for Ubuntu
The appropriate file should be downloaded to the server where you are installing the tools. For more information, see Alteryx Support.
Install
Steps:
On the node where you are installing, execute the command.
For CentOS/RHEL6:
rpm -Uvh trifacta-cli-X.Y.Z-AAAA.el6.x86_64.rpm
where:
X.Y.Z= the three-digit release number.
AAAA= internal build number.For CentOS/RHEL7:
rpm -Uvh trifacta-cli-X.Y.Z-AAAA.el7.x86_64.rpm
where:
X.Y.Z= the three-digit release number.
AAAA= internal build number.For Ubuntu 14.04 (Trusty):
sudo dpkg -i trifacta-cli_X.Y.Z-AAAA~trusty_amd64.deb
where:
X.Y.Z= the three-digit release number.
AAAA= internal build number.For Ubuntu 16.04 (Xenial):
sudo dpkg -i trifacta-cli_X.Y.Z-AAAA~xenial_amd64.deb
where:
X.Y.Z= the three-digit release number.
AAAA= internal build number.
When the installation is complete, you can begin using the tools. The tools are installed in the following directory:
/opt/trifacta/bin/
Upgrade
When you upgrade to a new version of Designer Cloud Enterprise Edition, you must download your CLI packages from the Transformer page after the upgrade is complete. You may be able to execute your packages from the previous release, but backward compatibility of exported CLI packages is not explicitly supported.
When you upgrade to a new version of Designer Cloud Enterprise Edition, you must complete the following steps to ensure that your CLI tools and scripts are upgraded:
NOTE: There is no guarantee of compatibility between versions of Designer Cloud Enterprise Edition CLI tools. You should re-install the tools with each upgrade.
- Download and install the new version of the CLI tools. See earlier in this section.
- Unless changes are required, you can try to run your CLI scripts using the CLI packages that you downloaded from the previous version. If your scripts fail when running jobs, then you should try to re-download the packages from the Transformer page. For more information, see Recipe Panel.
For more information, see Changes to the Command Line Interface.
This page has no comments.