Skip to content

cli

Package for handling AYON command line arguments.

addon(ctx)

Addon specific commands created dynamically.

These commands are generated dynamically by currently loaded addons.

Source code in client/ayon_core/cli.py
69
70
71
72
73
74
75
76
@main_cli.group(help="Run command line arguments of AYON addons")
@click.pass_context
def addon(ctx):
    """Addon specific commands created dynamically.

    These commands are generated dynamically by currently loaded addons.
    """
    pass

contextselection(output_path, project, folder, strict)

Show Qt dialog to select context.

Context is project name, folder path and task name. The result is stored into json file which path is passed in first argument.

Source code in client/ayon_core/cli.py
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
@main_cli.command()
@click.argument("output_path")
@click.option("--project", help="Define project context")
@click.option(
    "--folder", help="Define folder in project (project must be set)")
@click.option(
    "--strict",
    is_flag=True,
    help="Full context must be set otherwise dialog can't be closed."
)
def contextselection(
    output_path,
    project,
    folder,
    strict
):
    """Show Qt dialog to select context.

    Context is project name, folder path and task name. The result is stored
    into json file which path is passed in first argument.
    """
    from ayon_core.tools.context_dialog import main

    main(output_path, project, folder, strict)

extractenvironments(ctx, output_json_path, project, asset, task, app, envgroup)

Extract environment variables for entered context to a json file.

Entered output filepath will be created if does not exists.

All context options must be passed otherwise only AYON's global environments will be extracted.

Context options are "project", "asset", "task", "app"

Deprecated

This function is deprecated and will be removed in future. Please use 'addon applications extractenvironments ...' instead.

Source code in client/ayon_core/cli.py
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
@main_cli.command()
@click.pass_context
@click.argument("output_json_path")
@click.option("--project", help="Project name", default=None)
@click.option("--asset", help="Folder path", default=None)
@click.option("--task", help="Task name", default=None)
@click.option("--app", help="Application name", default=None)
@click.option(
    "--envgroup", help="Environment group (e.g. \"farm\")", default=None
)
def extractenvironments(
    ctx, output_json_path, project, asset, task, app, envgroup
):
    """Extract environment variables for entered context to a json file.

    Entered output filepath will be created if does not exists.

    All context options must be passed otherwise only AYON's global
    environments will be extracted.

    Context options are "project", "asset", "task", "app"

    Deprecated:
        This function is deprecated and will be removed in future. Please use
        'addon applications extractenvironments ...' instead.
    """
    warnings.warn(
        (
            "Command 'extractenvironments' is deprecated and will be"
            " removed in future. Please use"
            " 'addon applications extractenvironments ...' instead."
        ),
        DeprecationWarning
    )

    addons_manager = ctx.obj["addons_manager"]
    applications_addon = addons_manager.get_enabled_addon("applications")
    if applications_addon is None:
        raise RuntimeError(
            "Applications addon is not available or enabled."
        )

    # Please ignore the fact this is using private method
    applications_addon._cli_extract_environments(
        output_json_path, project, asset, task, app, envgroup
    )

interactive()

Interactive (Python like) console.

Helpful command not only for development to directly work with python interpreter.

Warning

Executable 'ayon.exe' on Windows won't work.

Source code in client/ayon_core/cli.py
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
@main_cli.command()
def interactive():
    """Interactive (Python like) console.

    Helpful command not only for development to directly work with python
    interpreter.

    Warning:
        Executable 'ayon.exe' on Windows won't work.
    """
    version = os.environ["AYON_VERSION"]
    banner = (
        f"AYON launcher {version}\nPython {sys.version} on {sys.platform}"
    )
    code.interact(banner)

main_cli(ctx, force)

AYON is main command serving as entry point to pipeline system.

It wraps different commands together.

Source code in client/ayon_core/cli.py
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@click.group(invoke_without_command=True)
@click.pass_context
@click.option("--use-staging", is_flag=True,
              expose_value=False, help="use staging variants")
@click.option("--debug", is_flag=True, expose_value=False,
              help="Enable debug")
@click.option("--verbose", expose_value=False,
              help=("Change AYON log level (debug - critical or 0-50)"))
@click.option("--force", is_flag=True, hidden=True)
def main_cli(ctx, force):
    """AYON is main command serving as entry point to pipeline system.

    It wraps different commands together.
    """

    if ctx.invoked_subcommand is None:
        # Print help if headless mode is used
        if os.getenv("AYON_HEADLESS_MODE") == "1":
            print(ctx.get_help())
            sys.exit(0)
        else:
            ctx.forward(tray)

publish(ctx, path, targets)

Start CLI publishing.

Publish collects json from path provided as an argument.

Source code in client/ayon_core/cli.py
127
128
129
130
131
132
133
134
135
136
137
138
139
140
@main_cli.command()
@click.pass_context
@click.argument("path", required=True)
@click.option("-t", "--targets", help="Targets", default=None,
              multiple=True)
def publish(ctx, path, targets):
    """Start CLI publishing.

    Publish collects json from path provided as an argument.

    """
    from ayon_core.pipeline.publish import main_cli_publish

    main_cli_publish(path, targets, ctx.obj["addons_manager"])

run(script)

Run python script in AYON context.

Source code in client/ayon_core/cli.py
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
@main_cli.command(
    context_settings=dict(
        ignore_unknown_options=True,
        allow_extra_args=True))
@click.argument("script", required=True, type=click.Path(exists=True))
def run(script):
    """Run python script in AYON context."""
    import runpy

    if not script:
        print("Error: missing path to script file.")
        return

    # Remove first argument if it is the same as AYON executable
    # - Forward compatibility with future AYON versions.
    # - Current AYON launcher keeps the arguments with first argument but
    #     future versions might remove it.
    first_arg = sys.argv[0]
    if is_running_from_build():
        comp_path = os.getenv("AYON_EXECUTABLE")
    else:
        comp_path = os.path.join(os.environ["AYON_ROOT"], "start.py")
    # Compare paths and remove first argument if it is the same as AYON
    if Path(first_arg).resolve() == Path(comp_path).resolve():
        sys.argv.pop(0)

    # Remove 'run' command from sys.argv
    sys.argv.remove("run")

    args_string = " ".join(sys.argv[1:])
    print(f"... running: {script} {args_string}")
    runpy.run_path(script, run_name="__main__")

tray(force)

Launch AYON tray.

Default action of AYON command is to launch tray widget to control basic aspects of AYON. See documentation for more information.

Source code in client/ayon_core/cli.py
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
@main_cli.command()
@click.option(
    "--force",
    is_flag=True,
    help="Force to start tray and close any existing one.")
def tray(force):
    """Launch AYON tray.

    Default action of AYON command is to launch tray widget to control basic
    aspects of AYON. See documentation for more information.
    """

    from ayon_core.tools.tray import main

    main(force)

version(build)

Print AYON launcher version.

Deprecated

This function has questionable usage.

Source code in client/ayon_core/cli.py
228
229
230
231
232
233
234
235
236
237
@main_cli.command()
@click.option("--build", help="Print only build version",
              is_flag=True, default=False)
def version(build):
    """Print AYON launcher version.

    Deprecated:
        This function has questionable usage.
    """
    print(os.environ["AYON_VERSION"])