Tray Publisher for TDs

Last updated 8 months ago

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.

Example
cd <ayon-launcher-installation-location>
./ayon_console.exe addon traypublisher <command> [OPTIONS]

Supported Commands

launch

Launch Tray Publisher tool GUI. You can use it to access the tray publisher directly without launching AYON launcher.

Example
cd <ayon-launcher-installation-location>
./ayon_console.exe addon traypublisher launch

ingestcsv

Run the CSV Ingestion feature without launching the Publisher GUI.

Option

Description

--filepath <TEXT>

The absolute path to csv file which is in root of package folder.

--project <TEXT>

The name of a project used for ingestion.

--folder-path <TEXT>

The folder path used for ingestion data (storing csv file iterations).

--task <TEXT>

The name of task used for ingestion data iteration backup (case sensitive!).

--ignore-validators

Flag argument for skipping validators.

Example
cd <ayon-launcher-installation-location>
./ayon_console.exe addon traypublisher ingestcsv --filepath <CSV_file_path> --project <project_name> --folder-path <ayon_folder_path> --task <task_name> --ignore-validators

To more about the CSV Ingest and getting an example CSV, please go to CSV Ingest section in Working with AYON Tray Publisher.