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.
The Alteryx® command line interface (CLI) enables scripted execution of jobs and management of users and connections for the Designer Cloud Powered by Trifacta platform. This section provides documentation on how to install and deploy the command line tools and includes example commands for each supported action.
The CLI submits requests to the platform through the Designer Cloud application, which writes its logging information to the following file:
In the above log file, some CLI requests, such as job execution, can be located by searching for the following:
Tip: From the output of the CLI, you should get in the habit of capturing the job, dataset, flow, or other object identifier that the request is creating, modifying, or removing. These IDs are useful for parsing the log file or locating the object in the application.
Administrators can download log files through the Alteryx node operating system or through the web interface for the platform. For more information, see System Services and Logs.
By default, the logging level for the web application is set to
If you are attempting to debug an issue related to the CLI, you can change the logging level.
You can apply this change through the Admin Settings Page (recommended) or
For more information, see Platform Configuration Methods.
The log level is defined in the following parameter:
For more information, see Admin Settings Page.
This page has no comments.