Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

added args to documentation

Browse source
This commit is contained in:
Jakub Trllo 2022-04-22 13:55:20 +02:00
parent e1995e8828
commit 5dd449e31b
2 changed files with 28 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
website/docs/admin_openpype_commands.md
View file

@ -24,7 +24,11 @@ openpype_console --use-version=3.0.0-foo+bar
`--list-versions [--use-staging]` - to list available versions.
`--validate-version` to validate integrity of given version
`--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](admin_use.md#run-openpype).
@ -47,13 +51,9 @@ For more information [see here](admin_use.md#run-openpype).
---
### `tray` arguments {#tray-arguments}
| Argument | Description |
| --- | --- |
| `--debug` | print verbose information useful for debugging (works with `openpype_console`) |
To launch Tray with debugging information:
```shell
openpype_console tray --debug
openpype_console tray
```
---
### `launch` arguments {#eventserver-arguments}
@ -62,7 +62,6 @@ option to specify them.
| Argument | Description |
| --- | --- |
| `--debug` | print debug info |
| `--ftrack-url` | URL to ftrack server (can be set with `FTRACK_SERVER`) |
| `--ftrack-user` |user name to log in to ftrack (can be set with `FTRACK_API_USER`) |
| `--ftrack-api-key` | ftrack api key (can be set with `FTRACK_API_KEY`) |
@ -98,12 +97,16 @@ pype launch --app python --project my_project --asset my_asset --task my_task
---
### `publish` arguments {#publish-arguments}
Run publishing based on metadata passed in json file e.g. on farm.
| Argument | Description |
| --- | --- |
| `--debug` | print more verbose information |
| `--targets` | define publishing targets (e.g. "farm") |
| `--gui` (`-g`) | Show publishing |
| Positional argument | Path to metadata json file |
```shell
pype publish <PATH_TO_JSON>
openpype publish <PATH_TO_JSON> --targes farm
```
---

16
website/docs/admin_use.md
View file

@ -69,6 +69,22 @@ stored in `checksums` file.
Add `--headless` to run OpenPype without graphical UI (useful on server or on automated tasks, etc.)
:::
`--verbose` `<level>` - change log verbose level of OpenPype loggers.
Level value can be integer in range `0-50` or one of enum strings `"notset" (0)`, `"debug" (10)`, `"info" (20)`, `"warning" (30)`, `"error" (40)`, `"ciritcal" (50)`. Value is stored to `OPENPYPE_LOG_LEVEL` environment variable for next processes.
```shell
openpype_console --verbose debug
```
`--debug` - set debug flag affects logging
Enable debug flag for OpenPype process. Change value of environment variable `OPENPYPE_DEBUG` to `"1"`. At this moment affects only OpenPype loggers. Argument `--verbose` or environment variable `OPENPYPE_LOG_LEVEL` are used in preference to affect log level.
```shell
openpype_console --debug
```
### Details
When you run OpenPype from executable, few check are made: