AYX Plugin CLI
The ayx_plugin_cli package is a command-line tool for building custom plugins for Alteryx Designer. It takes a plugin from an empty folder to an installable package: it creates the project, generates the files Designer expects, and packages the result as a YXI. It reduces the risk of configuration errors and provides a consistent project layout.
Python is the only supported back-end language.
What the CLI Manages
An SDK workspace is the top-level project folder that holds one or more plugins. The CLI creates the workspace and keeps it consistent as you work. In a typical workspace, it creates and maintains:
Back-end source code.
Optional configuration panel (UI) projects.
Configuration files that Designer reads.
Test files.
Build tasks.
Data Connection Manager (DCM) schema folders.
The CLI records everything about the workspace in a single file, ayx_workspace.json. Its commands read and update that file, and run build tasks to generate or refresh the files derived from it. For more information, go to Workspace and Plugin Structure.
The Workflow at a Glance
ayx_plugin_cli sdk-workspace-init # 1. create the workspace
ayx_plugin_cli create-ayx-plugin --tool-name MyFirstPlugin # 2. add a plugin
ayx_plugin_cli test # 3. run the generated tests
ayx_plugin_cli designer-install # 4. build and install into DesignerInitialize the workspace in the current folder.
Create a plugin from a template that matches its data flow.
Generate or refresh the UI and test scaffolding.
Implement the plugin’s behavior and update the tests.
Install into Designer for testing, or package the workspace as a YXI for distribution.
To walk through each step, go to Get Started.
Exploring the CLI from the Command Line
Run ayx_plugin_cli with no arguments, or with --help, to see the top-level help. Run ayx_plugin_cli <command> --help for a single command. The help text has three sections:
Usage: The order in which commands and options are passed.
Options: The available options and what they do.
Commands: The available commands and what they do.
When you leave out a required option, the CLI prompts for it.
Documentation Map
Page | Open It When You Want To |
|---|---|
Install the CLI, pick Python and Node versions, match a Designer release, upgrade, or uninstall. | |
Create your first workspace and plugin from an empty folder. | |
Understand the folder layout, | |
Look up a command, its flags, defaults, and behavior. | |
Build a YXI, install into Designer, or use | |
Learn from the shipped examples, including a passthrough walkthrough. | |
Diagnose errors and check known limitations. |
Versions, Upgrades, and Removal
Check the installed version with
ayx_plugin_cli version.The CLI checks for a newer release each time it starts and prints a warning if one exists. The warning does not stop the command.
Upgrade with
pip install ayx_plugin_cli --upgrade.Uninstall with
pip uninstall ayx_plugin_cli. Your workspace files stay on disk, but you lose the commands that create, update, and package plugins.
For details, go to Set Up Environment.