Skip to content

Commit 15a3c50

Browse files
authored
Merge branch 'main' into chore/369-docs-cleansing-2
2 parents 051b80d + 4815851 commit 15a3c50

1 file changed

Lines changed: 47 additions & 2 deletions

File tree

website/docs/dev_launcher.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,54 @@ ayon /foo/bar/baz.py arg1 arg2
116116

117117
:::caution
118118

119-
AYON Launcher comes with [Global Executable Arguments] (ayon_launcher_artist_advanced.md#global-executable-arguments). These cannot be used in any CLI handling. i.e. you can't reuse them when implementing a [CLI Interface](dev_addon_creation.md#cli-interface) for your addon.
119+
These cannot be used in any CLI handling. i.e. you can't reuse them when implementing a [CLI Interface](dev_addon_creation.md#cli-interface) for your addon.
120120
:::
121121
122+
| <div style={{width: '190px'}}>Argument</div> | Description |
123+
| -- | -- |
124+
| `init-ayon-launcher` | Initializes the launcher by registering the executable path to known AYON launcher locations and installing a shim executable. |
125+
| `--bundle <BUNDLE NAME>` | Forces AYON to use a specific bundle instead of the one set in the bundle settings. This is useful for testing new bundles before release. <br/>See examples here: [How to use different bundles with different projects? \| Ynput Forums](https://community.ynput.io/t/how-to-use-different-bundles-with-different-projects/1096) |
126+
| `--verbose <LOG LEVEL>` | Sets the logging level. Acceptable values: `DEBUG` (10), `INFO` (20), `WARNING` (30), `ERROR` (40), `CRITICAL` (50). You can use either the string or the corresponding integer The value is stored in the `AYON_LOG_LEVEL` environment variable. |
127+
| `--debug` | A simplified way to set verbose to DEBUG. Also sets the `AYON_DEBUG` environment variable to `1`. |
128+
| `--skip-headers` | Skips headers in the console output. |
129+
| `--use-dev` | Uses the dev bundle and settings if a bundle is not explicitly defined. |
130+
| `--use-staging` | Uses staging settings and the staging bundle if a bundle is not explicitly defined. Cannot be combined with staging. |
131+
| `--headless` | Runs AYON in headless mode, with no UIs shown during bootstrap. Affects the AYON_HEADLESS_MODE environment variable. Custom logic must handle headless mode independently. |
132+
| `--ayon-login` | Displays the login dialog on startup. |
133+
| `--skip-bootstrap` | Skips the bootstrap process, used for internal distribution logic. |
134+
135+
136+
You can access these executable arguments via terminal
137+
<Tabs>
138+
139+
<TabItem value="windows" label=<span style={{color:'#1c2026',backgroundColor:'#00a2ed', borderRadius: '4px', padding: '2px 4px'}}>Windows</span> default>
140+
141+
142+
```bash
143+
cd <ayon-launcher-installation-location>
144+
./ayon.exe <arg>
145+
```
146+
Or
147+
```bash
148+
cd <ayon-launcher-installation-location>
149+
./ayon_console.exe <arg>
150+
```
151+
152+
</TabItem>
153+
154+
<TabItem value="linux&mac" label=<div><span style={{color:'#1c2026',backgroundColor:'#f47421', borderRadius: '4px', padding: '2px 4px'}}>Linux</span> & <span style={{color:'#1c2026',backgroundColor:'#e9eff5', borderRadius: '4px', padding: '2px 4px'}}>MacOS</span></div> >
155+
156+
157+
```bash
158+
cd <ayon-launcher-installation-location>
159+
ayon <arg>
160+
```
161+
162+
</TabItem>
163+
164+
</Tabs>
165+
166+
122167
### Environment Variables
123168

124169
AYON launcher provides the following environment variables for its subprocesses, useful in scripting and other applications. These variables are set during startup.
@@ -197,7 +242,7 @@ Just throwing these here for future reference.
197242

198243
- <span style={{color:'#1c2026',backgroundColor:'#00a2ed', borderRadius: '4px', padding: '2px 4px'}}>Windows</span>
199244
- <span style={{color:'#1c2026',backgroundColor:'#f47421', borderRadius: '4px', padding: '2px 4px'}}>Linux</span>
200-
- <span style={{color:'#1c2026',backgroundColor:'#e9eff5', borderRadius: '4px', padding: '2px 4px'}}>Darwin</span>
245+
- <span style={{color:'#1c2026',backgroundColor:'#e9eff5', borderRadius: '4px', padding: '2px 4px'}}>MacOS</span>
201246
- <span style={{color:'#23E0A9'}}></span> <span style={{color:'#1c2026',backgroundColor:'#23E0A9', borderRadius: '4px', padding: '2px 4px'}}>Production</span>
202247
- <span style={{color:'#ff858b'}}></span> <span style={{color:'#1c2026', backgroundColor:'#ff858b', borderRadius: '4px', padding: '2px 4px'}}>Staging</span>
203248
- <span style={{color:'#c78fff'}}></span> <span style={{color:'#1c2026',backgroundColor:'#c78fff', borderRadius: '4px', padding: '2px 4px'}}>Development</span>

0 commit comments

Comments
 (0)