diff --git a/website/docs/dev_launcher.md b/website/docs/dev_launcher.md index 80dd8139..62b98b99 100644 --- a/website/docs/dev_launcher.md +++ b/website/docs/dev_launcher.md @@ -116,9 +116,54 @@ ayon /foo/bar/baz.py arg1 arg2 :::caution -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. +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. ::: +|
Argument
| Description | +| -- | -- | +| `init-ayon-launcher` | Initializes the launcher by registering the executable path to known AYON launcher locations and installing a shim executable. | +| `--bundle ` | 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.
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) | +| `--verbose ` | 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. | +| `--debug` | A simplified way to set verbose to DEBUG. Also sets the `AYON_DEBUG` environment variable to `1`. | +| `--skip-headers` | Skips headers in the console output. | +| `--use-dev` | Uses the dev bundle and settings if a bundle is not explicitly defined. | +| `--use-staging` | Uses staging settings and the staging bundle if a bundle is not explicitly defined. Cannot be combined with staging. | +| `--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. | +| `--ayon-login` | Displays the login dialog on startup. | +| `--skip-bootstrap` | Skips the bootstrap process, used for internal distribution logic. | + + +You can access these executable arguments via terminal + + +Windows default> + + +```bash +cd +./ayon.exe +``` +Or +```bash +cd +./ayon_console.exe +``` + + + +Linux & MacOS > + + +```bash +cd +ayon +``` + + + + + + ### Environment Variables 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. - Windows - Linux -- Darwin +- MacOS - Production - Staging - Development