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
87 88 89 90 91 92 93 94 | |
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
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | |
create_project_structure(project)
Create project folder structure as defined in setting ayon+settings://core/project_folder_structure
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project | str | The name of the project for which you want to create its additional folder structure. | required |
Source code in client/ayon_core/cli.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
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
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | |
main_cli(ctx, *_args, **_kwargs)
AYON is main command serving as entry point to pipeline system.
It wraps different commands together.
Source code in client/ayon_core/cli.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
publish(ctx, path, targets)
Start CLI publishing.
Publish collects json from path provided as an argument.
Source code in client/ayon_core/cli.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 | |
run(script)
Run python script in AYON context.
Source code in client/ayon_core/cli.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
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
71 72 73 74 75 76 77 78 79 80 81 82 83 84 | |
version(build)
Print AYON launcher version.
Deprecated
This function has questionable usage.
Source code in client/ayon_core/cli.py
197 198 199 200 201 202 203 204 205 206 | |