Alteryx Test Client
This document describes how to install the Alteryx SDK CLI that you can use to test extensions.
Downloads
The Altyerx SDK CLI is available in the Alteryx Developer SDK. Download the latest versions from the Releases section of the Alteryx Developer SDK Github Repo.
Installation
To install, extract the SDK archive to a directory of your choice, install required dependencies, and finally, proceed to any platform specific post installation steps below.
Dependencies
Python version 3.8.5 is currently required to use ayx-sdk-cli.exe plugin run. We recommended that you install this in a Miniconda environment.
If you are building a tool for Designer 2024.1, you should use Python 3.10.13 and access the Beta version via Public Preview.
Creating a Miniconda Python Environment
- Follow the Miniconda installation instructions.
- From a terminal, create a new environment with Python 3.8.5:
conda create -n MyEnvName python=3.8.5
ℹ️ Note that if you are using the same Conda environment for ayx_plugin_cli, you might want to also install Node.js v14.x and doit. For example:
conda create -n MyEnvName python=3.8.5 nodejs=14 doit
Please refer to the AYX Python SDK v2 documentation for more information on ayx_plugin_cli and Python SDK v2 tool development.
Post Installation
Windows
In a terminal, change directories to tools\win32\misc and run ./setup-sdk.ps1.
ℹ️ You need to close and restart your terminal after you run this script.
Additional Reading
Find additional resources in the docs directory available in releases.
