Skip to main content

Tray Publisher CLI Interface

Tray Publisher Addon - 0.2.10

About​

This page is dedicated to advanced users who'd like to leverage the CLI feature of the Tray publisher.

CLI Interface​

You can use CLI actions to access the publisher tool. This allows your to use the publisher tool from terminal. this can be helpful if you don't like using UIs or like to write automation scripts at this point you'll be able to use the tray publisher as a standalone application.

How it works​

The entry point is via using addon argument with traypublisher as value.

  1. Locate your AYON executable path. by default it is in C:\Program Files\Ynput\AYON\app\AYON X.X.X
  2. Open powershell at that location and run
.\ayon_console.exe addon traypublisher

Supported Commands​

Launch​

Launch TrayPublisher tool UI. You can use it to access the tray publisher without running AYON. It can be used as a shortcut to launch the tray publisher directly without launching AYON launcher first.

.\ayon_console.exe addon traypublisher launch

CSV Ingest​

Run the CSV Ingestion feature without launching the Publisher UI. It can be helpful for running automations.

.\ayon_console.exe addon traypublisher ingestcsv --filepath '[CSV FILE ABS PATH]' --project [PROJECT_NAME] --folder-path [/FOLDER/PATH] --task [TASK NAME] --ignore-validators
  • --filepath: The absolute path to csv file which is in root of package folder
  • --project: The name of a project used for ingestion
  • --folder-path: The folder path used for ingestion data (storing csv file iterations)
  • --task: The name of task used for ingestion data iteration backup (case sensitive!)
  • --ignore-validators: Flag argument for skipping validators
tip

To more about the CSV Ingest and getting an example CSV, please go to CSV Ingest User Docs