Skip to main content

OpenPype Commands Reference

info

You can substitute openpype_console with poetry run python start.py if you want to run it directly from sources.

note

Running OpenPype without any commands will default to tray.

Common arguments

--use-version to specify explicit version to use:

openpype_console --use-version=3.0.0-foo+bar

--headless - to run OpenPype in headless mode (without using graphical UI)

--use-staging - to use staging versions of OpenPype.

--list-versions [--use-staging] - to list available versions.

--validate-version - to validate integrity of given version

--verbose <level> - change log verbose level of OpenPype loggers

--debug - set debug flag affects logging

For more information see here.

Commands

CommandDescriptionArguments
contextselectionOpen Context selection dialog.
moduleRun command line arguments for modules.
repack-versionTool to re-create version zip.📑
trayLaunch OpenPype Tray.📑
eventserverThis should be ideally used by system service (such as systemd or upstart on linux and window service).📑
launchLaunch application in Pype environment.📑
publishPype takes JSON from provided path and use it to publish data in it.📑
extractenvironmentsExtract environment variables for entered context to a json file.📑
runExecute given python script within OpenPype environment.📑
interactiveStart python like interactive console session.
projectmanagerLaunch Project Manager UI📑
settingsOpen Settings UI📑
standalonepublisherOpen Standalone Publisher UI📑

tray arguments

openpype_console tray

launch arguments

You have to set either proper environment variables to provide URL and credentials or use option to specify them.

ArgumentDescription
--ftrack-urlURL to ftrack server (can be set with FTRACK_SERVER)
--ftrack-useruser name to log in to ftrack (can be set with FTRACK_API_USER)
--ftrack-api-keyftrack api key (can be set with FTRACK_API_KEY)
--legacyrun event server without mongo storing
--clockify-api-keyClockify API key (can be set with CLOCKIFY_API_KEY)
--clockify-workspaceClockify workspace (can be set with CLOCKIFY_WORKSPACE)

To run ftrack event server:

openpype_console eventserver --ftrack-url=<url> --ftrack-user=<user> --ftrack-api-key=<key>

launch arguments

ArgumentDescription
--appApplication name - this should be the key for application from Settings.
--projectProject name (default taken from AVALON_PROJECT if set)
--assetAsset name (default taken from AVALON_ASSET if set)
--taskTask name (default taken from AVALON_TASK is set)
--toolsOptional: Additional tools to add
--userOptional: User on behalf to run
--ftrack-server / -fsOptional: Ftrack server URL
--ftrack-user / -fuOptional: Ftrack user
--ftrack-key / -fkOptional: Ftrack API key

For example to run Python interactive console in Pype context:

pype launch --app python --project my_project --asset my_asset --task my_task

publish arguments

Run publishing based on metadata passed in json file e.g. on farm.

ArgumentDescription
--targetsdefine publishing targets (e.g. "farm")
--gui (-g)Show publishing
Positional argumentPath to metadata json file
openpype publish <PATH_TO_JSON> --targes farm

extractenvironments arguments

Entered output filepath will be created if does not exists. All context options must be passed otherwise only openpype's global environments will be extracted. Context options are project, asset, task, app

ArgumentDescription
output_json_pathAbsolute path to the exported json file
--projectProject name
--assetAsset name
--taskTask name
--appApplication name
openpype_console /home/openpype/env.json --project Foo --asset Bar --task modeling --app maya-2019

run arguments

| Argument | Description | | --script | run specified python script |

Note that additional arguments are passed to the script.

openpype_console run --script /foo/bar/baz.py arg1 arg2

projectmanager arguments

projectmanager has no command-line arguments.

openpype_console projectmanager

settings arguments

| Argument | Description | | -d / --dev | Run settings in developer mode. |

openpypeconsole settings

standalonepublisher arguments

standalonepublisher has no command-line arguments.

openpype_console standalonepublisher

repack-version arguments

Takes path to unzipped and possibly modified OpenPype version. Files will be zipped, checksums recalculated and version will be determined by folder name (and written to version.py).

./openpype_console repack-version /path/to/some/modified/unzipped/version/openpype-v3.8.3-modified