From f62ace0e1937a70be2f91c3e051fa475bd2fc5a6 Mon Sep 17 00:00:00 2001 From: Sava Znatnov Date: Sat, 10 Oct 2026 21:46:01 +0700 Subject: [PATCH] feat(cli): `-o name` prints the identifier of each object, what the command that reads it takes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A reply model marks the one field its resource's read command takes with `Identity()`; `-o name` prints it on a line for each item, so `ycli … list -o name | xargs -n1 ycli … get` works, and `create -o name` gives the key of what was made. An object inside another one prints its own identifier. A command whose result has no such field is refused before it sends anything (exit code 2). A reply that leaves the identifier of an item out is an error and nothing is printed, so a script never acts on fewer objects than were listed. The plan of `--dry-run` is printed as JSON. The hand-written models of Tracker, Wiki and Forms are marked (82 fields). The models generated from the DataLens specification are not: their resources will name the identifier where the generator reads it, in the next change. Decisions of #561 (Р1-А, Р2-А, Р2-Г) and #498. Co-Authored-By: Claude Opus 5.5 --- .rulesync/rules/overview.md | 2 +- AGENTS.md | 2 +- CLAUDE.md | 2 +- README.md | 2 +- README.ru.md | 2 +- docs/conventions/resources.md | 13 + docs/en/how-to/script-the-cli.md | 17 +- docs/en/reference/cli/auth.md | 6 +- docs/en/reference/cli/datalens.md | 270 ++++++------- docs/en/reference/cli/forms.md | 166 ++++---- docs/en/reference/cli/index.md | 2 +- docs/en/reference/cli/mcp.md | 4 +- docs/en/reference/cli/sync.md | 12 +- docs/en/reference/cli/tracker.md | 380 +++++++++--------- docs/en/reference/cli/wiki.md | 120 +++--- docs/ru/how-to/script-the-cli.md | 17 +- src/ycli/cli/formats.py | 1 + src/ycli/cli/inject.py | 10 +- src/ycli/cli/output.py | 78 ++++ src/ycli/yandex/forms/answers/models.py | 7 +- src/ycli/yandex/forms/filling/models.py | 13 +- src/ycli/yandex/forms/history/models.py | 5 +- src/ycli/yandex/forms/hooks/models.py | 7 +- src/ycli/yandex/forms/images/models.py | 5 +- src/ycli/yandex/forms/keysets/models.py | 5 +- src/ycli/yandex/forms/me/models.py | 7 +- src/ycli/yandex/forms/models.py | 7 +- src/ycli/yandex/forms/notifications/models.py | 11 +- src/ycli/yandex/forms/questions/models.py | 9 +- src/ycli/yandex/forms/subscriptions/models.py | 5 +- src/ycli/yandex/forms/surveys/models.py | 7 +- src/ycli/yandex/forms/variables/models.py | 7 +- src/ycli/yandex/status/models.py | 5 +- src/ycli/yandex/sync/files.py | 6 +- src/ycli/yandex/sync/kind.py | 6 +- src/ycli/yandex/sync/marks.py | 8 +- src/ycli/yandex/sync/plan.py | 8 +- src/ycli/yandex/sync/pull.py | 6 +- src/ycli/yandex/sync/push.py | 6 +- src/ycli/yandex/tracker/attachments/models.py | 7 +- src/ycli/yandex/tracker/autoactions/models.py | 13 +- src/ycli/yandex/tracker/boards/models.py | 7 +- src/ycli/yandex/tracker/bulk/models.py | 11 +- src/ycli/yandex/tracker/changelog/models.py | 7 +- src/ycli/yandex/tracker/columns/models.py | 7 +- src/ycli/yandex/tracker/comments/models.py | 7 +- src/ycli/yandex/tracker/components/models.py | 7 +- src/ycli/yandex/tracker/dashboards/models.py | 11 +- src/ycli/yandex/tracker/entities/models.py | 19 +- src/ycli/yandex/tracker/fields/models.py | 11 +- src/ycli/yandex/tracker/filters/models.py | 7 +- src/ycli/yandex/tracker/issuetypes/models.py | 7 +- src/ycli/yandex/tracker/links/models.py | 7 +- src/ycli/yandex/tracker/localfields/models.py | 7 +- src/ycli/yandex/tracker/macros/models.py | 7 +- src/ycli/yandex/tracker/models.py | 21 +- src/ycli/yandex/tracker/priorities/models.py | 7 +- src/ycli/yandex/tracker/projects/models.py | 7 +- src/ycli/yandex/tracker/queues/models.py | 13 +- src/ycli/yandex/tracker/remotelinks/models.py | 7 +- src/ycli/yandex/tracker/resolutions/models.py | 7 +- src/ycli/yandex/tracker/sprints/models.py | 7 +- src/ycli/yandex/tracker/statuses/models.py | 7 +- src/ycli/yandex/tracker/transitions/models.py | 7 +- src/ycli/yandex/tracker/triggers/models.py | 11 +- src/ycli/yandex/tracker/workflows/models.py | 7 +- src/ycli/yandex/tracker/worklog/models.py | 7 +- src/ycli/yandex/wiki/access/models.py | 7 +- src/ycli/yandex/wiki/attachments/models.py | 7 +- src/ycli/yandex/wiki/comments/models.py | 11 +- src/ycli/yandex/wiki/grids/models.py | 11 +- src/ycli/yandex/wiki/models.py | 7 +- src/ycli/yandex/wiki/pages/models.py | 12 +- src/ycli/yandex/wiki/uploadsessions/models.py | 5 +- tests/architecture/test_names.py | 94 +++++ tests/contract/test_output_formats.py | 67 +++ tests/unit/cli/test_inject.py | 20 +- tests/unit/cli/test_output_strategies.py | 42 ++ 78 files changed, 1169 insertions(+), 610 deletions(-) create mode 100644 tests/architecture/test_names.py diff --git a/.rulesync/rules/overview.md b/.rulesync/rules/overview.md index 256f48c36..25544d900 100644 --- a/.rulesync/rules/overview.md +++ b/.rulesync/rules/overview.md @@ -27,7 +27,7 @@ Claude Code **plugin** under `plugins/yandex-360/`. Published on PyPI as `yandex plugin (skills + instructions) lives in `plugins/yandex-360/`, listed by the repo-root `.claude-plugin/marketplace.json`. - **Output:** every CLI command honors a global `--format/-o` flag (`auto` · `json` · `yaml` - · `pretty` · `csv` · `markdown` · `ndjson`); no output surface hardcodes a service UI URL, and a general per-model deeplink + · `pretty` · `csv` · `markdown` · `ndjson` · `name`); no output surface hardcodes a service UI URL, and a general per-model deeplink mechanism is deferred. Serialization confinement (ARCH-4), single sources of truth (ARCH-5) and MCP read/write annotation honesty with `ycli mcp start --read-only` (ARCH-3) are specified and enforced in [`ARCHITECTURE.md`](ARCHITECTURE.md); read them there. diff --git a/AGENTS.md b/AGENTS.md index fe3ef9ea2..92d622a8f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -20,7 +20,7 @@ Claude Code **plugin** under `plugins/yandex-360/`. Published on PyPI as `yandex plugin (skills + instructions) lives in `plugins/yandex-360/`, listed by the repo-root `.claude-plugin/marketplace.json`. - **Output:** every CLI command honors a global `--format/-o` flag (`auto` · `json` · `yaml` - · `pretty` · `csv` · `markdown` · `ndjson`); no output surface hardcodes a service UI URL, and a general per-model deeplink + · `pretty` · `csv` · `markdown` · `ndjson` · `name`); no output surface hardcodes a service UI URL, and a general per-model deeplink mechanism is deferred. Serialization confinement (ARCH-4), single sources of truth (ARCH-5) and MCP read/write annotation honesty with `ycli mcp start --read-only` (ARCH-3) are specified and enforced in [`ARCHITECTURE.md`](ARCHITECTURE.md); read them there. diff --git a/CLAUDE.md b/CLAUDE.md index fe3ef9ea2..92d622a8f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -20,7 +20,7 @@ Claude Code **plugin** under `plugins/yandex-360/`. Published on PyPI as `yandex plugin (skills + instructions) lives in `plugins/yandex-360/`, listed by the repo-root `.claude-plugin/marketplace.json`. - **Output:** every CLI command honors a global `--format/-o` flag (`auto` · `json` · `yaml` - · `pretty` · `csv` · `markdown` · `ndjson`); no output surface hardcodes a service UI URL, and a general per-model deeplink + · `pretty` · `csv` · `markdown` · `ndjson` · `name`); no output surface hardcodes a service UI URL, and a general per-model deeplink mechanism is deferred. Serialization confinement (ARCH-4), single sources of truth (ARCH-5) and MCP read/write annotation honesty with `ycli mcp start --read-only` (ARCH-3) are specified and enforced in [`ARCHITECTURE.md`](ARCHITECTURE.md); read them there. diff --git a/README.md b/README.md index e4cc0e05b..2474cbd78 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Something not working? [If it does not work](https://ycli.savaznatnov.dev/how-to ```bash ycli tracker issues get TRACKER-1 # a table at a terminal ycli tracker issues get TRACKER-1 | jq .summary # JSON when piped -ycli -o yaml wiki pages get onboarding # or pick: -o json | yaml | pretty | csv | markdown | ndjson +ycli -o yaml wiki pages get onboarding # or pick: -o json | yaml | pretty | csv | markdown | ndjson | name ycli tracker boards delete 7 --dry-run # print the request a write would send ycli tracker boards delete 7 --yes # a delete asks first; --yes answers ycli api issues/TRACKER-1 --service tracker # an endpoint ycli does not wrap diff --git a/README.ru.md b/README.ru.md index 3325e7cf3..10b692a39 100644 --- a/README.ru.md +++ b/README.ru.md @@ -72,7 +72,7 @@ pipx install 'yandex-cli[mcp]' # или через pipx ```bash ycli tracker issues get TRACKER-1 # таблица в терминале ycli tracker issues get TRACKER-1 | jq .summary # JSON при передаче по конвейеру -ycli -o yaml wiki pages get onboarding # или выберите: -o json | yaml | pretty | csv | markdown | ndjson +ycli -o yaml wiki pages get onboarding # или выберите: -o json | yaml | pretty | csv | markdown | ndjson | name ycli tracker boards delete 7 --dry-run # напечатать запрос, который отправила бы запись ycli tracker boards delete 7 --yes # удаление сначала спрашивает; --yes отвечает ycli api issues/TRACKER-1 --service tracker # эндпоинт, который ycli не оборачивает diff --git a/docs/conventions/resources.md b/docs/conventions/resources.md index e804e5856..f8792595a 100644 --- a/docs/conventions/resources.md +++ b/docs/conventions/resources.md @@ -124,6 +124,18 @@ lists the field; `tests/tooling/test_api_drift.py` fails on a mark that explains query parameter has no model to carry the mark: it is listed in `EXPLAINED` with the `IGNORED` reason. +### The field that names the object + +A reply model marks the one field that says which object it is with `Identity()` +(`ycli.yandex.sync.marks`): `key: Annotated[str | None, Identity()]`. It is the field the +resource's read command takes (`issues get` takes a key, `boards get` an id; where a resource +has `get` and `get-by-id`, plain `get` decides), so `ycli … list -o name | xargs -n1 ycli … get` +works. `-o name` prints it, and a command whose result has no such field is refused before +any request. An item of a listing with no identifier of its own stands in `NO_NAME` of +`tests/architecture/test_names.py` with its reason. The models generated from the DataLens +specification are not marked yet: their resources will name the identifier where the +generator reads it. + --- ## 2. Lists: `ItemList[X]` is flat, `XResponse` is the envelope @@ -584,6 +596,7 @@ the code sees that the departure was chosen, and a search for `violation(` lists | Acronyms keep their capitals in a CapWords name | `tests/architecture/test_conventions.py::test_an_acronym_keeps_its_capitals_in_a_name` | | One name on every surface, no synonym, `get` returns one object | `tests/architecture/test_arch1.py`: `test_arch1_cli_path_equals_mcp_name`, `test_arch1_sdk_method_equals_tool_name`, `test_arch1_a_get_returns_one_object` | | The verb, the parts and their order | review: `/arch-review` against [Naming an operation](#7-naming-an-operation) | +| The item of a listing names itself, and so does what its resource reads, makes or changes | `tests/architecture/test_names.py` (reasons in `NO_NAME`) | | An `Annotated` alias is defined once | `tests/architecture/test_conventions.py::test_an_annotated_alias_is_defined_once` | | Every model field carries a description | `tests/architecture/test_conventions.py::test_every_model_field_has_a_description` | | An alias name means one thing | `tests/architecture/test_conventions.py::test_an_alias_name_means_one_thing` | diff --git a/docs/en/how-to/script-the-cli.md b/docs/en/how-to/script-the-cli.md index 8873dd7c3..60335d66a 100644 --- a/docs/en/how-to/script-the-cli.md +++ b/docs/en/how-to/script-the-cli.md @@ -7,7 +7,7 @@ type: how-to ## Get JSON -At a terminal ycli prints tables; piped, it prints JSON. Force a format with the global `--format` / `-o` (`auto`, `json`, `yaml`, `pretty`, `csv`, `markdown`, `ndjson`), before or after the command: +At a terminal ycli prints tables; piped, it prints JSON. Force a format with the global `--format` / `-o` (`auto`, `json`, `yaml`, `pretty`, `csv`, `markdown`, `ndjson`, `name`), before or after the command: ```bash ycli tracker issues get TRACKER-1 | jq . # JSON, because the output is piped @@ -44,6 +44,21 @@ ycli tracker issues search 'Queue: TEST' -o ndjson | jq -r .key - `csv` is UTF-8 with no byte order mark, its lines end with a line feed alone, and a cell is the service's text as it came. A spreadsheet reads a cell that starts with `=` as a formula, so open a file of someone else's text with that in mind. - Where a listing stopped is said on stderr, as with `-o pretty`: stdout holds the rows alone. +## Feed one command to another + +`-o name` prints the identifier of each object on a line: what the command that reads it takes. + +```bash +ycli tracker issues search 'Queue: TEST' -o name | xargs -n1 ycli tracker issues get +new=$(ycli tracker issues create --queue TEST --summary 'From a script' -o name) +``` + +- An object that lies inside another one prints its own identifier: `ycli tracker comments list TEST-1 -o name` prints comment ids, and the issue key is yours to add. +- A command whose result has no identifier (a grant of access, a count) is refused before it sends anything, with exit code 2. +- A reply that leaves the identifier of an item out is an error: nothing is printed, so a script never acts on fewer objects than were listed. +- With `--dry-run` the plan comes back in place of the object, and it is printed as JSON. +- DataLens commands do not print names yet. + ## Take a long listing in pieces A listing stops at 500 items unless told otherwise. `--limit N` takes the first N, `--all` takes everything, and `--next` goes on from where a run stopped. `-o json` and `-o yaml` print what the MCP tool and the SDK give: `{items, truncated, next, total}`, so a script takes the token with `jq -r .next`. A table (`-o pretty`) prints the rows, and where it stopped goes to stderr, ready to paste. The line says that the run stopped at its limit, not that more is left: only the next run can tell, and it may give nothing. diff --git a/docs/en/reference/cli/auth.md b/docs/en/reference/cli/auth.md index a921984d4..404bcefd7 100644 --- a/docs/en/reference/cli/auth.md +++ b/docs/en/reference/cli/auth.md @@ -41,7 +41,7 @@ $ ycli auth status [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -71,7 +71,7 @@ $ ycli auth login [OPTIONS] * `--implicit`: Use the browser paste flow even if a client secret is set. * `-y, --yes`: Write .env without asking to confirm. * `--device-name TEXT`: Label shown for this device during OAuth approval. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. * `-F, --field TEXT`: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret. @@ -93,7 +93,7 @@ $ ycli auth profiles [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/datalens.md b/docs/en/reference/cli/datalens.md index 3b28b873a..07bcb2cdf 100644 --- a/docs/en/reference/cli/datalens.md +++ b/docs/en/reference/cli/datalens.md @@ -81,7 +81,7 @@ $ ycli datalens auth status [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -119,7 +119,7 @@ $ ycli datalens tenant details-get [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -174,7 +174,7 @@ $ ycli datalens collections get [OPTIONS] COLLECTION_ID **Options**: * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -198,7 +198,7 @@ $ ycli datalens collections list-by-ids [OPTIONS] COLLECTION_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -231,7 +231,7 @@ $ ycli datalens collections content-list [OPTIONS] [COLLECTION_ID] * `--only-my / --no-only-my`: Keep only what you created. * `--mode TEXT`: Which kinds of items to list. Known values: all, onlyCollections, onlyWorkbooks, onlyEntries. * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -256,7 +256,7 @@ $ ycli datalens collections breadcrumbs-list [OPTIONS] COLLECTION_ID **Options**: * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -276,7 +276,7 @@ $ ycli datalens collections permissions-get-root [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -304,7 +304,7 @@ $ ycli datalens collections access-bindings-list [OPTIONS] COLLECTION_ID * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--get-inherited-bindings / --no-get-inherited-bindings`: Also list the inherited roles. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -327,7 +327,7 @@ $ ycli datalens collections create [OPTIONS] * `--title TEXT`: Title of the collection. [required] * `--parent-id TEXT`: The collection to put it in; the root when left out. * `--description TEXT`: Description of the collection. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -353,7 +353,7 @@ $ ycli datalens collections update [OPTIONS] COLLECTION_ID * `--title TEXT`: New title. * `--description TEXT`: New description. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -379,7 +379,7 @@ $ ycli datalens collections move [OPTIONS] COLLECTION_ID * `--parent-id TEXT`: The collection to put it in; the root when left out. * `--title TEXT`: New title to give it on the way. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -404,7 +404,7 @@ $ ycli datalens collections move-bulk [OPTIONS] COLLECTION_ID... **Options**: * `--parent-id TEXT`: The collection to put it in; the root when left out. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -428,7 +428,7 @@ $ ycli datalens collections delete [OPTIONS] COLLECTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -452,7 +452,7 @@ $ ycli datalens collections delete-bulk [OPTIONS] COLLECTION_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -477,7 +477,7 @@ $ ycli datalens collections access-bindings-update [OPTIONS] COLLECTION_ID **Options**: * `--delta TEXT`: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -531,7 +531,7 @@ $ ycli datalens workbooks get [OPTIONS] WORKBOOK_ID **Options**: * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -560,7 +560,7 @@ $ ycli datalens workbooks list [OPTIONS] * `--order-direction TEXT`: Sort direction. Known values: asc, desc. * `--only-my / --no-only-my`: Keep only what you created. * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -584,7 +584,7 @@ $ ycli datalens workbooks list-by-ids [OPTIONS] WORKBOOK_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -612,7 +612,7 @@ $ ycli datalens workbooks access-bindings-list [OPTIONS] WORKBOOK_ID * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--get-inherited-bindings / --no-get-inherited-bindings`: Also list the inherited roles. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -645,7 +645,7 @@ $ ycli datalens workbooks entries-list [OPTIONS] WORKBOOK_ID * `--scope TEXT`: Keep only this kind of entry (repeatable). Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query. * `--order-by TEXT`: What to sort by, as a JSON object: {"field": "name", "direction": "asc"}. * `--filters TEXT`: A filter, as a JSON object: {"name": "sales"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -668,7 +668,7 @@ $ ycli datalens workbooks create [OPTIONS] * `--title TEXT`: Title of the workbook. [required] * `--collection-id TEXT`: The collection to put it in; the root when left out. * `--description TEXT`: Description of the workbook. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -694,7 +694,7 @@ $ ycli datalens workbooks update [OPTIONS] WORKBOOK_ID * `--title TEXT`: New title. * `--description TEXT`: New description. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -720,7 +720,7 @@ $ ycli datalens workbooks move [OPTIONS] WORKBOOK_ID * `--collection-id TEXT`: The collection to put it in; the root when left out. * `--title TEXT`: New title to give it on the way. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -745,7 +745,7 @@ $ ycli datalens workbooks move-bulk [OPTIONS] WORKBOOK_ID... **Options**: * `--collection-id TEXT`: The collection to put it in; the root when left out. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -769,7 +769,7 @@ $ ycli datalens workbooks delete [OPTIONS] WORKBOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -793,7 +793,7 @@ $ ycli datalens workbooks delete-bulk [OPTIONS] WORKBOOK_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -818,7 +818,7 @@ $ ycli datalens workbooks access-bindings-update [OPTIONS] WORKBOOK_ID **Options**: * `--delta TEXT`: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -866,7 +866,7 @@ $ ycli datalens entrylocks create [OPTIONS] ENTRY_ID **Options**: * `--data TEXT`: The terms of the lock, as a JSON object: {"duration": 300000, "force": false} (the duration in milliseconds). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -891,7 +891,7 @@ $ ycli datalens entrylocks extend [OPTIONS] ENTRY_ID **Options**: * `--data TEXT`: The lock and its new terms, as a JSON object: {"lockToken": "...", "duration": 600000}. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -916,7 +916,7 @@ $ ycli datalens entrylocks delete [OPTIONS] ENTRY_ID **Options**: * `--params TEXT`: Which lock to release, as a JSON object: {"lockToken": "..."}, or {"force": true} for a lock held by another. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -966,7 +966,7 @@ $ ycli datalens sparkclusters list [OPTIONS] * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--collection-id TEXT`: Keep the clusters of one collection. * `--filter TEXT`: A filter expression of the API (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -990,7 +990,7 @@ $ ycli datalens sparkclusters get [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1019,7 +1019,7 @@ $ ycli datalens sparkclusters create [OPTIONS] * `--config TEXT`: The Spark version and the pools of the driver and executors, as a JSON object; --body-file gives it under `config`. * `--description TEXT`: A description of the cluster. * `--labels TEXT`: Labels, as a JSON object: {"team": "bi"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1043,7 +1043,7 @@ $ ycli datalens sparkclusters delete [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1067,7 +1067,7 @@ $ ycli datalens sparkclusters start [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1091,7 +1091,7 @@ $ ycli datalens sparkclusters stop [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1115,7 +1115,7 @@ $ ycli datalens sparkclusters resource-presets-list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1140,7 +1140,7 @@ $ ycli datalens sparkclusters resource-presets-get [OPTIONS] RESOURCE_PRESET_ID **Options**: * `--cloud-environment-id TEXT`: The cloud environment the presets are for. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1190,7 +1190,7 @@ $ ycli datalens htmlpages get [OPTIONS] ENTRY_ID * `--branch TEXT`: The version to read when no revision is named: saved or published. Known values: saved, published. * `--include-permissions / --no-include-permissions`: Also say what you may do with the page. * `--include-favorite / --no-include-favorite`: Also say whether the page is a favourite. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1218,7 +1218,7 @@ $ ycli datalens htmlpages create [OPTIONS] * `--key TEXT`: The page's key, in a folder. * `--workbook-id TEXT`: The workbook to create the page in. * `--name TEXT`: The page's name. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1249,7 +1249,7 @@ $ ycli datalens htmlpages update [OPTIONS] ENTRY_ID * `--content TEXT`: The HTML of the page; --body-file gives it under `content`. * `--rev-id TEXT`: A revision to make current, in place of new content. * `--annotation TEXT`: A description of the page, as JSON: {"description": "…"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1273,7 +1273,7 @@ $ ycli datalens htmlpages delete [OPTIONS] ENTRY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1301,7 +1301,7 @@ $ ycli datalens htmlpages preview-url-get [OPTIONS] ENTRY_ID * `--rev-id TEXT`: One revision, as it is; give it or --branch, not both. * `--lang TEXT`: Language of the preview. Known values: en, ru. * `--theme TEXT`: Theme of the preview. Known values: light, dark, light-hc, dark-hc, system. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1346,7 +1346,7 @@ $ ycli datalens members list [OPTIONS] * `--search TEXT`: Keep the names or addresses that have this. * `--tab-id TEXT`: Keep one kind of subject. Known values: SUBJECT_TYPE_UNSPECIFIED, USER_ACCOUNT, GROUP, INVITEE, SERVICE_ACCOUNT, _system. * `--filter TEXT`: A filter expression of the API. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1404,7 +1404,7 @@ $ ycli datalens entries list [OPTIONS] * `--ignore-workbook-entries / --no-ignore-workbook-entries`: Leave out the entries of workbooks. * `--ignore-shared-entries / --no-ignore-shared-entries`: Leave out the shared entries. * `--include-data / --no-include-data`: Also give the content of each. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1434,7 +1434,7 @@ $ ycli datalens entries relations-list [OPTIONS] ENTRY_ID... * `--link-direction TEXT`: `from`: what they use; `to`: what uses them. * `--include-permissions-info / --no-include-permissions-info`: Also say what you may do with it. * `--scope TEXT`: Keep one kind of related entry. Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1458,7 +1458,7 @@ $ ycli datalens entries permissions-get [OPTIONS] ENTRY_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1486,7 +1486,7 @@ $ ycli datalens entries revisions-list [OPTIONS] ENTRY_ID * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--rev-id TEXT`: Keep this revision (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1511,7 +1511,7 @@ $ ycli datalens entries rename [OPTIONS] ENTRY_ID **Options**: * `--name TEXT`: The new name. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1554,7 +1554,7 @@ $ ycli datalens permissions get-bulk [OPTIONS] * `--entry-id TEXT`: An entry id (repeatable). * `--workbook-id TEXT`: A workbook id (repeatable). * `--collection-id TEXT`: A collection id (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1602,7 +1602,7 @@ $ ycli datalens connections get [OPTIONS] CONNECTION_ID * `--workbook-id TEXT`: The workbook the connection lies in. * `--binded-dataset-id TEXT`: A dataset bound to it, to read it through. * `--rev-id TEXT`: The revision to read; the current by default. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1625,7 +1625,7 @@ $ ycli datalens connections create [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1652,7 +1652,7 @@ $ ycli datalens connections update [OPTIONS] CONNECTION_ID **Options**: * `--data TEXT`: The fields to change, as a JSON object: {"host": "db2.example.net"}. --body-file and -F give them under `data` (-F 'data[port]=8443'). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1684,7 +1684,7 @@ $ ycli datalens connections delete [OPTIONS] CONNECTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1733,7 +1733,7 @@ $ ycli datalens datasets get [OPTIONS] DATASET_ID * `--workbook-id TEXT`: The workbook the dataset lies in. * `--rev-id TEXT`: The revision to read; the current by default. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1764,7 +1764,7 @@ $ ycli datalens datasets create [OPTIONS] * `--rev-id TEXT`: The revision. * `--saved-id TEXT`: The saved revision. * `--workbook-id TEXT`: The workbook to create it in. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1792,7 +1792,7 @@ $ ycli datalens datasets update [OPTIONS] DATASET_ID * `--data TEXT`: What to save, as a JSON object: {"dataset": {...}, "mode": "save"}. --body-file gives it under `data`. * `--workbook-id TEXT`: The workbook the dataset lies in. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1821,7 +1821,7 @@ $ ycli datalens datasets delete [OPTIONS] DATASET_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1848,7 +1848,7 @@ $ ycli datalens datasets validate [OPTIONS] DATASET_ID * `--workbook-id TEXT`: The workbook the dataset lies in. * `--binded-dataset-id TEXT`: A dataset bound to this one. * `--data TEXT`: What to check, as a JSON object: {"dataset": {...}, "updates": [...]}. --body-file gives it under `data`. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1879,7 +1879,7 @@ $ ycli datalens datasets data-get [OPTIONS] DATASET_ID * `--sort TEXT`: A sorting rule, as a JSON object: {"guid": "...", "direction": "asc"} (repeatable). * `--limit INTEGER`: The most rows to return; 100 by default. * `--offset INTEGER`: How many rows to skip; above zero it needs --sort. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1928,7 +1928,7 @@ $ ycli datalens charts data-get [OPTIONS] CHART_ID **Options**: * `--params TEXT`: Values for the chart's parameters, as a JSON object: {"year": "2026", "city": ["Moscow", "Kazan"]}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1979,7 +1979,7 @@ $ ycli datalens charts wizard get [OPTIONS] CHART_ID * `--include-links / --no-include-links`: Also say what it is linked to. * `--include-favorite / --no-include-favorite`: Also say whether it is a favourite. * `--branch TEXT`: The version to read when no revision is named: saved or published. A save writes the saved one: read `saved` before you change a chart. Known values: saved, published. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2007,7 +2007,7 @@ $ ycli datalens charts wizard create [OPTIONS] * `--key TEXT`: The entry's key, in a folder. * `--workbook-id TEXT`: The workbook to create it in. * `--name TEXT`: The chart's name. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2040,7 +2040,7 @@ $ ycli datalens charts wizard update [OPTIONS] CHART_ID * `--data TEXT`: What the chart holds, as a JSON object; --body-file gives it under `data`. * `--annotation TEXT`: A description, as a JSON object: {"description": "…"}. * `--rev-id TEXT`: The revision the change is made on; DataLens does not check it (measured). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2070,7 +2070,7 @@ $ ycli datalens charts wizard delete [OPTIONS] CHART_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2121,7 +2121,7 @@ $ ycli datalens charts ql get [OPTIONS] CHART_ID * `--include-links / --no-include-links`: Also say what it is linked to. * `--include-favorite / --no-include-favorite`: Also say whether it is a favourite. * `--branch TEXT`: The version to read when no revision is named: saved or published. A save writes the saved one: read `saved` before you change a chart. Known values: saved, published. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2147,7 +2147,7 @@ $ ycli datalens charts ql create [OPTIONS] * `--key TEXT`: The entry's key, in a folder. * `--workbook-id TEXT`: The workbook to create it in. * `--name TEXT`: The chart's name. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2178,7 +2178,7 @@ $ ycli datalens charts ql update [OPTIONS] ENTRY_ID * `--mode TEXT`: Keep the change as a draft, or publish it. Known values: save, publish. [required] * `--data TEXT`: What the chart holds, as a JSON object (its query and how it is shown); --body-file gives it under `data`. * `--annotation TEXT`: A description, as a JSON object: {"description": "…"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2202,7 +2202,7 @@ $ ycli datalens charts ql delete [OPTIONS] CHART_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2253,7 +2253,7 @@ $ ycli datalens charts editor get [OPTIONS] CHART_ID * `--include-links / --no-include-links`: Also say what it is linked to. * `--include-favorite / --no-include-favorite`: Also say whether it is a favourite. * `--branch TEXT`: The version to read when no revision is named: saved or published. A save writes the saved one: read `saved` before you change a chart. Known values: saved, published. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2274,7 +2274,7 @@ $ ycli datalens charts editor create [OPTIONS] **Options**: * `--entry TEXT`: The chart, as a JSON object; `type` says which kind it is. --body-file gives it under `entry`. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2299,7 +2299,7 @@ $ ycli datalens charts editor update [OPTIONS] * `--mode TEXT`: Keep the change as a draft, or publish it. Known values: save, publish. [required] * `--entry TEXT`: The chart, as a JSON object; `type` says which kind it is. --body-file gives it under `entry`. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2323,7 +2323,7 @@ $ ycli datalens charts editor delete [OPTIONS] CHART_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2376,7 +2376,7 @@ $ ycli datalens dashboards get [OPTIONS] DASHBOARD_ID * `--include-favorite / --no-include-favorite`: Also say whether the dashboard is a favourite. * `--branch TEXT`: The version to read when no revision is named: saved or published. A save writes the saved one: read `saved` before you change a dashboard. Known values: saved, published. * `--workbook-id TEXT`: The workbook the dashboard lies in. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2400,7 +2400,7 @@ $ ycli datalens dashboards create [OPTIONS] **Options**: * `--entry TEXT`: The dashboard, as a JSON object; --body-file gives it under `entry`. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2426,7 +2426,7 @@ $ ycli datalens dashboards update [OPTIONS] * `--mode TEXT`: Keep the dashboard as a draft, or publish it. Known values: save, publish. [required] * `--entry TEXT`: The dashboard, as a JSON object; --body-file gives it under `entry`. * `--lock-token TEXT`: The token of the lock held on it, when it is locked. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2451,7 +2451,7 @@ $ ycli datalens dashboards delete [OPTIONS] DASHBOARD_ID **Options**: * `--lock-token TEXT`: The token of the lock held on it, when it is locked. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2501,7 +2501,7 @@ $ ycli datalens reports get [OPTIONS] ENTRY_ID * `--rev-id TEXT`: The revision of the report to read; the current one. * `--include-permissions / --no-include-permissions`: Also say what you may do with the report. * `--include-favorite / --no-include-favorite`: Also say whether the report is a favourite. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2531,7 +2531,7 @@ $ ycli datalens reports create [OPTIONS] * `--key TEXT`: The report's key, in a folder. * `--workbook-id TEXT`: The workbook to create the report in. * `--name TEXT`: The report's name. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2567,7 +2567,7 @@ $ ycli datalens reports update [OPTIONS] ENTRY_ID * `--meta TEXT`: Metadata of the entry, as a JSON object or `null`; the API requires it. * `--rev-id TEXT`: The revision of the report to change; DataLens does not check it (measured). * `--annotation TEXT`: A description of the report, as JSON: {"description": "…"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2591,7 +2591,7 @@ $ ycli datalens reports delete [OPTIONS] ENTRY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2639,7 +2639,7 @@ $ ycli datalens workbookexports start [OPTIONS] WORKBOOK_ID **Options**: * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2663,7 +2663,7 @@ $ ycli datalens workbookexports status-get [OPTIONS] EXPORT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2690,7 +2690,7 @@ $ ycli datalens workbookexports result-get [OPTIONS] EXPORT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2716,7 +2716,7 @@ $ ycli datalens workbookexports cancel [OPTIONS] EXPORT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2767,7 +2767,7 @@ $ ycli datalens workbookimports start [OPTIONS] * `--collection-id TEXT`: The collection to make it in; the root if not. * `--description TEXT`: The description of the new workbook. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2791,7 +2791,7 @@ $ ycli datalens workbookimports status-get [OPTIONS] IMPORT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2836,7 +2836,7 @@ $ ycli datalens embeds list [OPTIONS] ENTRY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2864,7 +2864,7 @@ $ ycli datalens embeds create [OPTIONS] * `--deps-ids TEXT`: An entry the embedded one depends on (repeatable). * `--unsigned-params TEXT`: A parameter a link may carry unsigned (repeatable). * `--private-params TEXT`: A parameter that goes signed, in the token (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2895,7 +2895,7 @@ $ ycli datalens embeds update [OPTIONS] EMBED_ID * `--deps-ids TEXT`: An entry the embedded one depends on (repeatable). * `--unsigned-params TEXT`: A parameter a link may carry unsigned (repeatable). * `--private-params TEXT`: A parameter that goes signed, in the token (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2919,7 +2919,7 @@ $ ycli datalens embeds delete [OPTIONS] EMBED_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2964,7 +2964,7 @@ $ ycli datalens embeddingsecrets get [OPTIONS] EMBEDDING_SECRET_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2988,7 +2988,7 @@ $ ycli datalens embeddingsecrets list [OPTIONS] WORKBOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3013,7 +3013,7 @@ $ ycli datalens embeddingsecrets create [OPTIONS] * `--title TEXT`: The name of the key. [required] * `--workbook-id TEXT`: The workbook the key belongs to. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3037,7 +3037,7 @@ $ ycli datalens embeddingsecrets delete [OPTIONS] EMBEDDING_SECRET_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3084,7 +3084,7 @@ $ ycli datalens sharedentries access-bindings-list [OPTIONS] ENTRY_ID * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--get-inherited-bindings / --no-get-inherited-bindings`: Also list the inherited roles. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3109,7 +3109,7 @@ $ ycli datalens sharedentries access-bindings-update [OPTIONS] ENTRY_ID **Options**: * `--delta TEXT`: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3153,7 +3153,7 @@ $ ycli datalens audit entries-updates-list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3178,7 +3178,7 @@ $ ycli datalens audit entry-permissions-get [OPTIONS] ENTRY_ID... **Options**: * `--user-id TEXT`: The user's id, as `createdBy` of an entry gives it. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3227,7 +3227,7 @@ $ ycli datalens sqlqueries get [OPTIONS] SQL_QUERY_ID * `--rev-id TEXT`: The revision to read; the current if not. * `--include-permissions / --no-include-permissions`: Also say what you may do with the query. * `--include-favorite / --no-include-favorite`: Also say whether the query is a favourite. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3257,7 +3257,7 @@ $ ycli datalens sqlqueries create [OPTIONS] * `--query TEXT`: The text of the query. * `--description TEXT`: A description. * `--params TEXT`: The parameters the text takes, as a JSON array: [{"name": "since", "type": "date", "defaultValue": "2026-01-01"}]. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3287,7 +3287,7 @@ $ ycli datalens sqlqueries update [OPTIONS] SQL_QUERY_ID * `--query TEXT`: The text of the query. * `--description TEXT`: A description. * `--params TEXT`: The parameters the text takes, as a JSON array: [{"name": "since", "type": "date", "defaultValue": "2026-01-01"}]. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3313,7 +3313,7 @@ $ ycli datalens sqlqueries delete [OPTIONS] SQL_QUERY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3340,7 +3340,7 @@ $ ycli datalens sqlqueries run [OPTIONS] SQL_QUERY_ID **Options**: * `--params TEXT`: The values of the parameters, as a JSON object: {"since": "2026-10-01"}. A parameter left out takes its default. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3390,7 +3390,7 @@ $ ycli datalens licensing licenses-list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3414,7 +3414,7 @@ $ ycli datalens licensing licenses-assign [OPTIONS] USER_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3436,7 +3436,7 @@ $ ycli datalens licensing limit-get [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3460,7 +3460,7 @@ $ ycli datalens licensing limit-set [OPTIONS] VALUE **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3509,7 +3509,7 @@ $ ycli datalens cloudenvironments list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3534,7 +3534,7 @@ $ ycli datalens cloudenvironments get [OPTIONS] ID **Options**: * `--include-permissions / --no-include-permissions`: Also say what you may do with the environment. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3560,7 +3560,7 @@ $ ycli datalens cloudenvironments create [OPTIONS] * `--description TEXT`: A description. * `--security-group-ids TEXT`: A security group it uses (repeatable). * `--storage TEXT`: The settings of its storage bucket, as a JSON object: {"maxSize": "0"} (bytes; zero is unlimited). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3590,7 +3590,7 @@ $ ycli datalens cloudenvironments update [OPTIONS] ID * `--description TEXT`: A new description; empty clears it. * `--security-group-ids TEXT`: A security group it uses (repeatable). * `--storage TEXT`: The settings of its storage bucket, as a JSON object: {"maxSize": "0"} (bytes; zero is unlimited). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3616,7 +3616,7 @@ $ ycli datalens cloudenvironments delete [OPTIONS] ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3667,7 +3667,7 @@ $ ycli datalens cloudenvironmentstorage bucket-objects-list [OPTIONS] CLOUD_ENVI * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3694,7 +3694,7 @@ $ ycli datalens cloudenvironmentstorage bucket-object-metadata-get [OPTIONS] CLO **Options**: * `--path TEXT`: The path of the object in the bucket. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3721,7 +3721,7 @@ $ ycli datalens cloudenvironmentstorage bucket-download-url-create [OPTIONS] CLO **Options**: * `--path TEXT`: The path of the object in the bucket. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3750,7 +3750,7 @@ $ ycli datalens cloudenvironmentstorage bucket-upload-url-create [OPTIONS] CLOUD * `--path TEXT`: The path of the object in the bucket. [required] * `--size TEXT`: The size of the object in bytes. [required] * `--content-md5 TEXT`: The MD5 digest of the content, base64-encoded. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3799,7 +3799,7 @@ $ ycli datalens restcatalogs list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3824,7 +3824,7 @@ $ ycli datalens restcatalogs create [OPTIONS] * `--bucket-settings TEXT`: The settings of its bucket, as a JSON object: {"storageClass": "STANDARD", "maxSize": "1073741824"}, or {}. [required] * `--description TEXT`: A description. * `--labels TEXT`: Labels, as a JSON object: {"team": "analytics"}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3868,7 +3868,7 @@ $ ycli datalens lakehouseoperations get [OPTIONS] OPERATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3923,7 +3923,7 @@ $ ycli datalens trinoclusters list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3947,7 +3947,7 @@ $ ycli datalens trinoclusters get [OPTIONS] ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3977,7 +3977,7 @@ $ ycli datalens trinoclusters create [OPTIONS] * `--labels TEXT`: Labels, as a JSON object: {"team": "analytics"}. * `--catalogs-config TEXT`: A REST catalog to attach, as a JSON object: {"catalogId": "…"} (repeatable). * `--trino-version TEXT`: The version of Trino; the service's own if not. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4003,7 +4003,7 @@ $ ycli datalens trinoclusters delete [OPTIONS] ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4029,7 +4029,7 @@ $ ycli datalens trinoclusters start [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4055,7 +4055,7 @@ $ ycli datalens trinoclusters stop [OPTIONS] CLUSTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4082,7 +4082,7 @@ $ ycli datalens trinoclusters catalog-create [OPTIONS] CLUSTER_ID **Options**: * `--catalog TEXT`: The REST catalog to attach, as a JSON object: {"catalogId": "…"}. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4109,7 +4109,7 @@ $ ycli datalens trinoclusters catalog-delete [OPTIONS] CLUSTER_ID **Options**: * `--catalog-id TEXT`: The id of the REST catalog to detach. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4138,7 +4138,7 @@ $ ycli datalens trinoclusters resource-presets-list [OPTIONS] CLOUD_ENVIRONMENT_ * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4165,7 +4165,7 @@ $ ycli datalens trinoclusters resource-preset-get [OPTIONS] RESOURCE_PRESET_ID **Options**: * `--cloud-environment-id TEXT`: The cloud environment the presets are of. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4217,7 +4217,7 @@ $ ycli datalens sparkapplications list [OPTIONS] CLUSTER_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4244,7 +4244,7 @@ $ ycli datalens sparkapplications get [OPTIONS] CLUSTER_ID **Options**: * `--application-id TEXT`: Id of the Spark application. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4278,7 +4278,7 @@ $ ycli datalens sparkapplications create [OPTIONS] CLUSTER_ID * `--spark-application TEXT`: An application in a JAR, as a JSON object: {"mainJarFileUri": "…", "mainClass": "…", "args": ["…"]}. * `--pyspark-application TEXT`: An application in a Python file, as a JSON object: {"mainPythonFileUri": "…", "args": ["…"]}. * `--spark-connect-application TEXT`: A Spark Connect application, as a JSON object: {"properties": {"…": "…"}}. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4305,7 +4305,7 @@ $ ycli datalens sparkapplications cancel [OPTIONS] CLUSTER_ID **Options**: * `--application-id TEXT`: Id of the Spark application. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4334,7 +4334,7 @@ $ ycli datalens sparkapplications log-list [OPTIONS] CLUSTER_ID * `--application-id TEXT`: Id of the Spark application. [required] * `--page-size INTEGER`: The most characters the fragment may hold. * `--page-token TEXT`: The token of the fragment to read; the first if not. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/forms.md b/docs/en/reference/cli/forms.md index eb7124683..6c4178d3d 100644 --- a/docs/en/reference/cli/forms.md +++ b/docs/en/reference/cli/forms.md @@ -69,7 +69,7 @@ $ ycli forms auth status [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -107,7 +107,7 @@ $ ycli forms me get [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -161,7 +161,7 @@ $ ycli forms surveys list [OPTIONS] * `--favourite / --no-favourite`: Only favourites (or only the others). * `--show-all / --no-show-all`: As an administrator, every form of the organization. * `--orderby TEXT`: Sort, e.g. name,-modified,-count. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -185,7 +185,7 @@ $ ycli forms surveys get [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -211,7 +211,7 @@ $ ycli forms surveys create [OPTIONS] * `--public / --no-public`: Ignored by the API: the reply reports whether the form is public, a request cannot set it. * `--need-auth / --no-need-auth`: Require sign-in to fill. * `--max-count INTEGER`: Maximum number of responses (0: no cap). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -241,7 +241,7 @@ $ ycli forms surveys update [OPTIONS] SURVEY_ID * `--public / --no-public`: Ignored by the API: the reply reports whether the form is public, a request cannot set it. * `--need-auth / --no-need-auth`: Toggle sign-in requirement. * `--max-count INTEGER`: New response cap (0 removes the cap). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -265,7 +265,7 @@ $ ycli forms surveys delete [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -289,7 +289,7 @@ $ ycli forms surveys publish [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -313,7 +313,7 @@ $ ycli forms surveys unpublish [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -360,7 +360,7 @@ $ ycli forms questions list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -386,7 +386,7 @@ $ ycli forms questions get [OPTIONS] SURVEY_ID QUESTION_ID **Options**: * `--with-slugs / --no-with-slugs`: Refer to other questions by slug, not id. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -420,7 +420,7 @@ $ ycli forms questions create [OPTIONS] SURVEY_ID * `--multiline / --no-multiline`: Multiline text (string type). * `--widget TEXT`: How an enum question shows its options. Known values: radio, checkbox, dropdown, stars, onerow. * `--option TEXT`: Enum option label (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -455,7 +455,7 @@ $ ycli forms questions update [OPTIONS] SURVEY_ID QUESTION_ID * `--multiline / --no-multiline`: Multiline text (string type). * `--widget TEXT`: How an enum question shows its options. Known values: radio, checkbox, dropdown, stars, onerow. * `--option TEXT`: Enum option label (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -481,7 +481,7 @@ $ ycli forms questions delete [OPTIONS] SURVEY_ID QUESTION_ID **Options**: * `--force / --no-force`: Ignored by the API: a question that a display condition refers to is refused all the same. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -514,7 +514,7 @@ $ ycli forms questions move [OPTIONS] SURVEY_ID QUESTION_ID * `--position INTEGER`: New position on the page, 1-based. * `--create-page / --no-create-page`: Create a new page for the question. * `--question TEXT`: Question id/slug to move into a question series. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -583,7 +583,7 @@ $ ycli forms conditions question list [OPTIONS] SURVEY_ID QUESTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -609,7 +609,7 @@ $ ycli forms conditions question get [OPTIONS] SURVEY_ID QUESTION_ID CONDITION_I **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -636,7 +636,7 @@ $ ycli forms conditions question create [OPTIONS] SURVEY_ID QUESTION_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -664,7 +664,7 @@ $ ycli forms conditions question update [OPTIONS] SURVEY_ID QUESTION_ID CONDITIO * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -690,7 +690,7 @@ $ ycli forms conditions question delete [OPTIONS] SURVEY_ID QUESTION_ID CONDITIO **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -716,7 +716,7 @@ $ ycli forms conditions question update-operator [OPTIONS] SURVEY_ID QUESTION_ID **Options**: * `--operator TEXT`: Boolean operator. Known values: and, or. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -764,7 +764,7 @@ $ ycli forms conditions page list [OPTIONS] SURVEY_ID PAGE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -790,7 +790,7 @@ $ ycli forms conditions page get [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -817,7 +817,7 @@ $ ycli forms conditions page create [OPTIONS] SURVEY_ID PAGE_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -845,7 +845,7 @@ $ ycli forms conditions page update [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -871,7 +871,7 @@ $ ycli forms conditions page delete [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -897,7 +897,7 @@ $ ycli forms conditions page update-operator [OPTIONS] SURVEY_ID PAGE_ID **Options**: * `--operator TEXT`: Boolean operator. Known values: and, or. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -944,7 +944,7 @@ $ ycli forms conditions submit list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -969,7 +969,7 @@ $ ycli forms conditions submit get [OPTIONS] SURVEY_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -995,7 +995,7 @@ $ ycli forms conditions submit create [OPTIONS] SURVEY_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1022,7 +1022,7 @@ $ ycli forms conditions submit update [OPTIONS] SURVEY_ID CONDITION_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1047,7 +1047,7 @@ $ ycli forms conditions submit delete [OPTIONS] SURVEY_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1072,7 +1072,7 @@ $ ycli forms conditions submit update-operator [OPTIONS] SURVEY_ID **Options**: * `--operator TEXT`: Boolean operator. Known values: and, or. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1120,7 +1120,7 @@ $ ycli forms conditions hook list [OPTIONS] SURVEY_ID HOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1146,7 +1146,7 @@ $ ycli forms conditions hook get [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1173,7 +1173,7 @@ $ ycli forms conditions hook create [OPTIONS] SURVEY_ID HOOK_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1201,7 +1201,7 @@ $ ycli forms conditions hook update [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID * `--operator TEXT`: Boolean operator. Known values: and, or. * `--item TEXT`: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1227,7 +1227,7 @@ $ ycli forms conditions hook delete [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1253,7 +1253,7 @@ $ ycli forms conditions hook update-operator [OPTIONS] SURVEY_ID HOOK_ID **Options**: * `--operator TEXT`: Boolean operator. Known values: and, or. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1298,7 +1298,7 @@ $ ycli forms access list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1324,7 +1324,7 @@ $ ycli forms access update [OPTIONS] SURVEY_ID * `--action TEXT`: Action: change (edit, read answers) or submit (fill in). [required] * `--access TEXT`: Level of access. Known values: owner, restricted, common, public. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1353,7 +1353,7 @@ $ ycli forms access grant [OPTIONS] SURVEY_ID * `--cloud-uid TEXT`: User's Yandex Cloud uid. * `--group-src TEXT`: Where the group is kept. Known values: dir, cloud, com, staff. * `--group-id TEXT`: Group id within its source. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1382,7 +1382,7 @@ $ ycli forms access revoke [OPTIONS] SURVEY_ID * `--cloud-uid TEXT`: User's Yandex Cloud uid. * `--group-src TEXT`: Where the group is kept. Known values: dir, cloud, com, staff. * `--group-id TEXT`: Group id within its source. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1428,7 +1428,7 @@ $ ycli forms history list [OPTIONS] SURVEY_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1475,7 +1475,7 @@ $ ycli forms answers get [OPTIONS] * `--answer-id INTEGER`: Numeric answer id (needs form-edit access). * `--answer-key TEXT`: Answer key hash (works without form-edit access). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1508,7 +1508,7 @@ $ ycli forms answers list [OPTIONS] SURVEY_ID * `--ordering TEXT`: asc is oldest first; the default is desc. Known values: asc, desc. * `--page-size INTEGER`: Answers per request (the API's default is 25). * `--answer-format TEXT`: default is cells by column, raw is as stored. Known values: default, raw. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1563,7 +1563,7 @@ $ ycli forms answers integrations-list [OPTIONS] * `--answer-id INTEGER`: Numeric answer id (needs form-edit access). * `--answer-key TEXT`: Answer key hash (works without form-edit access). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1588,7 +1588,7 @@ $ ycli forms answers delete [OPTIONS] SURVEY_ID ANSWER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1613,7 +1613,7 @@ $ ycli forms answers restore [OPTIONS] SURVEY_ID ANSWER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1660,7 +1660,7 @@ $ ycli forms keysets list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1685,7 +1685,7 @@ $ ycli forms keysets get [OPTIONS] SURVEY_ID KEYSET_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1714,7 +1714,7 @@ $ ycli forms keysets create [OPTIONS] SURVEY_ID * `--name TEXT`: Key set name. [required] * `--total INTEGER`: Number of keys to generate. [required] * `--enabled / --disabled`: Create the set active (required — the API rejects a create without it). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1744,7 +1744,7 @@ $ ycli forms keysets update [OPTIONS] SURVEY_ID KEYSET_ID * `--name TEXT`: Key set name (required — replaces the record). [required] * `--total INTEGER`: Number of keys (required — replaces the record); the API refuses a number smaller than the set has now. [required] * `--enabled / --disabled`: Active flag (required). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1769,7 +1769,7 @@ $ ycli forms keysets delete [OPTIONS] SURVEY_ID KEYSET_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1795,7 +1795,7 @@ $ ycli forms keysets download [OPTIONS] SURVEY_ID KEYSET_ID **Options**: * `--output TEXT`: Write bytes to this path; omit / '-' streams to stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1837,7 +1837,7 @@ $ ycli forms operations get [OPTIONS] OPERATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1898,7 +1898,7 @@ $ ycli forms notifications list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1922,7 +1922,7 @@ $ ycli forms notifications get [OPTIONS] NOTIFICATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1946,7 +1946,7 @@ $ ycli forms notifications status-get [OPTIONS] NOTIFICATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1970,7 +1970,7 @@ $ ycli forms notifications restart [OPTIONS] NOTIFICATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1994,7 +1994,7 @@ $ ycli forms notifications cancel [OPTIONS] NOTIFICATION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2018,7 +2018,7 @@ $ ycli forms notifications errors-list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2064,7 +2064,7 @@ $ ycli forms files upload [OPTIONS] SURVEY_ID FILE_PATH **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2090,7 +2090,7 @@ $ ycli forms files verify [OPTIONS] SURVEY_ID * `--path TEXT`: File path to check (repeatable). * `--url TEXT`: File URL to check (repeatable, paired to --path). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2114,7 +2114,7 @@ $ ycli forms files download [OPTIONS] * `-O, --output TEXT`: Write to this path; omit or '-' for stdout. * `--download / --no-download`: Ask the API for a Content-Disposition filename header. * `--hash TEXT`: Access hash from the upload response (anonymous download). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2136,7 +2136,7 @@ $ ycli forms files delete [OPTIONS] * `--path TEXT`: File download path (from an upload response). * `--url TEXT`: File download URL (from an upload response). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2180,7 +2180,7 @@ $ ycli forms images upload [OPTIONS] SURVEY_ID IMAGE_PATH **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2207,7 +2207,7 @@ $ ycli forms images clone [OPTIONS] SURVEY_ID * `--image-id INTEGER`: Id of the image to clone. * `--name TEXT`: Ignored by the API: the clone keeps the file name of the original. * `--link TEXT`: SIZE=URL of the image to clone (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2252,7 +2252,7 @@ $ ycli forms filling get [OPTIONS] SURVEY_ID **Options**: * `--key TEXT`: Personal-link fill key, when the form uses one. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2281,7 +2281,7 @@ $ ycli forms filling submit [OPTIONS] SURVEY_ID * `--validate-only / --no-validate-only`: Validate only — save nothing, fire no integrations. * `--key TEXT`: Personal-link fill key, when the form uses one. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2309,7 +2309,7 @@ $ ycli forms filling suggest [OPTIONS] SURVEY_ID * `--text TEXT`: Text to search suggestions for. * `--suggest-id TEXT`: Comma-separated suggestion-object ids to resolve. * `--parent-id TEXT`: Parent ids for a Master/Detail lookup. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2355,7 +2355,7 @@ $ ycli forms hooks list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2380,7 +2380,7 @@ $ ycli forms hooks get [OPTIONS] SURVEY_ID HOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2406,7 +2406,7 @@ $ ycli forms hooks create [OPTIONS] SURVEY_ID * `--name TEXT`: Integration group name (max 100 characters). * `--active / --inactive`: Run the group's integrations, or pause them. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2433,7 +2433,7 @@ $ ycli forms hooks update [OPTIONS] SURVEY_ID HOOK_ID * `--name TEXT`: Integration group name (max 100 characters). * `--active / --inactive`: Run the group's integrations, or pause them. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2458,7 +2458,7 @@ $ ycli forms hooks delete [OPTIONS] SURVEY_ID HOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2506,7 +2506,7 @@ $ ycli forms subscriptions list [OPTIONS] SURVEY_ID HOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2532,7 +2532,7 @@ $ ycli forms subscriptions get [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2557,7 +2557,7 @@ $ ycli forms subscriptions create [OPTIONS] SURVEY_ID HOOK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2583,7 +2583,7 @@ $ ycli forms subscriptions update [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2609,7 +2609,7 @@ $ ycli forms subscriptions delete [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2636,7 +2636,7 @@ $ ycli forms subscriptions attach [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID FI **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2678,7 +2678,7 @@ $ ycli forms variables list [OPTIONS] SURVEY_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/index.md b/docs/en/reference/cli/index.md index da60f1874..14d8baa43 100644 --- a/docs/en/reference/cli/index.md +++ b/docs/en/reference/cli/index.md @@ -25,7 +25,7 @@ $ ycli [OPTIONS] COMMAND [ARGS]... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). [default: auto] +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). [default: auto] * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/mcp.md b/docs/en/reference/cli/mcp.md index 3b343997d..ceeff3aac 100644 --- a/docs/en/reference/cli/mcp.md +++ b/docs/en/reference/cli/mcp.md @@ -44,7 +44,7 @@ $ ycli mcp start [OPTIONS] * `--transport [stdio|http]`: stdio (default): one local client, credentials from the environment or from --profile. http: Streamable HTTP for many users, each signed in through Yandex ID (needs YCLI__MCP__BASE_URL and your Yandex OAuth app; see https://ycli.savaznatnov.dev/how-to/self-host-over-http/). [default: stdio] * `--host TEXT`: HTTP only: listen address (YCLI__MCP__HOST). * `--port INTEGER`: HTTP only: listen port (YCLI__MCP__PORT). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -73,7 +73,7 @@ $ ycli mcp methods [OPTIONS] * `--read-only`: Serve only read tools (hide every write-tagged tool); wins over --tools. * `--tool-search`: List a search tool and a call proxy instead of the tools (BM25); status_get and schema_get stay. * `--kind [tools|prompts|resources]`: What to list: tools (default), prompts, or resources (addresses and templates). [default: tools] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/sync.md b/docs/en/reference/cli/sync.md index 5f91318cd..72496105b 100644 --- a/docs/en/reference/cli/sync.md +++ b/docs/en/reference/cli/sync.md @@ -40,7 +40,7 @@ $ ycli sync kinds [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -71,7 +71,7 @@ $ ycli sync status [OPTIONS] [PATHS]... * `--kind TEXT`: Keep the files of this kind, e.g. wiki/page (repeatable). * `--show-unchanged`: Also list the files that were not edited. * `--exit-code`: Exit with 7 when there is something to push. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -99,7 +99,7 @@ $ ycli sync validate [OPTIONS] [PATHS]... **Options**: * `--kind TEXT`: Keep the files of this kind, e.g. wiki/page (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -129,7 +129,7 @@ $ ycli sync pull [OPTIONS] PATH * `--kind TEXT`: Keep the files of this kind, e.g. wiki/page (repeatable). * `--show-unchanged`: Also list the files that were the same. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -162,7 +162,7 @@ $ ycli sync diff [OPTIONS] [PATHS]... * `--show-unchanged`: Also list the files with nothing to push. * `--show-secrets`: Show secrets as they are, not masked. * `--exit-code`: Exit with 7 when there is something to push, 8 when a file and its object went apart. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -196,7 +196,7 @@ $ ycli sync push [OPTIONS] [PATHS]... * `--show-unchanged`: Also list the files with nothing to push. * `--prune COMMIT`: Also delete the objects whose files were deleted since this commit. * `--on-error [fail|abort]`: After a file fails: go on to the next, or end the run. [default: fail] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/tracker.md b/docs/en/reference/cli/tracker.md index 97f940c6c..a4b656688 100644 --- a/docs/en/reference/cli/tracker.md +++ b/docs/en/reference/cli/tracker.md @@ -87,7 +87,7 @@ $ ycli tracker auth status [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -125,7 +125,7 @@ $ ycli tracker me get [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -181,7 +181,7 @@ $ ycli tracker issues get [OPTIONS] ISSUE_KEY * `--expand TEXT`: Extra blocks to include in the reply. * `--fields TEXT`: Comma-separated fields to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -209,7 +209,7 @@ $ ycli tracker issues list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -242,7 +242,7 @@ $ ycli tracker issues search [OPTIONS] QUERY * `--scroll-type TEXT`: Scroll through the results (no 10 000 cap). Known values: sorted, unsorted. * `--per-scroll INTEGER`: Issues per scroll page (1000 at most). * `--scroll-ttl-millis INTEGER`: How long the scroll stays open, in milliseconds. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -268,7 +268,7 @@ $ ycli tracker issues count [OPTIONS] * `--query TEXT`: TQL query (mutually exclusive with filters). * `--queue TEXT`: Queue key. * `--status TEXT`: Status key. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -296,7 +296,7 @@ $ ycli tracker issues create [OPTIONS] * `--description TEXT`: Markdown body — pass "$(cat file.md)". * `--tag TEXT`: Tag (repeatable). * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -326,7 +326,7 @@ $ ycli tracker issues update [OPTIONS] ISSUE_KEY * `--parent TEXT`: New parent issue key. * `--description TEXT`: New markdown body — pass "$(cat file.md)"; "" clears it. * `--tag TEXT`: Tag (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -356,7 +356,7 @@ $ ycli tracker issues move [OPTIONS] ISSUE_KEY QUEUE * `--move-all-fields / --no-move-all-fields`: Keep the versions, components and projects the new queue also has. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -385,7 +385,7 @@ $ ycli tracker issues suggest [OPTIONS] INPUT * `--fields TEXT`: Comma-separated fields to include in the reply. * `--expand TEXT`: Extra blocks to include in the reply. * `--embed TEXT`: Blocks of --expand to return in more detail. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -408,7 +408,7 @@ $ ycli tracker issues scroll-clear [OPTIONS] **Options**: * `--pair TEXT`: scrollId=scrollToken pair to release (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -433,7 +433,7 @@ $ ycli tracker issues update-bulk [OPTIONS] * `-F, --field TEXT`: Field to set, key=value (JSON-coerced; repeatable). key[sub]=value nests, and key=@FILE (@- for stdin) gives the file's text; a string that starts with @ goes in JSON quotes. * `--notify / --no-notify`: Notify affected users. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -463,7 +463,7 @@ $ ycli tracker issues move-bulk [OPTIONS] QUEUE * `--initial-status / --no-initial-status`: Reset each issue's status to the initial one. * `--notify / --no-notify`: Notify affected users. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -491,7 +491,7 @@ $ ycli tracker issues transition-bulk [OPTIONS] TRANSITION * `-F, --field TEXT`: Field to set, key=value (JSON-coerced; repeatable). key[sub]=value nests, and key=@FILE (@- for stdin) gives the file's text; a string that starts with @ goes in JSON quotes. * `--notify / --no-notify`: Notify affected users. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -517,7 +517,7 @@ $ ycli tracker issues import [OPTIONS] * `--key TEXT`: Explicit issue key (must belong to the queue). * `--description TEXT`: Issue description (YFM). * `--assignee TEXT`: Assignee login or id. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -569,7 +569,7 @@ $ ycli tracker comments list [OPTIONS] ISSUE_KEY * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--expand TEXT`: Extra blocks to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -595,7 +595,7 @@ $ ycli tracker comments get [OPTIONS] ISSUE_KEY COMMENT_ID **Options**: * `--expand TEXT`: Extra fields: attachments, html or all (comma-separated). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -620,7 +620,7 @@ $ ycli tracker comments create [OPTIONS] ISSUE_KEY **Options**: * `--text TEXT`: Comment text — pass "$(cat note.md)" for markdown. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -646,7 +646,7 @@ $ ycli tracker comments update [OPTIONS] ISSUE_KEY COMMENT_ID **Options**: * `--text TEXT`: New comment text (YFM markdown supported). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -671,7 +671,7 @@ $ ycli tracker comments delete [OPTIONS] ISSUE_KEY COMMENT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -697,7 +697,7 @@ $ ycli tracker comments reactions-create [OPTIONS] ISSUE_KEY COMMENT_ID NAME **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -724,7 +724,7 @@ $ ycli tracker comments import [OPTIONS] ISSUE_KEY * `--text TEXT`: Comment text. [required] * `--created-at TEXT`: Original creation time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--created-by TEXT`: Login or id of the original author. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -770,7 +770,7 @@ $ ycli tracker links list [OPTIONS] ISSUE_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -799,7 +799,7 @@ $ ycli tracker links list-filtered [OPTIONS] ISSUE_KEY * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -825,7 +825,7 @@ $ ycli tracker links create [OPTIONS] ISSUE_KEY RELATIONSHIP TARGET **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -850,7 +850,7 @@ $ ycli tracker links delete [OPTIONS] ISSUE_KEY LINK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -878,7 +878,7 @@ $ ycli tracker links import [OPTIONS] ISSUE_KEY * `--issue TEXT`: Key or id of the issue to link to. [required] * `--created-at TEXT`: Original creation time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--created-by TEXT`: Login or id of the original author. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -921,7 +921,7 @@ $ ycli tracker transitions list [OPTIONS] ISSUE_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -946,7 +946,7 @@ $ ycli tracker transitions execute [OPTIONS] ISSUE_KEY ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -997,7 +997,7 @@ $ ycli tracker worklog list [OPTIONS] ISSUE_KEY * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1020,7 +1020,7 @@ $ ycli tracker worklog search [OPTIONS] * `--created-by TEXT`: Author login or id. * `--created-from TEXT`: Range start, YYYY-MM-DDThh:mm:ss. * `--created-to TEXT`: Range end, YYYY-MM-DDThh:mm:ss. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1043,7 +1043,7 @@ $ ycli tracker worklog list-global [OPTIONS] * `--created-by TEXT`: Author login or id. * `--created-from TEXT`: Range start, YYYY-MM-DDThh:mm:ss. * `--created-to TEXT`: Range end, YYYY-MM-DDThh:mm:ss. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1070,7 +1070,7 @@ $ ycli tracker worklog create [OPTIONS] ISSUE_KEY * `--duration TEXT`: Time spent, ISO-8601 duration (e.g. PT2H, PT300M, P1DT3H). [required] * `--start TEXT`: Work start time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--comment TEXT`: Optional note saved in the time report. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1097,7 +1097,7 @@ $ ycli tracker worklog update [OPTIONS] ISSUE_KEY RECORD_ID * `--duration TEXT`: New time spent, ISO-8601 duration. * `--comment TEXT`: New note for the time report. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1122,7 +1122,7 @@ $ ycli tracker worklog delete [OPTIONS] ISSUE_KEY RECORD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1151,7 +1151,7 @@ $ ycli tracker worklog import [OPTIONS] ISSUE_KEY * `--created-by TEXT`: Login or id of the original author. [required] * `--start TEXT`: Work start time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--comment TEXT`: Optional note saved in the time report. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1199,7 +1199,7 @@ $ ycli tracker changelog list [OPTIONS] ISSUE_KEY * `--field TEXT`: Only changes of this field, e.g. status. * `--change-type TEXT`: Only changes of this type, e.g. IssueWorkflow. * `--sort TEXT`: Order of the changes. Known values: asc, desc. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1244,7 +1244,7 @@ $ ycli tracker checklists list [OPTIONS] ISSUE_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1273,7 +1273,7 @@ $ ycli tracker checklists create [OPTIONS] ISSUE_KEY * `--assignee TEXT`: Assignee login or id. * `--deadline TEXT`: Deadline date, YYYY-MM-DDThh:mm:ss.sss±hhmm. * `--deadline-type TEXT`: Deadline kind: date or quarter; the API requires it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1303,7 +1303,7 @@ $ ycli tracker checklists update [OPTIONS] ISSUE_KEY ITEM_ID * `--assignee TEXT`: Assignee login or id. * `--deadline TEXT`: Deadline date, YYYY-MM-DDThh:mm:ss.sss±hhmm. * `--deadline-type TEXT`: Deadline kind: date or quarter; the API requires it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1328,7 +1328,7 @@ $ ycli tracker checklists delete [OPTIONS] ISSUE_KEY ITEM_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1352,7 +1352,7 @@ $ ycli tracker checklists clear [OPTIONS] ISSUE_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1398,7 +1398,7 @@ $ ycli tracker columns list [OPTIONS] BOARD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1423,7 +1423,7 @@ $ ycli tracker columns get [OPTIONS] BOARD_ID COLUMN_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1449,7 +1449,7 @@ $ ycli tracker columns create [OPTIONS] BOARD_ID * `--name TEXT`: Name of the new column. [required] * `--status TEXT`: Status key for the column (repeatable). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1476,7 +1476,7 @@ $ ycli tracker columns update [OPTIONS] BOARD_ID COLUMN_ID * `--name TEXT`: New column name. * `--status TEXT`: Replacement status key (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1501,7 +1501,7 @@ $ ycli tracker columns delete [OPTIONS] BOARD_ID COLUMN_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1542,7 +1542,7 @@ $ ycli tracker priorities list [OPTIONS] **Options**: * `--localized / --no-localized`: --no-localized returns the names in every language. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1567,7 +1567,7 @@ $ ycli tracker priorities create [OPTIONS] * `--name-ru TEXT`: Priority name in Russian. * `--name-en TEXT`: Priority name in English. * `--description TEXT`: Description of the priority. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1595,7 +1595,7 @@ $ ycli tracker priorities update [OPTIONS] PRIORITY_ID * `--name-en TEXT`: New priority name in English. * `--description TEXT`: New description of the priority. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1635,7 +1635,7 @@ $ ycli tracker issuetypes list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1658,7 +1658,7 @@ $ ycli tracker issuetypes create [OPTIONS] * `--key TEXT`: Key of the new issue type. [required] * `--name-ru TEXT`: Issue type name in Russian. * `--name-en TEXT`: Issue type name in English. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1685,7 +1685,7 @@ $ ycli tracker issuetypes update [OPTIONS] ISSUE_TYPE_ID * `--name-ru TEXT`: New issue type name in Russian. * `--name-en TEXT`: New issue type name in English. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1723,7 +1723,7 @@ $ ycli tracker linktypes list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1767,7 +1767,7 @@ $ ycli tracker users get [OPTIONS] LOGIN_OR_ID **Options**: * `--expand TEXT`: Extra data to include, e.g. groups. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1791,7 +1791,7 @@ $ ycli tracker users list [OPTIONS] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--expand TEXT`: Extra data to include, e.g. groups. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1831,7 +1831,7 @@ $ ycli tracker statuses list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1855,7 +1855,7 @@ $ ycli tracker statuses create [OPTIONS] * `--type TEXT`: Status type. Known values: new, inProgress, paused, done, cancelled. [required] * `--name-ru TEXT`: Status name in Russian. * `--name-en TEXT`: Status name in English. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1885,7 +1885,7 @@ $ ycli tracker statuses update [OPTIONS] STATUS_ID * `--type TEXT`: New status type. Known values: new, inProgress, paused, done, cancelled. * `--order INTEGER`: New display-order weight. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1925,7 +1925,7 @@ $ ycli tracker resolutions list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1948,7 +1948,7 @@ $ ycli tracker resolutions create [OPTIONS] * `--key TEXT`: Key of the new resolution (Latin, lower-case start). [required] * `--name-ru TEXT`: Resolution name in Russian. * `--name-en TEXT`: Resolution name in English. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1977,7 +1977,7 @@ $ ycli tracker resolutions update [OPTIONS] RESOLUTION_ID * `--description TEXT`: New resolution description. * `--order INTEGER`: New display-order weight. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2034,7 +2034,7 @@ $ ycli tracker queues list [OPTIONS] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--expand TEXT`: Extra blocks to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2059,7 +2059,7 @@ $ ycli tracker queues get [OPTIONS] QUEUE_ID **Options**: * `--expand TEXT`: Extra blocks to include, e.g. all or types,team,versions. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2083,7 +2083,7 @@ $ ycli tracker queues tags-list [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2107,7 +2107,7 @@ $ ycli tracker queues versions-list [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2131,7 +2131,7 @@ $ ycli tracker queues fields-list [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2157,7 +2157,7 @@ $ ycli tracker queues create [OPTIONS] * `--default-type TEXT`: Key/id of the default issue type. [required] * `--default-priority TEXT`: Key/id of the default priority. [required] * `--issue-type-config TEXT`: issueTypesConfig row as JSON, e.g. '{"issueType":"task","workflow":"oicn"}' (repeatable; a queue needs at least one). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2181,7 +2181,7 @@ $ ycli tracker queues delete [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2205,7 +2205,7 @@ $ ycli tracker queues restore [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2240,7 +2240,7 @@ $ ycli tracker queues permissions-update [OPTIONS] QUEUE_ID * `--write TEXT`: Edit-issue permission scope as a JSON object. * `--read TEXT`: Read-issue permission scope as a JSON object. * `--grant TEXT`: Change-settings permission scope as a JSON object. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2265,7 +2265,7 @@ $ ycli tracker queues tags-delete [OPTIONS] QUEUE_ID TAG **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2290,7 +2290,7 @@ $ ycli tracker queues versions-create [OPTIONS] * `--description TEXT`: Description of the version. * `--start-date TEXT`: Version start date (YYYY-MM-DD). * `--due-date TEXT`: Version due date (YYYY-MM-DD). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2315,7 +2315,7 @@ $ ycli tracker queues versions-get [OPTIONS] VERSION_ID **Options**: * `--fields TEXT`: Comma-separated fields to return, e.g. name,dueDate,released. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2344,7 +2344,7 @@ $ ycli tracker queues versions-update [OPTIONS] VERSION_ID * `--start-date TEXT`: New version start date (YYYY-MM-DD). * `--due-date TEXT`: New version due date (YYYY-MM-DD). * `--fields TEXT`: Comma-separated fields to return, e.g. name,dueDate,released. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2368,7 +2368,7 @@ $ ycli tracker queues versions-delete [OPTIONS] VERSION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2393,7 +2393,7 @@ $ ycli tracker queues user-permissions-get [OPTIONS] QUEUE_ID USER **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2418,7 +2418,7 @@ $ ycli tracker queues group-permissions-get [OPTIONS] QUEUE_ID GROUP_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2463,7 +2463,7 @@ $ ycli tracker localfields list [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2488,7 +2488,7 @@ $ ycli tracker localfields get [OPTIONS] QUEUE_ID FIELD_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2522,7 +2522,7 @@ $ ycli tracker localfields create [OPTIONS] QUEUE_ID * `--readonly / --no-readonly`: Whether the field value is read-only. * `--option TEXT`: Allowed drop-down value (repeatable). * `--options-type TEXT`: Drop-down provider type for --option values. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2557,7 +2557,7 @@ $ ycli tracker localfields update [OPTIONS] QUEUE_ID FIELD_KEY * `--hidden / --no-hidden`: Fully hide the field. * `--option TEXT`: Allowed drop-down value (repeatable). * `--options-type TEXT`: Drop-down provider type for --option values. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2600,7 +2600,7 @@ $ ycli tracker fields list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2624,7 +2624,7 @@ $ ycli tracker fields get [OPTIONS] FIELD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2656,7 +2656,7 @@ $ ycli tracker fields create [OPTIONS] * `--readonly / --no-readonly`: Whether the field value is read-only. * `--option TEXT`: Allowed drop-down value (repeatable). * `--options-type TEXT`: Drop-down provider type for --option values. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2685,7 +2685,7 @@ $ ycli tracker fields update [OPTIONS] FIELD_ID * `--option TEXT`: Allowed drop-down value (repeatable). * `--options-type TEXT`: Drop-down provider type for --option values. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2709,7 +2709,7 @@ $ ycli tracker fields categories-create [OPTIONS] * `--name-ru TEXT`: Category name in Russian. * `--name-en TEXT`: Category name in English. * `--description TEXT`: Description of the category. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2738,7 +2738,7 @@ $ ycli tracker fields categories-update [OPTIONS] CATEGORY_ID * `--order INTEGER`: New display-order weight. * `--description TEXT`: New description of the category. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2783,7 +2783,7 @@ $ ycli tracker components list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2808,7 +2808,7 @@ $ ycli tracker components create [OPTIONS] * `--description TEXT`: Text description of the component. * `--lead TEXT`: Login of the component's owner (lead). * `--assign-auto / --no-assign-auto`: Auto-assign the owner to issues. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2837,7 +2837,7 @@ $ ycli tracker components update [OPTIONS] COMPONENT_ID * `--lead TEXT`: New login of the component's owner (lead). * `--assign-auto / --no-assign-auto`: Auto-assign the owner to issues. * `--version INTEGER`: Current version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2862,7 +2862,7 @@ $ ycli tracker components list-for-queue [OPTIONS] QUEUE_ID **Options**: * `--fields TEXT`: Comma-separated fields to return, e.g. name,description,lead. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2887,7 +2887,7 @@ $ ycli tracker components get [OPTIONS] COMPONENT_ID **Options**: * `--fields TEXT`: Comma-separated fields to return, e.g. name,description,lead. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2911,7 +2911,7 @@ $ ycli tracker components delete [OPTIONS] COMPONENT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2936,7 +2936,7 @@ $ ycli tracker components user-permissions-get [OPTIONS] COMPONENT_ID USER **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -2961,7 +2961,7 @@ $ ycli tracker components group-permissions-get [OPTIONS] COMPONENT_ID GROUP_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3006,7 +3006,7 @@ $ ycli tracker filters get [OPTIONS] FILTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3029,7 +3029,7 @@ $ ycli tracker filters create [OPTIONS] * `--name TEXT`: Display name of the new filter. [required] * `--query TEXT`: Filtering conditions in Tracker query language. * `--filter TEXT`: Filtering conditions as a JSON object. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3056,7 +3056,7 @@ $ ycli tracker filters update [OPTIONS] FILTER_ID * `--name TEXT`: New display name of the filter. * `--query TEXT`: New filtering conditions in query language. * `--filter TEXT`: Replacement filtering conditions as a JSON object. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3080,7 +3080,7 @@ $ ycli tracker filters delete [OPTIONS] FILTER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3118,7 +3118,7 @@ $ ycli tracker applications list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3163,7 +3163,7 @@ $ ycli tracker boards list [OPTIONS] * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3187,7 +3187,7 @@ $ ycli tracker boards get [OPTIONS] BOARD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3212,7 +3212,7 @@ $ ycli tracker boards create [OPTIONS] * `--permissions TEXT`: Access template: 'private' or 'public'. * `--backlog / --no-backlog`: Enable the board backlog; the API takes it together with --sprints only. * `--sprints / --no-sprints`: Enable board sprints; the API takes them together with --backlog only. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3239,7 +3239,7 @@ $ ycli tracker boards update [OPTIONS] BOARD_ID * `--name TEXT`: New board name. * `--backlog / --no-backlog`: Enable the board backlog; the API takes it together with --sprints only. * `--sprints / --no-sprints`: Enable board sprints; the API takes them together with --backlog only. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3263,7 +3263,7 @@ $ ycli tracker boards delete [OPTIONS] BOARD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3311,7 +3311,7 @@ $ ycli tracker sprints list [OPTIONS] BOARD_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3335,7 +3335,7 @@ $ ycli tracker sprints get [OPTIONS] SPRINT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3359,7 +3359,7 @@ $ ycli tracker sprints create [OPTIONS] * `--name TEXT`: Name of the new sprint. [required] * `--start-date TEXT`: Planned start date (YYYY-MM-DD). [required] * `--end-date TEXT`: Planned end date (YYYY-MM-DD). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3388,7 +3388,7 @@ $ ycli tracker sprints update [OPTIONS] SPRINT_ID * `--end-date TEXT`: New end date (YYYY-MM-DD). * `--status TEXT`: New status. Known values: draft, in_progress, released, archived. * `--version INTEGER`: Current sprint version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3412,7 +3412,7 @@ $ ycli tracker sprints delete [OPTIONS] SPRINT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3437,7 +3437,7 @@ $ ycli tracker sprints start [OPTIONS] SPRINT_ID **Options**: * `--version INTEGER`: Current sprint version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3462,7 +3462,7 @@ $ ycli tracker sprints archive [OPTIONS] SPRINT_ID **Options**: * `--version INTEGER`: Current sprint version for the optimistic lock (?version=). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3512,7 +3512,7 @@ $ ycli tracker attachments list [OPTIONS] ISSUE **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3539,7 +3539,7 @@ $ ycli tracker attachments download [OPTIONS] ISSUE FILE_ID FILENAME **Options**: * `-O, --output TEXT`: Write to this path; omit or '-' for stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3565,7 +3565,7 @@ $ ycli tracker attachments thumbnails-download [OPTIONS] ISSUE FILE_ID **Options**: * `-O, --output TEXT`: Write to this path; omit or '-' for stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3590,7 +3590,7 @@ $ ycli tracker attachments get [OPTIONS] ISSUE FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3615,7 +3615,7 @@ $ ycli tracker attachments delete [OPTIONS] ISSUE FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3641,7 +3641,7 @@ $ ycli tracker attachments upload [OPTIONS] ISSUE FILE_PATH **Options**: * `--rename-to TEXT`: Store the file under this name instead of its own. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3666,7 +3666,7 @@ $ ycli tracker attachments upload-temp [OPTIONS] FILE_PATH **Options**: * `--rename-to TEXT`: Store the file under this name instead of its own. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3694,7 +3694,7 @@ $ ycli tracker attachments import [OPTIONS] ISSUE_KEY PATH * `--created-at TEXT`: Original creation time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--created-by TEXT`: Login or id of the original author. [required] * `--filename TEXT`: Override the attachment name (default: basename). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3723,7 +3723,7 @@ $ ycli tracker attachments import-for-comment [OPTIONS] ISSUE_KEY COMMENT_ID PAT * `--created-at TEXT`: Original creation time, YYYY-MM-DDThh:mm:ss.sss±hhmm. [required] * `--created-by TEXT`: Login or id of the original author. [required] * `--filename TEXT`: Override the attachment name (default: basename). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3769,7 +3769,7 @@ $ ycli tracker macros list [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3794,7 +3794,7 @@ $ ycli tracker macros get [OPTIONS] QUEUE_ID MACRO_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3821,7 +3821,7 @@ $ ycli tracker macros create [OPTIONS] QUEUE_ID * `--name TEXT`: Name of the new macro. [required] * `--body TEXT`: Comment text created when the macro runs. * `--issue-update TEXT`: Field→value issue changes as a JSON object. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3849,7 +3849,7 @@ $ ycli tracker macros update [OPTIONS] QUEUE_ID MACRO_ID * `--name TEXT`: New name of the macro. * `--body TEXT`: New comment text created when the macro runs. * `--issue-update TEXT`: Replacement field→value issue changes as a JSON object. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3874,7 +3874,7 @@ $ ycli tracker macros delete [OPTIONS] QUEUE_ID MACRO_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3923,7 +3923,7 @@ $ ycli tracker triggers list [OPTIONS] QUEUE_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3948,7 +3948,7 @@ $ ycli tracker triggers get [OPTIONS] QUEUE_ID TRIGGER_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -3979,7 +3979,7 @@ $ ycli tracker triggers create [OPTIONS] QUEUE_ID * `--action TEXT`: Trigger action as a JSON object (repeatable). * `--condition TEXT`: Trigger condition as a JSON object (repeatable). * `--active / --inactive`: Start active or disabled. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4009,7 +4009,7 @@ $ ycli tracker triggers update [OPTIONS] QUEUE_ID TRIGGER_ID * `--condition TEXT`: Trigger condition as a JSON object (repeatable). * `--active / --inactive`: Activate or disable the trigger. * `--version INTEGER`: Current trigger version (optimistic lock). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4038,7 +4038,7 @@ $ ycli tracker triggers webhook-log-list [OPTIONS] QUEUE_ID TRIGGER_ID * `--limit INTEGER`: Max records (API default 10, max 100). * `--date-from TEXT`: Range start (YYYY-MM-DDThh:mm:ss.sss±hhmm). * `--date-to TEXT`: Range end (YYYY-MM-DDThh:mm:ss.sss±hhmm). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4084,7 +4084,7 @@ $ ycli tracker autoactions get [OPTIONS] QUEUE_ID ACTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4119,7 +4119,7 @@ $ ycli tracker autoactions create [OPTIONS] QUEUE_ID * `--notify / --no-notify`: Send notifications when the autoaction runs. * `--interval-millis INTEGER`: Run interval in ms (default 3600000). * `--calendar-id INTEGER`: Working-calendar id for the active window. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4144,7 +4144,7 @@ $ ycli tracker autoactions logs-list [OPTIONS] QUEUE_ID ACTION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4170,7 +4170,7 @@ $ ycli tracker autoactions logs-get [OPTIONS] QUEUE_ID ACTION_ID RUN_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4213,7 +4213,7 @@ $ ycli tracker bulk get [OPTIONS] BULK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4240,7 +4240,7 @@ $ ycli tracker bulk issues-list [OPTIONS] BULK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4284,7 +4284,7 @@ $ ycli tracker remotelinks list [OPTIONS] ISSUE_KEY **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4312,7 +4312,7 @@ $ ycli tracker remotelinks create [OPTIONS] ISSUE_KEY * `--origin TEXT`: Identifier of an external application the organization has (`tracker applications list`). [required] * `--relationship TEXT`: Link type; RELATES is recommended, an unknown one is refused. [required] * `--backlink / --no-backlink`: Also create the mirror link in the app. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4337,7 +4337,7 @@ $ ycli tracker remotelinks delete [OPTIONS] ISSUE_KEY LINK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4379,7 +4379,7 @@ $ ycli tracker dashboards create [OPTIONS] * `--name TEXT`: Dashboard name. [required] * `--layout TEXT`: Layout mode, e.g. two-columns. * `--owner TEXT`: Owner login or id (defaults to creator). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4408,7 +4408,7 @@ $ ycli tracker dashboards widgets-create-cycle-time [OPTIONS] DASHBOARD_ID * `--from-status TEXT`: Status key work starts from (repeatable). * `--to-status TEXT`: Status key work ends at (repeatable). * `--mode TEXT`: Display mode, e.g. common-lines. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4469,7 +4469,7 @@ $ ycli tracker entities get [OPTIONS] ENTITY_TYPE ID * `--expand TEXT`: Extra info, e.g. attachments. * `--fields TEXT`: Comma-separated extra fields to include. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4504,7 +4504,7 @@ $ ycli tracker entities create [OPTIONS] ENTITY_TYPE * `--team-user TEXT`: Participant id/login (repeatable). * `--tag TEXT`: Tag (repeatable). * `--fields TEXT`: Comma-separated fields to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4542,7 +4542,7 @@ $ ycli tracker entities update [OPTIONS] ENTITY_TYPE ID * `--comment TEXT`: Comment to add with the change. * `--expand TEXT`: Extra blocks to include in the reply. * `--fields TEXT`: Comma-separated fields to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4568,7 +4568,7 @@ $ ycli tracker entities delete [OPTIONS] ENTITY_TYPE ID **Options**: * `--with-board / --no-with-board`: Also delete the entity's board. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4601,7 +4601,7 @@ $ ycli tracker entities search [OPTIONS] ENTITY_TYPE * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4632,7 +4632,7 @@ $ ycli tracker entities events-list [OPTIONS] ENTITY_TYPE ID * `--selected TEXT`: Event id to build the list around. * `--new-events-on-top / --no-new-events-on-top`: Newest events first. * `--direction TEXT`: forward (the default) or backward. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4657,7 +4657,7 @@ $ ycli tracker entities permissions-get [OPTIONS] ENTITY_TYPE ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4687,7 +4687,7 @@ $ ycli tracker entities permissions-update [OPTIONS] ENTITY_TYPE ID **Options**: * `--acl TEXT`: ACL change ACTION= where ACTION is grant or revoke, e.g. grant={"READ":{"users":["8000000000000002"]}} (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4712,7 +4712,7 @@ $ ycli tracker entities permissions-get-direct [OPTIONS] ENTITY_TYPE ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4739,7 +4739,7 @@ $ ycli tracker entities permissions-update-direct [OPTIONS] ENTITY_TYPE ID * `--grant TEXT`: Rights to add as JSON, e.g. '{"READ":{"users":["ann"]}}'. * `--revoke TEXT`: Rights to remove as JSON, e.g. '{"GRANT":{"roles":["OWNER"]}}'. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4766,7 +4766,7 @@ $ ycli tracker entities update-bulk [OPTIONS] ENTITY_TYPE * `--entity TEXT`: Entity id (repeatable). [required] * `--comment TEXT`: Comment to add to every entity. * `-F, --field TEXT`: Field to set on every entity: key=value (JSON-coerced; repeatable). key[sub]=value nests, and key=@FILE (@- for stdin) gives the file's text; a string that starts with @ goes in JSON quotes. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4789,7 +4789,7 @@ $ ycli tracker entities bulk-get [OPTIONS] BULK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4866,7 +4866,7 @@ $ ycli tracker entities comments list [OPTIONS] ENTITY_TYPE ID * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--expand TEXT`: Extra blocks to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4893,7 +4893,7 @@ $ ycli tracker entities comments get [OPTIONS] ENTITY_TYPE ID COMMENT_ID **Options**: * `--expand TEXT`: Extra blocks to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4924,7 +4924,7 @@ $ ycli tracker entities comments create [OPTIONS] ENTITY_TYPE ID * `--is-add-to-followers / --no-is-add-to-followers`: Add the comment's author to the followers (the API adds by default). * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4955,7 +4955,7 @@ $ ycli tracker entities comments update [OPTIONS] ENTITY_TYPE ID COMMENT_ID * `--is-add-to-followers / --no-is-add-to-followers`: Add the comment's author to the followers (the API adds by default). * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -4983,7 +4983,7 @@ $ ycli tracker entities comments delete [OPTIONS] ENTITY_TYPE ID COMMENT_ID * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5036,7 +5036,7 @@ $ ycli tracker entities checklists create [OPTIONS] ENTITY_TYPE ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5069,7 +5069,7 @@ $ ycli tracker entities checklists update [OPTIONS] ENTITY_TYPE ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5104,7 +5104,7 @@ $ ycli tracker entities checklists items-update [OPTIONS] ENTITY_TYPE ID ITEM_ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5134,7 +5134,7 @@ $ ycli tracker entities checklists items-delete [OPTIONS] ENTITY_TYPE ID ITEM_ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5163,7 +5163,7 @@ $ ycli tracker entities checklists delete [OPTIONS] ENTITY_TYPE ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5194,7 +5194,7 @@ $ ycli tracker entities checklists move [OPTIONS] ENTITY_TYPE ID ITEM_ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5240,7 +5240,7 @@ $ ycli tracker entities links list [OPTIONS] ENTITY_TYPE ID **Options**: * `--fields TEXT`: Comma-separated fields to include in the reply. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5267,7 +5267,7 @@ $ ycli tracker entities links create [OPTIONS] ENTITY_TYPE ID * `--relationship TEXT`: Link type, e.g. relates, depends on. [required] * `--entity TEXT`: Id of the entity to link to. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5293,7 +5293,7 @@ $ ycli tracker entities links delete [OPTIONS] ENTITY_TYPE ID RIGHT **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5340,7 +5340,7 @@ $ ycli tracker entities attachments list [OPTIONS] ENTITY_TYPE ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5366,7 +5366,7 @@ $ ycli tracker entities attachments get [OPTIONS] ENTITY_TYPE ID FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5392,7 +5392,7 @@ $ ycli tracker entities attachments download [OPTIONS] FILE_ID FILENAME **Options**: * `-O, --output TEXT`: Write to this path; omit or '-' for stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5422,7 +5422,7 @@ $ ycli tracker entities attachments attach [OPTIONS] ENTITY_TYPE ID TEMP_FILE_ID * `--fields TEXT`: Comma-separated fields to include in the reply. * `--notify / --no-notify`: Notify the users in the fields of the object (the API notifies by default). * `--notify-author / --no-notify-author`: Notify the author of the change (the API does not by default). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5448,7 +5448,7 @@ $ ycli tracker entities attachments delete [OPTIONS] ENTITY_TYPE ID FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5492,7 +5492,7 @@ $ ycli tracker workflows list [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5516,7 +5516,7 @@ $ ycli tracker workflows get [OPTIONS] WORKFLOW_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5540,7 +5540,7 @@ $ ycli tracker workflows list-for-queue [OPTIONS] QUEUE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5572,7 +5572,7 @@ $ ycli tracker workflows create [OPTIONS] * `--queue TEXT`: Queue key to bind to (shared if omitted). * `--visual`: Send type VISUAL (the only type today). * `--issue-type-resolution TEXT`: Resolutions of an issue type, e.g. '{"issueType":"task","resolutions":["fixed"]}' (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5604,7 +5604,7 @@ $ ycli tracker workflows update [OPTIONS] WORKFLOW_ID * `--step TEXT`: Step as a JSON object: status plus actions (repeatable). * `--visual`: Send type VISUAL (the only type today). * `--issue-type-resolution TEXT`: Resolutions of an issue type, e.g. '{"issueType":"task","resolutions":["fixed"]}' (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5632,7 +5632,7 @@ $ ycli tracker workflows actions-update [OPTIONS] WORKFLOW_ID STATUS ACTION_ID * `--version INTEGER`: Current version of the workflow (optimistic lock); see `workflows get`. [required] * `--action TEXT`: Action fields as a JSON object; Tracker requires name and target, e.g. '{"name":{"ru":"Закрыть"},"target":"closed"}'. [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5656,7 +5656,7 @@ $ ycli tracker workflows delete [OPTIONS] WORKFLOW_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5700,7 +5700,7 @@ $ ycli tracker projects list [OPTIONS] **Options**: * `--expand TEXT`: Extra blocks to include, e.g. queues. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5725,7 +5725,7 @@ $ ycli tracker projects get [OPTIONS] PROJECT_ID **Options**: * `--expand TEXT`: Extra blocks to include, e.g. queues. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5750,7 +5750,7 @@ $ ycli tracker projects queues-list [OPTIONS] PROJECT_ID **Options**: * `--expand TEXT`: Extra queue blocks, e.g. all or components,versions. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5779,7 +5779,7 @@ $ ycli tracker projects create [OPTIONS] * `--status TEXT`: Stage of the project. Known values: DRAFT, IN_PROGRESS, LAUNCHED, POSTPONED. * `--start-date TEXT`: Start date (YYYY-MM-DD). * `--end-date TEXT`: End date (YYYY-MM-DD). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5812,7 +5812,7 @@ $ ycli tracker projects update [OPTIONS] PROJECT_ID * `--start-date TEXT`: Start date (YYYY-MM-DD). * `--end-date TEXT`: End date (YYYY-MM-DD). * `--expand TEXT`: Extra blocks to include, e.g. queues. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5836,7 +5836,7 @@ $ ycli tracker projects delete [OPTIONS] PROJECT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5886,7 +5886,7 @@ $ ycli tracker gaps create [OPTIONS] * `--full-day / --part-day`: Whether it covers whole days. * `--work-in-absence / --no-work-in-absence`: Whether the user works. * `--gap TEXT`: More absences as JSON objects of the API docs (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5915,7 +5915,7 @@ $ ycli tracker gaps search [OPTIONS] USER... * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -5939,7 +5939,7 @@ $ ycli tracker gaps delete [OPTIONS] GAP_ID... **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/en/reference/cli/wiki.md b/docs/en/reference/cli/wiki.md index 3059c31cc..2f58f089a 100644 --- a/docs/en/reference/cli/wiki.md +++ b/docs/en/reference/cli/wiki.md @@ -63,7 +63,7 @@ $ ycli wiki auth status [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -101,7 +101,7 @@ $ ycli wiki me get [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -159,7 +159,7 @@ $ ycli wiki pages get [OPTIONS] SLUG * `--revision-id INTEGER`: Show this past revision (ids from `revisions-list`). * `--raise-on-redirect / --no-raise-on-redirect`: Fail if the page is a redirect, do not follow it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -183,7 +183,7 @@ $ ycli wiki pages get-meta [OPTIONS] SLUG **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -213,7 +213,7 @@ $ ycli wiki pages descendants-list [OPTIONS] SLUG * `--include-self / --no-include-self`: Also list the ancestor page itself. * `--show-all / --no-show-all`: The API's show_all flag. * `--actuality TEXT`: Only the pages in this state: actual or obsolete. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -240,7 +240,7 @@ $ ycli wiki pages get-by-id [OPTIONS] PAGE_ID * `--fields TEXT`: Comma-separated fields, e.g. content,attributes. * `--revision-id INTEGER`: Show this past revision (ids from `revisions-list`). * `--raise-on-redirect / --no-raise-on-redirect`: Fail if the page is a redirect, do not follow it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -270,7 +270,7 @@ $ ycli wiki pages descendants-list-by-id [OPTIONS] PAGE_ID * `--include-self / --no-include-self`: Also list the ancestor page itself. * `--show-all / --no-show-all`: The API's show_all flag. * `--actuality TEXT`: Only the pages in this state: actual or obsolete. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -299,7 +299,7 @@ $ ycli wiki pages grids-list [OPTIONS] PAGE_ID * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--order-by TEXT`: Sort field. Known values: title, created_at. * `--order-direction TEXT`: Sort direction for --order-by. Known values: asc, desc. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -324,7 +324,7 @@ $ ycli wiki pages create [OPTIONS] * `--content TEXT`: Markdown body — pass "$(cat file.md)". [required] * `--fields TEXT`: Comma-separated blocks to include in the reply. * `--is-silent / --no-is-silent`: Do not notify the page's subscribers. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -353,7 +353,7 @@ $ ycli wiki pages update [OPTIONS] PAGE_ID * `--fields TEXT`: Comma-separated blocks to include in the reply. * `--is-silent / --no-is-silent`: Do not notify the page's subscribers. * `--allow-merge / --no-allow-merge`: Merge with a concurrent edit instead of failing. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -378,7 +378,7 @@ $ ycli wiki pages delete [OPTIONS] PAGE_ID **Options**: * `--recursive / --no-recursive`: Also delete every page under it. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -409,7 +409,7 @@ $ ycli wiki pages append [OPTIONS] PAGE_ID * `--location TEXT`: Where in the body; without a placement the API answers 400. Known values: top, bottom. * `--fields TEXT`: Comma-separated blocks to include in the reply. * `--is-silent / --no-is-silent`: Do not notify the page's subscribers. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -437,7 +437,7 @@ $ ycli wiki pages clone [OPTIONS] PAGE_ID * `--title TEXT`: Title of the copy, if renaming. * `--subscribe-me / --no-subscribe-me`: Subscribe yourself to the copy. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -467,7 +467,7 @@ $ ycli wiki pages move [OPTIONS] SOURCE TARGET * `--copy-inherited-access / --no-copy-inherited-access`: Copy accesses inherited from the old parent; the API can refuse a move without a choice. * `--validate-only / --no-validate-only`: Validate the move without applying it (nothing to wait for). * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -495,7 +495,7 @@ $ ycli wiki pages revisions-list [OPTIONS] PAGE_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -524,7 +524,7 @@ $ ycli wiki pages backlinks-list [OPTIONS] PAGE_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -563,7 +563,7 @@ $ ycli wiki pages search [OPTIONS] QUERY * `--highlight / --no-highlight`: Wrap matches in tags. * `--limit INTEGER`: Results per page. * `--cursor INTEGER`: Result page to fetch, from 1 (see next_cursor). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -617,7 +617,7 @@ $ ycli wiki access create [OPTIONS] PAGE_ID * `--group-src TEXT`: Where the group is kept. Known values: dir, cloud, com, staff. * `--group-id TEXT`: Id of the group to grant in that directory. * `--inheritance TEXT`: Whether the access also covers subpages. Known values: inherited, not_inherited. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -645,7 +645,7 @@ $ ycli wiki access update [OPTIONS] PAGE_ID ACCESS_ID * `--role TEXT`: New role. Known values: reader, editor, extra_editor, author. * `--inheritance TEXT`: Whether the access also covers subpages. Known values: inherited, not_inherited. * `--prevent-selflock / --no-prevent-selflock`: Refuse the change if it would leave you without read access or the right to change accesses. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -671,7 +671,7 @@ $ ycli wiki access delete [OPTIONS] PAGE_ID ACCESS_ID **Options**: * `--prevent-selflock / --no-prevent-selflock`: Refuse the change if it would leave you without read access or the right to change accesses. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -696,7 +696,7 @@ $ ycli wiki access clear [OPTIONS] PAGE_ID **Options**: * `--prevent-selflock / --no-prevent-selflock`: Refuse the change if it would leave you without read access or the right to change accesses. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -748,7 +748,7 @@ $ ycli wiki comments list [OPTIONS] PAGE_ID * `--order-by TEXT`: Sort field: created_at. * `--order-direction TEXT`: Sort direction for --order-by. Known values: asc, desc. * `--status-filter TEXT`: Only comments in this state. Known values: resolved, unresolved. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -778,7 +778,7 @@ $ ycli wiki comments thread-list [OPTIONS] PAGE_ID COMMENT_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -809,7 +809,7 @@ $ ycli wiki comments thread-get [OPTIONS] PAGE_ID COMMENT_ID * `--limit INTEGER RANGE`: Max items to fetch (default: the configured cap). [x>=1] * `--all`: Fetch everything, ignoring the cap. * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -837,7 +837,7 @@ $ ycli wiki comments create [OPTIONS] PAGE_ID * `--inline-text TEXT`: Page fragment to pin the comment to. * `--parent-id INTEGER`: Reply to this comment id (threaded). * `--thread-id INTEGER`: File into this existing thread id. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -862,7 +862,7 @@ $ ycli wiki comments delete [OPTIONS] PAGE_ID COMMENT_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -916,7 +916,7 @@ $ ycli wiki attachments list [OPTIONS] PAGE_ID * `--next TOKEN`: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit. * `--order-by TEXT`: Sort field. Known values: name, size, created_at. * `--order-direction TEXT`: Sort direction for --order-by. Known values: asc, desc. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -941,7 +941,7 @@ $ ycli wiki attachments get [OPTIONS] PAGE_ID FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -970,7 +970,7 @@ $ ycli wiki attachments previews-download [OPTIONS] PAGE_ID FILE_ID **Options**: * `--output TEXT`: Write bytes to this path; omit / '-' streams to stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -996,7 +996,7 @@ $ ycli wiki attachments download [OPTIONS] PAGE_ID FILE_ID **Options**: * `--output TEXT`: Write bytes to this path; omit / '-' streams to stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1021,7 +1021,7 @@ $ ycli wiki attachments download-by-url [OPTIONS] URL **Options**: * `--output TEXT`: Write bytes to this path; omit / '-' streams to stdout. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1046,7 +1046,7 @@ $ ycli wiki attachments delete [OPTIONS] PAGE_ID FILE_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1071,7 +1071,7 @@ $ ycli wiki attachments attach [OPTIONS] PAGE_ID **Options**: * `--session-ids TEXT`: Finished upload-session id to attach (repeatable). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1096,7 +1096,7 @@ $ ycli wiki attachments upload [OPTIONS] PAGE_ID FILE_PATH **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1145,7 +1145,7 @@ $ ycli wiki resources list [OPTIONS] PAGE_ID * `--types TEXT`: Comma-separated kinds: attachment,grid. * `--order-by TEXT`: Sort field. Known values: name_title, created_at. * `--order-direction TEXT`: Sort direction for --order-by. Known values: asc, desc. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1187,7 +1187,7 @@ $ ycli wiki recovery recover [OPTIONS] TOKEN **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1242,7 +1242,7 @@ $ ycli wiki grids get [OPTIONS] GRID_ID * `--only-rows TEXT`: Only these row ids (CSV). * `--revision TEXT`: Load a historical revision. * `--sort TEXT`: Row sort, e.g. slug,-slug2. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1265,7 +1265,7 @@ $ ycli wiki grids create [OPTIONS] * `--title TEXT`: Title of the new grid. [required] * `--page-slug TEXT`: Target page slug, e.g. data/x. * `--page-id INTEGER`: Target page numeric id. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1295,7 +1295,7 @@ $ ycli wiki grids update [OPTIONS] GRID_ID * `--revision TEXT`: Grid revision the edit is based on. * `--title TEXT`: New grid title. * `--default-sort TEXT`: New default sort as JSON in the write shape '[{"": "asc"|"desc"}]', e.g. '[{"priority": "desc"}]'. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1319,7 +1319,7 @@ $ ycli wiki grids delete [OPTIONS] GRID_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1347,7 +1347,7 @@ $ ycli wiki grids clone [OPTIONS] GRID_ID * `--title TEXT`: Title of the copy, if renaming. * `--with-data / --no-with-data`: Copy the rows too, not just the structure. * `--wait / --no-wait`: Poll to a terminal status before printing. [default: wait] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1396,7 +1396,7 @@ $ ycli wiki grids rows create [OPTIONS] GRID_ID * `--revision TEXT`: Grid revision the edit is based on. * `--position INTEGER`: Zero-based target index. * `--after-row-id TEXT`: Insert after this row id. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1422,7 +1422,7 @@ $ ycli wiki grids rows delete [OPTIONS] GRID_ID * `--row-id TEXT`: Row id to delete (repeatable). [required] * `--revision TEXT`: Grid revision the edit is based on. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1451,7 +1451,7 @@ $ ycli wiki grids rows move [OPTIONS] GRID_ID * `--after-row-id TEXT`: Move to just after this row id. * `--position INTEGER`: Zero-based target index. * `--rows-count INTEGER`: How many consecutive rows to move. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1479,7 +1479,7 @@ $ ycli wiki grids rows update [OPTIONS] GRID_ID ROW_ID * `--revision TEXT`: Grid revision (this endpoint does not enforce it). * `--pinned / --no-pinned`: Pin or unpin the row. * `--color TEXT`: Row background colour. Known values: blue, yellow, pink, red, green, mint, grey, orange, magenta, purple, copper, ocean. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1530,7 +1530,7 @@ $ ycli wiki grids columns create [OPTIONS] GRID_ID * `--columns TEXT`: Columns as JSON, e.g. '[{"title":"C","type":"string","slug":"c"}]'. [required] * `--revision TEXT`: Grid revision the edit is based on. * `--position INTEGER`: Zero-based target index. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1556,7 +1556,7 @@ $ ycli wiki grids columns delete [OPTIONS] GRID_ID * `--column-slug TEXT`: Column slug to delete (repeatable). [required] * `--revision TEXT`: Grid revision the edit is based on. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1584,7 +1584,7 @@ $ ycli wiki grids columns move [OPTIONS] GRID_ID * `--position INTEGER`: Zero-based destination index. [required] * `--revision TEXT`: Grid revision the edit is based on. * `--columns-count INTEGER`: How many consecutive columns to move. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1612,7 +1612,7 @@ $ ycli wiki grids columns suggest [OPTIONS] GRID_ID * `--title TEXT`: Title to turn into a slug and check. * `--slug TEXT`: Slug to check. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1648,7 +1648,7 @@ $ ycli wiki grids columns update [OPTIONS] GRID_ID COLUMN_SLUG * `--pinned TEXT`: The edge to pin the column to. Known values: left, right. * `--color TEXT`: Column background colour. Known values: blue, yellow, pink, red, green, mint, grey, orange, magenta, purple, copper, ocean. * `--select-option TEXT`: Allowed choice of a select column (repeatable). -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1692,7 +1692,7 @@ $ ycli wiki grids cells update [OPTIONS] GRID_ID * `--cells TEXT`: Cells as JSON, e.g. '[{"row_id":1,"column_slug":"name","value":"x"}]'. [required] * `--revision TEXT`: Grid revision the edit is based on. -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1736,7 +1736,7 @@ $ ycli wiki operations clone-get [OPTIONS] TASK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1760,7 +1760,7 @@ $ ycli wiki operations clone-inline-grid-get [OPTIONS] TASK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1784,7 +1784,7 @@ $ ycli wiki operations move-get [OPTIONS] TASK_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1829,7 +1829,7 @@ $ ycli wiki uploadsessions create [OPTIONS] * `--file-name TEXT`: Name to give the uploaded file. [required] * `--file-size INTEGER`: Total file size in bytes (sum of all parts). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1853,7 +1853,7 @@ $ ycli wiki uploadsessions get [OPTIONS] SESSION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1879,7 +1879,7 @@ $ ycli wiki uploadsessions parts-upload [OPTIONS] SESSION_ID FILE_PATH **Options**: * `--part-number INTEGER`: 1-based part index (1 for the first part, +1 per next part). [required] -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1903,7 +1903,7 @@ $ ycli wiki uploadsessions finish [OPTIONS] SESSION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1927,7 +1927,7 @@ $ ycli wiki uploadsessions abort [OPTIONS] SESSION_ID **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. @@ -1947,7 +1947,7 @@ $ ycli wiki uploadsessions abort-all [OPTIONS] **Options**: -* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson]`: Output format (auto = pretty on a TTY, JSON when piped). +* `-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]`: Output format (auto = pretty on a TTY, JSON when piped). * `-y, --yes`: Do not ask before an operation that deletes data. * `--dry-run`: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***. * `--profile NAME`: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. `ycli auth profiles` lists them. diff --git a/docs/ru/how-to/script-the-cli.md b/docs/ru/how-to/script-the-cli.md index 66716886d..3f65d3a2a 100644 --- a/docs/ru/how-to/script-the-cli.md +++ b/docs/ru/how-to/script-the-cli.md @@ -7,7 +7,7 @@ type: how-to ## Получить JSON -В терминале ycli печатает таблицы, а при передаче по конвейеру — JSON. Формат можно задать явно глобальным флагом `--format` / `-o` (`auto`, `json`, `yaml`, `pretty`, `csv`, `markdown`, `ndjson`) до команды или после неё: +В терминале ycli печатает таблицы, а при передаче по конвейеру — JSON. Формат можно задать явно глобальным флагом `--format` / `-o` (`auto`, `json`, `yaml`, `pretty`, `csv`, `markdown`, `ndjson`, `name`) до команды или после неё: ```bash ycli tracker issues get TRACKER-1 | jq . # JSON, потому что вывод передаётся по конвейеру @@ -44,6 +44,21 @@ ycli tracker issues search 'Queue: TEST' -o ndjson | jq -r .key - `csv` — это UTF-8 без метки порядка байтов, строки кончаются одним переводом строки, а ячейка — текст сервиса как есть. Ячейку, которая начинается с `=`, таблица прочтёт как формулу: открывайте файл с чужим текстом, помня об этом. - Где список остановился, сказано в stderr, как и при `-o pretty`: в stdout только строки. +## Передать вывод одной команды другой + +`-o name` печатает идентификатор каждого объекта на отдельной строке: то, что принимает команда, которая его читает. + +```bash +ycli tracker issues search 'Queue: TEST' -o name | xargs -n1 ycli tracker issues get +new=$(ycli tracker issues create --queue TEST --summary 'From a script' -o name) +``` + +- Объект, который лежит внутри другого, печатает свой идентификатор: `ycli tracker comments list TEST-1 -o name` печатает id комментариев, а ключ задачи добавляете вы. +- Команде, у результата которой нет идентификатора (выдача доступа, счётчик), отказывают до отправки запроса, код возврата 2. +- Ответ, в котором у объекта нет идентификатора, — это ошибка: ничего не печатается, поэтому скрипт не обработает меньше объектов, чем было в списке. +- С `--dry-run` вместо объекта приходит план, и он печатается как JSON. +- Команды DataLens имён пока не печатают. + ## Длинный список по частям Список останавливается на 500 элементах, если не сказать иначе. `--limit N` берёт первые N, `--all` — всё, а `--next` продолжает с места, где остановился прошлый запуск. `-o json` и `-o yaml` печатают то же, что отдают инструмент MCP и SDK: `{items, truncated, next, total}`, так что скрипт берёт токен через `jq -r .next`. Таблица (`-o pretty`) печатает строки, а где список остановился — в stderr, готовой строкой. Строка говорит, что запуск остановился на лимите, а не что что-то осталось: это покажет только следующий запуск, и он может не дать ничего. diff --git a/src/ycli/cli/formats.py b/src/ycli/cli/formats.py index 9cd7fb481..83cdb2d58 100644 --- a/src/ycli/cli/formats.py +++ b/src/ycli/cli/formats.py @@ -13,3 +13,4 @@ class OutputFormat(enum.StrEnum): csv = "csv" markdown = "markdown" ndjson = "ndjson" + name = "name" diff --git a/src/ycli/cli/inject.py b/src/ycli/cli/inject.py index 8c8dec8b2..1b6173880 100644 --- a/src/ycli/cli/inject.py +++ b/src/ycli/cli/inject.py @@ -31,6 +31,7 @@ def get(survey_id: SurveyIDArg, *, forms: FormsClient) -> Survey: import typer from ycli.cli.context import AppContext +from ycli.cli.formats import OutputFormat from ycli.cli.global_options import ( NO_BODY, apply_leaf_values, @@ -38,7 +39,7 @@ def get(survey_id: SurveyIDArg, *, forms: FormsClient) -> Survey: leaf_parameters, refuse_fields, ) -from ycli.cli.output import Continuable, Declared +from ycli.cli.output import Continuable, Declared, has_names from ycli.yandex.core.continuation import HANDLES, NOTHING_ELSE from ycli.yandex.core.guard import RequestPlanned from ycli.yandex.core.listing import Listing @@ -49,6 +50,7 @@ def get(survey_id: SurveyIDArg, *, forms: FormsClient) -> Survey: _CONTEXT = "_ycli_typer_context" # What a command with its own ``-F`` says to the common one given before the subcommand. OWN_FIELD = "this command has a --field of its own; the common one before it has no use" +NO_NAME = "what this command prints has no identifier to print; nothing was sent" def inject_dependencies(app: typer.Typer) -> None: @@ -170,6 +172,12 @@ def run(*args: Any, **kwargs: Any) -> Any: # the name two meanings raise typer.BadParameter(OWN_FIELD, param_hint="-F") apply_leaf_values(kwargs, root.params) + # The choice is still the text given here: typer makes it an OutputFormat later. + if root.params.get("output_format") == OutputFormat.name and not has_names( + hints.get("return") + ): + # violation(arch-9): nothing to print in this format, so nothing is asked for + raise typer.BadParameter(NO_NAME, param_hint="-o name") if kwargs.get("next_") is not None: _only_the_limit(context, {parameter.name for parameter in leaf}) if not can_send: diff --git a/src/ycli/cli/output.py b/src/ycli/cli/output.py index 34d6c306b..ca99cef1f 100644 --- a/src/ycli/cli/output.py +++ b/src/ycli/cli/output.py @@ -37,7 +37,9 @@ from ycli.cli.formats import OutputFormat from ycli.yandex.core.listing import Listing +from ycli.yandex.errors import YandexUnexpectedReplyError from ycli.yandex.models import ItemList, Listed +from ycli.yandex.sync.marks import Identity if TYPE_CHECKING: from collections.abc import Iterator, Sequence @@ -75,6 +77,7 @@ def from_format( OutputFormat.csv: CSVStrategy, OutputFormat.markdown: MarkdownStrategy, OutputFormat.ndjson: NDJSONStrategy, + OutputFormat.name: NameStrategy, }[output_format](declared) @@ -366,6 +369,81 @@ def _escaped(cell: str) -> str: return cell.replace("|", "\\|").replace("\r\n", "
").replace("\n", "
") +def _identifier(kind: type) -> _Column | None: + """The column that names an object of ``kind``: its one field marked ``Identity()``. + + What is not an object (a tag, a number) is its own name. + """ + if not issubclass(kind, BaseModel): + return () + marked = [ + (field.serialization_alias or field.alias or name,) + for name, field in kind.model_fields.items() + if any(isinstance(mark, Identity) for mark in field.metadata) + ] + return marked[0] if len(marked) == 1 else None + + +def has_names(declared: object) -> bool: + """Whether ``-o name`` can print what a command says it returns. + + Args: + declared: The return type the command declares. + + Returns: + Whether every kind of row it returns has a field that names it. + + Examples: + >>> from ycli.yandex.models import Ack + >>> has_names(Listing[str]), has_names(Listing[Ack]), has_names(None) + (True, False, False) + """ + kinds = list(_kinds(declared)) + return bool(kinds) and all(_identifier(kind) is not None for kind in kinds) + + +class NameStrategy(SerializationStrategy): + """``--format name``: the identifier of each item on a line, what the read command takes. + + ``ycli tracker issues search … -o name | xargs -n1 ycli tracker issues get``. An object + inside another one prints its own identifier, not its parent's; a reply that + left the identifier of an item out is an error, and nothing is printed. A command whose result + has no name is refused before it sends anything; a result that is not what the command + declares (the plan of ``--dry-run``) is printed as JSON. + """ + + def render(self, result: BaseModel, console: Console) -> None: + """Print the identifier of each item of ``result`` on its own line. + + Args: + result: What the command returned. + console: Where to print. + + Raises: + YandexUnexpectedReplyError: The reply left the identifier of an item out; nothing + is printed, so a script does not act on fewer objects than were listed. + """ + items = _items(result) + columns = [_identifier(kind) for kind, _ in items] + if None in columns: + JSONStrategy().render(result, console) + return + names = [ + _cell(item, column) + for (_, item), column in zip(items, columns, strict=True) + if column is not None + ] + unnamed = [number for number, name in enumerate(names, start=1) if not name] + if unnamed: + first = unnamed[0] + more = f" (and {len(unnamed) - 1} more)" if len(unnamed) > 1 else "" + key = ".".join(columns[first - 1] or ()) + raise YandexUnexpectedReplyError( + f"item {first} of this listing has no {key}{more}: `-o name` cannot name it" + ) + console.file.writelines(name + "\n" for name in names) + + @dataclass(frozen=True) class BinaryResult: """Raw bytes (an attachment, an export) for the file at ``path``, or stdout for ``None``/``-``. diff --git a/src/ycli/yandex/forms/answers/models.py b/src/ycli/yandex/forms/answers/models.py index ec5775a19..0db0ae8c1 100644 --- a/src/ycli/yandex/forms/answers/models.py +++ b/src/ycli/yandex/forms/answers/models.py @@ -1,11 +1,12 @@ """Pydantic models for Forms answers (Column + Answer + AnswersResponse envelope).""" -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field from ycli.yandex.forms.models import IntegrationType, RunStatus from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity #: The file an export of answers produces. ExportFormat = Literal["csv", "xlsx", "json"] | str @@ -83,7 +84,7 @@ class AnswerDetails(APIModel): '686d' """ - id: int | None = Field(default=None, description="Answer id (integer).") + id: Annotated[int | None, Identity()] = Field(default=None, description="Answer id (integer).") created: str | None = Field(default=None, description="ISO-8601 submission timestamp.") survey: AnswerSurveyRef | None = Field( default=None, description="The form this answer belongs to." @@ -168,7 +169,7 @@ class AnswerIntegration(APIModel): 'DE-7' """ - id: int | None = Field(default=None, description="Integration id.") + id: Annotated[int | None, Identity()] = Field(default=None, description="Integration id.") status: RunStatus | None = Field( default=None, description="Run state: pending, success, error or canceled." ) diff --git a/src/ycli/yandex/forms/filling/models.py b/src/ycli/yandex/forms/filling/models.py index 023cdf6fd..f42673f30 100644 --- a/src/ycli/yandex/forms/filling/models.py +++ b/src/ycli/yandex/forms/filling/models.py @@ -12,12 +12,13 @@ ``layer`` shapes, so extra keys are preserved). """ -from typing import Any +from typing import Annotated, Any from pydantic import ConfigDict, Field from ycli.yandex.forms.models import QuizShowFormat from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity class FrontendTexts(APIModel): @@ -73,7 +74,9 @@ class FillableForm(APIModel): 'Feedback' """ - id: str | None = Field(default=None, description="Form id (hex ObjectId string).") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Form id (hex ObjectId string)." + ) name: str | None = Field(default=None, description="Form name.") teaser: bool | None = Field(default=None, description="Whether to show the teaser.") footer: bool | None = Field(default=None, description="Whether to show the footer.") @@ -149,7 +152,9 @@ class SubmitResult(APIModel): 99 """ - id: str | None = Field(default=None, description="Form id (hex ObjectId string).") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Form id (hex ObjectId string)." + ) name: str | None = Field(default=None, description="Form name.") answer_id: int | None = Field(default=None, description="Id of the saved response.") answer_key: str | None = Field(default=None, description="Key of the saved response.") @@ -197,7 +202,7 @@ class Suggestion(APIModel): model_config = ConfigDict(extra="allow") layer: str | None = Field(default=None, description="Suggestion type / data layer.") - id: str | None = Field(default=None, description="Suggestion object id.") + id: Annotated[str | None, Identity()] = Field(default=None, description="Suggestion object id.") text: str | None = Field(default=None, description="Display text of the suggestion.") orig_id: str | None = Field(default=None, description="Source-database id, where applicable.") country_id: str | None = Field(default=None, description="Id of the country (city).") diff --git a/src/ycli/yandex/forms/history/models.py b/src/ycli/yandex/forms/history/models.py index 327a69761..69b147158 100644 --- a/src/ycli/yandex/forms/history/models.py +++ b/src/ycli/yandex/forms/history/models.py @@ -1,9 +1,12 @@ """Pydantic models for a Forms change log (``/surveys/{id}/history``).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.forms.models import UserRef from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity class HistoryEvent(APIModel): @@ -16,7 +19,7 @@ class HistoryEvent(APIModel): 'surveyhook' """ - id: int | None = Field(default=None, description="Event id (integer).") + id: Annotated[int | None, Identity()] = Field(default=None, description="Event id (integer).") created: str | None = Field(default=None, description="ISO-8601 time of the change.") user: UserRef | None = Field(default=None, description="Who made the change.") model: str | None = Field( diff --git a/src/ycli/yandex/forms/hooks/models.py b/src/ycli/yandex/forms/hooks/models.py index 095b366e8..8081e8d35 100644 --- a/src/ycli/yandex/forms/hooks/models.py +++ b/src/ycli/yandex/forms/hooks/models.py @@ -4,11 +4,14 @@ a hook whose conditions match runs each of its active integrations. """ +from typing import Annotated + from pydantic import Field from ycli.yandex.forms.models import ConditionsResponse from ycli.yandex.forms.subscriptions.models import Subscription from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity class Hook(APIModel): @@ -26,7 +29,9 @@ class Hook(APIModel): 4 """ - id: int | None = Field(default=None, description="Integration group id (integer).") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Integration group id (integer)." + ) name: str | None = Field(default=None, description="Integration group name.") active: bool | None = Field(default=None, description="Whether the group's integrations run.") conditions: ConditionsResponse | None = Field( diff --git a/src/ycli/yandex/forms/images/models.py b/src/ycli/yandex/forms/images/models.py index 61f0eac6b..c1bfd875a 100644 --- a/src/ycli/yandex/forms/images/models.py +++ b/src/ycli/yandex/forms/images/models.py @@ -1,11 +1,12 @@ """Pydantic models for Forms images (an uploaded or cloned image, and the clone request).""" -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field from ycli.yandex.forms.models import FileCheckStatus from ycli.yandex.models import IGNORED_BY_API, APIModel, WarnsOnIgnored +from ycli.yandex.sync.marks import Identity #: How strictly an uploaded image is scanned. FileCheckMode = Literal["strict", "loose"] | str @@ -25,7 +26,7 @@ class Image(APIModel): 7 """ - id: int | None = Field( + id: Annotated[int | None, Identity()] = Field( default=None, description="Image ID (reference it from a form image field)." ) links: dict[str, Any] = Field( diff --git a/src/ycli/yandex/forms/keysets/models.py b/src/ycli/yandex/forms/keysets/models.py index 190858d3b..7c821faf5 100644 --- a/src/ycli/yandex/forms/keysets/models.py +++ b/src/ycli/yandex/forms/keysets/models.py @@ -5,9 +5,12 @@ which is a 24-char hex string). """ +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity class Keyset(APIModel): @@ -18,7 +21,7 @@ class Keyset(APIModel): 3 """ - id: int | None = Field(default=None, description="Key set id (integer).") + id: Annotated[int | None, Identity()] = Field(default=None, description="Key set id (integer).") name: str | None = Field(default=None, description="Key set name.") total: int | None = Field(default=None, description="Number of keys in the set.") used: int | None = Field(default=None, description="Number of keys already used.") diff --git a/src/ycli/yandex/forms/me/models.py b/src/ycli/yandex/forms/me/models.py index 9cc363498..7a1e12f46 100644 --- a/src/ycli/yandex/forms/me/models.py +++ b/src/ycli/yandex/forms/me/models.py @@ -1,8 +1,11 @@ """Pydantic model for Forms /users/me (User).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity class User(APIModel): @@ -13,7 +16,9 @@ class User(APIModel): 'e@x' """ - id: int | None = Field(default=None, description="Forms' numeric id of the user.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Forms' numeric id of the user." + ) uid: str | None = Field(default=None, description="Passport uid of the user.") cloud_uid: str | None = Field(default=None, description="Cloud uid of the user.") login: str | None = Field(default=None, description="Login of the user.") diff --git a/src/ycli/yandex/forms/models.py b/src/ycli/yandex/forms/models.py index 095c13944..e5789dc46 100644 --- a/src/ycli/yandex/forms/models.py +++ b/src/ycli/yandex/forms/models.py @@ -1,10 +1,11 @@ """Forms models that several resources share: one class per shape.""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity #: Statuses at which a background operation has stopped running. TERMINAL_STATUSES = frozenset({"ok", "fail"}) @@ -73,7 +74,7 @@ class OperationResult(APIModel): True """ - id: str | None = Field( + id: Annotated[str | None, Identity()] = Field( default=None, description="Operation id (echoes the id an async trigger returned)." ) status: str | None = Field( @@ -132,7 +133,7 @@ class Condition(APIModel): 'and' """ - id: int | None = Field(default=None, description="Condition group ID.") + id: Annotated[int | None, Identity()] = Field(default=None, description="Condition group ID.") operator: str | None = Field(default=None, description="Operator combining the group's items.") items: list[ConditionItem] | None = Field( default=None, description="Clauses evaluated within this group." diff --git a/src/ycli/yandex/forms/notifications/models.py b/src/ycli/yandex/forms/notifications/models.py index 51adbd299..a38ffd021 100644 --- a/src/ycli/yandex/forms/notifications/models.py +++ b/src/ycli/yandex/forms/notifications/models.py @@ -4,12 +4,13 @@ integration finishes, then ``success``, ``error`` or ``canceled``. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field from ycli.yandex.forms.models import IntegrationType, RunStatus from ycli.yandex.models import APIModel, RequestBody, SortDirection +from ycli.yandex.sync.marks import Identity #: How a field of an integration run is displayed. NotificationFieldType = Literal["text", "textarea", "code", "json", "xml", "url"] | str @@ -23,7 +24,9 @@ class Notification(APIModel): 'error' """ - id: int | None = Field(default=None, description="Notification id (integer).") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Notification id (integer)." + ) status: RunStatus | None = Field( default=None, description="Run state: pending, success, error or canceled." ) @@ -113,7 +116,7 @@ class NotificationStatus(APIModel): 'pending' """ - id: int | None = Field(default=None, description="Notification id.") + id: Annotated[int | None, Identity()] = Field(default=None, description="Notification id.") status: RunStatus | None = Field( default=None, description="Run state: pending, success, error or canceled." ) @@ -148,7 +151,7 @@ class NotificationAction(APIModel): 'ok' """ - id: int | None = Field(default=None, description="Notification id.") + id: Annotated[int | None, Identity()] = Field(default=None, description="Notification id.") survey_id: str | None = Field(default=None, description="Form id.") subscription_id: int | None = Field(default=None, description="Integration id.") result: NotificationActionResult | None = Field( diff --git a/src/ycli/yandex/forms/questions/models.py b/src/ycli/yandex/forms/questions/models.py index e3da540e5..feda5e193 100644 --- a/src/ycli/yandex/forms/questions/models.py +++ b/src/ycli/yandex/forms/questions/models.py @@ -19,6 +19,7 @@ from ycli.yandex.forms.images.models import Image from ycli.yandex.forms.models import ConditionsResponse, FileCheckStatus from ycli.yandex.models import IGNORED_BY_API, APIModel, RequestBody, WarnsOnIgnored +from ycli.yandex.sync.marks import Identity #: What happens to ``force`` of a question delete: the API takes the parameter and ignores it. FORCE_IGNORED = "a question that a display condition refers to is refused all the same." @@ -37,7 +38,9 @@ class Question(APIModel): 's' """ - id: int | None = Field(default=None, description="Question ID (integer).") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Question ID (integer)." + ) label: str | None = Field(default=None, description="Question label / title.") slug: str | None = Field( default=None, description="Stable machine slug (also the answers-table column key)." @@ -651,4 +654,6 @@ class QuestionMoveResult(APIModel): 17 """ - id: int | None = Field(default=None, description="ID of the moved question.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="ID of the moved question." + ) diff --git a/src/ycli/yandex/forms/subscriptions/models.py b/src/ycli/yandex/forms/subscriptions/models.py index a55c53394..2eae05440 100644 --- a/src/ycli/yandex/forms/subscriptions/models.py +++ b/src/ycli/yandex/forms/subscriptions/models.py @@ -12,6 +12,7 @@ from pydantic import Field, SecretStr, TypeAdapter from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity class SubscriptionHeader(APIModel): @@ -198,7 +199,9 @@ class _SubscriptionBase(APIModel): """Fields every subscription type shares.""" # violation(api-drift): one model builds the body and reads the reply, which carries `id` - id: int | None = Field(default=None, description="Subscription id (integer, read only).") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Subscription id (integer, read only)." + ) active: bool | None = Field(default=None, description="Whether the integration runs.") follow: bool | None = Field( default=None, description="Notify the form's followers about the run." diff --git a/src/ycli/yandex/forms/surveys/models.py b/src/ycli/yandex/forms/surveys/models.py index c62301ba3..44abae6cd 100644 --- a/src/ycli/yandex/forms/surveys/models.py +++ b/src/ycli/yandex/forms/surveys/models.py @@ -1,12 +1,13 @@ """Pydantic models for Forms /surveys (Survey + SurveysResponse envelope + ItemList[Survey]).""" -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field, SecretStr from ycli.yandex.forms.images.models import Image from ycli.yandex.forms.models import QuizShowFormat, UserRef from ycli.yandex.models import IGNORED_BY_API, APIModel, RequestBody, WarnsOnIgnored +from ycli.yandex.sync.marks import Identity #: The captcha a form asks before it is submitted. CaptchaType = Literal["std", "ocr", "nbg"] | str @@ -187,7 +188,9 @@ class Survey(APIModel): 444 """ - id: str | None = Field(default=None, description="Form id, a 24-character hex string.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Form id, a 24-character hex string." + ) name: str | None = Field(default=None, description="Form name (title).") dir_id: str | None = Field(default=None, description="Id of the Yandex 360 organization.") collab_id: str | None = Field(default=None, description="Id of the meta-organization.") diff --git a/src/ycli/yandex/forms/variables/models.py b/src/ycli/yandex/forms/variables/models.py index 4bca75f74..913d7d5d5 100644 --- a/src/ycli/yandex/forms/variables/models.py +++ b/src/ycli/yandex/forms/variables/models.py @@ -5,11 +5,12 @@ configured on a subscription (those are ``SubscriptionVariable``). """ -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity class VariableCategory(APIModel): @@ -53,7 +54,9 @@ class VariableInfo(APIModel): type: str | None = Field( default=None, description="Variable type, e.g. form.answer_url or user.email." ) - name: str | None = Field(default=None, description="Variable display name.") + name: Annotated[str | None, Identity()] = Field( + default=None, description="Variable display name." + ) category: VariableCategory | None = Field( default=None, description="The group the variable belongs to." ) diff --git a/src/ycli/yandex/status/models.py b/src/ycli/yandex/status/models.py index d4b2f5957..5152603d6 100644 --- a/src/ycli/yandex/status/models.py +++ b/src/ycli/yandex/status/models.py @@ -1,11 +1,12 @@ """Models for `ycli auth status` and the `status_get` MCP tool.""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field from ycli.settings import CredentialKind, OrganizationKind from ycli.yandex.models import APIModel +from ycli.yandex.sync import marks class Identity(APIModel): @@ -108,7 +109,7 @@ class SavedProfile(APIModel): False """ - name: str = Field(description="Name of the profile.") + name: Annotated[str, marks.Identity()] = Field(description="Name of the profile.") organization_id: str | None = Field( default=None, description="`null` when the profile's file cannot be used." ) diff --git a/src/ycli/yandex/sync/files.py b/src/ycli/yandex/sync/files.py index ca3183abc..733a638f7 100644 --- a/src/ycli/yandex/sync/files.py +++ b/src/ycli/yandex/sync/files.py @@ -3,7 +3,7 @@ import enum from collections.abc import Iterator, Mapping, Sequence from pathlib import Path, PurePosixPath -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -52,7 +52,9 @@ class State(enum.StrEnum): class FileState(APIModel): """One file of a repository and what it is now.""" - path: str = Field(description="Where the file lies, from the root of the repository.") + path: Annotated[str, Identity()] = Field( + description="Where the file lies, from the root of the repository." + ) kind: str | None = Field(default=None, description="The kind the file names.") state: State = Field(description="What `push` would do with the file.") detail: str | None = Field( diff --git a/src/ycli/yandex/sync/kind.py b/src/ycli/yandex/sync/kind.py index 89c9aa128..cb86173d6 100644 --- a/src/ycli/yandex/sync/kind.py +++ b/src/ycli/yandex/sync/kind.py @@ -6,7 +6,7 @@ from dataclasses import dataclass, fields from functools import partial from types import NoneType -from typing import Any, Protocol, get_args, get_type_hints +from typing import Annotated, Any, Protocol, get_args, get_type_hints from pydantic import BaseModel, Field @@ -253,7 +253,9 @@ def operations(self) -> dict[str, Operation]: class KindSummary(APIModel): """One kind as ``ycli sync kinds`` lists it.""" - name: str = Field(description="What a file of the kind carries under `ycli`.") + name: Annotated[str, Identity()] = Field( + description="What a file of the kind carries under `ycli`." + ) file: str = Field(description="The suffix of its files.") operations: list[str] = Field(description="What the API can do with an object of the kind.") version: str = Field(description="How a write proves the version it worked from.") diff --git a/src/ycli/yandex/sync/marks.py b/src/ycli/yandex/sync/marks.py index 3b6da71d9..86218be12 100644 --- a/src/ycli/yandex/sync/marks.py +++ b/src/ycli/yandex/sync/marks.py @@ -10,10 +10,12 @@ @dataclass(frozen=True) class Identity: - """Marks the argument of an operation that says which object it is. + """Marks what says which object it is: an argument of an operation, a field of a reply. - ``trigger_id: Annotated[int, Identity()]``. An object addressed by several arguments has - several; one that is the only one of its container has none. + On an argument, ``trigger_id: Annotated[int, Identity()]``: an object addressed by several + arguments has several; one that is the only one of its container has none. On a field of + a reply, ``id: Annotated[int | None, Identity()]``: the one field the read command of the + resource takes, which ``-o name`` prints. """ diff --git a/src/ycli/yandex/sync/plan.py b/src/ycli/yandex/sync/plan.py index b6b99a0b1..d39fafe35 100644 --- a/src/ycli/yandex/sync/plan.py +++ b/src/ycli/yandex/sync/plan.py @@ -6,7 +6,7 @@ import difflib from collections.abc import Callable, Sequence from pathlib import Path, PurePosixPath -from typing import Any +from typing import Annotated, Any from pydantic import BaseModel, Field @@ -22,7 +22,7 @@ ) from ycli.yandex.sync.files import State, files_under, offline_state, read_file from ycli.yandex.sync.kind import Kind -from ycli.yandex.sync.marks import Version +from ycli.yandex.sync.marks import Identity, Version from ycli.yandex.sync.paths import tree_of from ycli.yandex.sync.pull import ScopeError, Sender, documents_under, read_one @@ -32,7 +32,9 @@ class Planned(APIModel): """One file, or one object that has no file, and what ``push`` would do with it.""" - path: str = Field(description="The file, from the root of the repository.") + path: Annotated[str, Identity()] = Field( + description="The file, from the root of the repository." + ) kind: str | None = Field(default=None, description="The kind of the file.") state: State = Field(description="What `push` would do with the file.") detail: str | None = Field(default=None, description="Why, where the state alone does not say.") diff --git a/src/ycli/yandex/sync/pull.py b/src/ycli/yandex/sync/pull.py index 8964dc915..09c21351b 100644 --- a/src/ycli/yandex/sync/pull.py +++ b/src/ycli/yandex/sync/pull.py @@ -3,7 +3,7 @@ import enum from collections.abc import Callable, Iterator, Sequence from pathlib import Path, PurePosixPath -from typing import Any, Protocol +from typing import Annotated, Any, Protocol from pydantic import BaseModel, Field @@ -39,7 +39,9 @@ class Action(enum.StrEnum): class Pulled(APIModel): """One object ``pull`` met, and what became of it.""" - path: str = Field(description="The file of the object, from the root of the repository.") + path: Annotated[str, Identity()] = Field( + description="The file of the object, from the root of the repository." + ) kind: str = Field(description="The kind that read it.") action: Action = Field( description="Written (would be, when nothing is written), already the same, or skipped." diff --git a/src/ycli/yandex/sync/push.py b/src/ycli/yandex/sync/push.py index 112337185..a54ee630e 100644 --- a/src/ycli/yandex/sync/push.py +++ b/src/ycli/yandex/sync/push.py @@ -4,7 +4,7 @@ import subprocess from collections.abc import Callable, Iterator, Sequence from pathlib import Path, PurePosixPath -from typing import Any, get_type_hints +from typing import Annotated, Any, get_type_hints from pydantic import BaseModel, Field, ValidationError @@ -40,7 +40,9 @@ class OnError(enum.StrEnum): class Pushed(APIModel): """One file and what ``push`` did with it.""" - path: str = Field(description="The file, from the root of the repository.") + path: Annotated[str, Identity()] = Field( + description="The file, from the root of the repository." + ) kind: str | None = Field(default=None, description="The kind of the file.") state: State = Field(description="What the plan said of the file.") result: Result = Field(description="What was done.") diff --git a/src/ycli/yandex/tracker/attachments/models.py b/src/ycli/yandex/tracker/attachments/models.py index bdf9bbcec..b83a382ab 100644 --- a/src/ycli/yandex/tracker/attachments/models.py +++ b/src/ycli/yandex/tracker/attachments/models.py @@ -1,11 +1,14 @@ """Pydantic models for Tracker issue attachments (Attachment + ItemList[Attachment]).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import ( # pydantic resolves field types via get_type_hints() at runtime APIModel, DisplayStr, ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import AttachmentMetadata @@ -24,7 +27,9 @@ class Attachment(APIModel): alias="self", description="API resource address of this attachment.", ) - id: str | None = Field(default=None, description="Unique file identifier.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Unique file identifier." + ) name: str | None = Field(default=None, description="File name.") content: str | None = Field( default=None, diff --git a/src/ycli/yandex/tracker/autoactions/models.py b/src/ycli/yandex/tracker/autoactions/models.py index d80192a24..6c5a49eb4 100644 --- a/src/ycli/yandex/tracker/autoactions/models.py +++ b/src/ycli/yandex/tracker/autoactions/models.py @@ -8,11 +8,12 @@ (:class:`AutoactionRunEntry`). """ -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import AutomationAction, KeyedReference @@ -40,7 +41,9 @@ class Autoaction(APIModel): alias="self", description="API resource URL that returns the autoaction's parameters.", ) - id: int | None = Field(default=None, description="Unique identifier of the autoaction.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the autoaction." + ) queue: KeyedReference | None = Field( default=None, description="Queue the autoaction is configured in." ) @@ -135,7 +138,9 @@ class AutoactionLogEntry(APIModel): 3 """ - id: str | None = Field(default=None, description="Identifier of the autoaction run.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the autoaction run." + ) launch_time: str | None = Field( default=None, alias="launchTime", @@ -198,7 +203,7 @@ class AutoactionRunEntry(APIModel): 'TEST-1' """ - id: int | None = Field( + id: Annotated[int | None, Identity()] = Field( default=None, description="Zero-based sequence number of the issue within the run." ) issue_reference: AutoactionIssueRef | None = Field( diff --git a/src/ycli/yandex/tracker/boards/models.py b/src/ycli/yandex/tracker/boards/models.py index b4a396a89..00d830beb 100644 --- a/src/ycli/yandex/tracker/boards/models.py +++ b/src/ycli/yandex/tracker/boards/models.py @@ -1,6 +1,6 @@ """Pydantic models for Tracker agile boards (Reference + Calendar + Board + ItemList[Board]).""" -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -9,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import Reference @@ -43,7 +44,9 @@ class Board(APIModel): alias="self", description="API resource URL that returns full information about the board.", ) - id: int | None = Field(default=None, description="Unique identifier of the board.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the board." + ) version: int | None = Field( default=None, description="Board version; every change to the board increments this number.", diff --git a/src/ycli/yandex/tracker/bulk/models.py b/src/ycli/yandex/tracker/bulk/models.py index 81bf2c8e3..dea46ffaa 100644 --- a/src/ycli/yandex/tracker/bulk/models.py +++ b/src/ycli/yandex/tracker/bulk/models.py @@ -7,7 +7,7 @@ :attr:`BulkChange.is_terminal` as the stop predicate. """ -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -17,6 +17,7 @@ KeyStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity #: Statuses at which a bulk-change operation has stopped running (poll terminates here). TERMINAL_STATUSES = frozenset({"COMPLETE", "FAILED"}) @@ -38,7 +39,9 @@ class BulkChange(APIModel): alias="self", description="API resource address of this bulk-change operation.", ) - id: str | None = Field(default=None, description="Identifier of the bulk-change operation.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the bulk-change operation." + ) created_by: DisplayStr = Field( default=None, alias="createdBy", @@ -108,7 +111,9 @@ class BulkIssueResult(APIModel): 'TEST-1' """ - issue: KeyStr = Field(default=None, description="Key of the affected issue.") + issue: Annotated[KeyStr, Identity()] = Field( + default=None, description="Key of the affected issue." + ) status: str | None = Field( default=None, description="Outcome for this issue; ``COMPLETED`` when it went well." ) diff --git a/src/ycli/yandex/tracker/changelog/models.py b/src/ycli/yandex/tracker/changelog/models.py index c57afba6b..13256e849 100644 --- a/src/ycli/yandex/tracker/changelog/models.py +++ b/src/ycli/yandex/tracker/changelog/models.py @@ -1,6 +1,6 @@ """Pydantic models for the Tracker changelog (ChangeField + ChangelogEntry).""" -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -9,6 +9,7 @@ DisplayStr, IDStr, ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference @@ -47,7 +48,9 @@ class ChangelogEntry(APIModel): 'Сава' """ - id: str | None = Field(default=None, description="Identifier of the change.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the change." + ) updated_at: str | None = Field( default=None, alias="updatedAt", description="When the issue was changed (ISO 8601)." ) diff --git a/src/ycli/yandex/tracker/columns/models.py b/src/ycli/yandex/tracker/columns/models.py index b308e8e56..fd633cfc1 100644 --- a/src/ycli/yandex/tracker/columns/models.py +++ b/src/ycli/yandex/tracker/columns/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker board columns (Column and its write bodies).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference @@ -22,7 +25,9 @@ class Column(APIModel): alias="self", description="API resource URL that returns full information about the column.", ) - id: int | None = Field(default=None, description="Unique identifier of the column.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the column." + ) name: str | None = Field(default=None, description="Name of the column.") statuses: list[KeyedReference] = Field( default_factory=list, diff --git a/src/ycli/yandex/tracker/comments/models.py b/src/ycli/yandex/tracker/comments/models.py index ab680fcaa..3c46652cf 100644 --- a/src/ycli/yandex/tracker/comments/models.py +++ b/src/ycli/yandex/tracker/comments/models.py @@ -1,6 +1,6 @@ """Pydantic models for Tracker issue comments (Comment + ItemList[Comment]).""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field @@ -9,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import Reference #: The reaction names ``POST …/comments/{id}/reactions/{name}`` documents. @@ -42,7 +43,9 @@ class Comment(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource URL of the comment." ) - id: int | str | None = Field(default=None, description="Comment identifier.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Comment identifier." + ) long_id: str | None = Field( default=None, alias="longId", description="Comment identifier as a string." ) diff --git a/src/ycli/yandex/tracker/components/models.py b/src/ycli/yandex/tracker/components/models.py index 700ced90a..3b94a6110 100644 --- a/src/ycli/yandex/tracker/components/models.py +++ b/src/ycli/yandex/tracker/components/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker components (Component + ItemList[Component]).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import AccessPermissions, KeyedReference, Reference, UserReference @@ -19,7 +22,9 @@ class Component(APIModel): alias="self", description="API resource URL that returns full information about the component.", ) - id: int | None = Field(default=None, description="Unique identifier of the component.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the component." + ) version: int | None = Field( default=None, description="Version of the component; each change increments the version number.", diff --git a/src/ycli/yandex/tracker/dashboards/models.py b/src/ycli/yandex/tracker/dashboards/models.py index 043e63d30..4c2ac2bf0 100644 --- a/src/ycli/yandex/tracker/dashboards/models.py +++ b/src/ycli/yandex/tracker/dashboards/models.py @@ -1,6 +1,6 @@ """Pydantic models for Tracker dashboards and their cycle-time widgets.""" -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -9,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity class Dashboard(APIModel): @@ -22,7 +23,9 @@ class Dashboard(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of this dashboard." ) - id: int | str | None = Field(default=None, description="Dashboard identifier.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Dashboard identifier." + ) version: int | None = Field( default=None, description="Dashboard version (bumped on each edit)." ) @@ -50,7 +53,9 @@ class Widget(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of this widget." ) - id: int | str | None = Field(default=None, description="Widget identifier.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Widget identifier." + ) version: int | None = Field(default=None, description="Widget version (bumped on each edit).") description: str | None = Field(default=None, description="Widget name.") dashboard: DisplayStr = Field( diff --git a/src/ycli/yandex/tracker/entities/models.py b/src/ycli/yandex/tracker/entities/models.py index 1baf254ca..3458e615a 100644 --- a/src/ycli/yandex/tracker/entities/models.py +++ b/src/ycli/yandex/tracker/entities/models.py @@ -10,7 +10,7 @@ ``outputSchema`` and in generated docs — and full, unabbreviated names. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import AliasChoices, ConfigDict, Field @@ -18,6 +18,7 @@ APIModel, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import ( AttachmentMetadata, Deadline, @@ -137,7 +138,9 @@ class Attachment(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of the attachment." ) - id: str | None = Field(default=None, description="Unique file identifier.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Unique file identifier." + ) name: str | None = Field(default=None, description="File name.") content: str | None = Field(default=None, description="Download URL for the file's raw bytes.") thumbnail: str | None = Field( @@ -246,7 +249,7 @@ class Entity(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of the entity." ) - id: str | None = Field(default=None, description="Entity identifier.") + id: Annotated[str | None, Identity()] = Field(default=None, description="Entity identifier.") version: int | None = Field( default=None, description="Entity version (bumps on every change; edits lock at the cap)." ) @@ -305,7 +308,9 @@ class Comment(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of the comment." ) - id: int | None = Field(default=None, description="Numeric comment identifier.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Numeric comment identifier." + ) long_id: str | None = Field( default=None, alias="longId", description="String (long) comment identifier." ) @@ -427,7 +432,7 @@ class EntityEvent(APIModel): 'Issue updated' """ - id: str | None = Field(default=None, description="Event identifier.") + id: Annotated[str | None, Identity()] = Field(default=None, description="Event identifier.") author: UserReference | None = Field(default=None, description="Event author.") date: str | None = Field(default=None, description="Event timestamp (YYYY-MM-DDThh:mm…).") transport: str | None = Field(default=None, description="Service field.") @@ -531,7 +536,9 @@ class BulkChangeOperation(APIModel): 'CREATED' """ - id: str | None = Field(default=None, description="Bulk-change operation identifier.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Bulk-change operation identifier." + ) self_url: str | None = Field( default=None, alias="self", description="API resource address of the operation." ) diff --git a/src/ycli/yandex/tracker/fields/models.py b/src/ycli/yandex/tracker/fields/models.py index 8eb93751b..296ac7a7a 100644 --- a/src/ycli/yandex/tracker/fields/models.py +++ b/src/ycli/yandex/tracker/fields/models.py @@ -4,9 +4,12 @@ ``pydantic.Field``, which every attribute in this module is declared with. """ +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import ( FieldSchema, LocalizedName, @@ -52,7 +55,9 @@ class CustomField(APIModel): alias="self", description="API resource URL that returns full information about the field.", ) - id: str | None = Field(default=None, description="Unique identifier of the field.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Unique identifier of the field." + ) name: str | None = Field(default=None, description="Display name of the field.") key: str | None = Field(default=None, description="Key of the field.") description: str | None = Field(default=None, description="Description of the field.") @@ -117,7 +122,9 @@ class FieldCategoryRecord(APIModel): alias="self", description="API resource URL that returns full information about the category.", ) - id: str | None = Field(default=None, description="Unique identifier of the field category.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Unique identifier of the field category." + ) name: str | None = Field(default=None, description="Display name of the category.") version: int | None = Field( default=None, description="Version of the category; each change increments it." diff --git a/src/ycli/yandex/tracker/filters/models.py b/src/ycli/yandex/tracker/filters/models.py index 79410e531..bac003c8a 100644 --- a/src/ycli/yandex/tracker/filters/models.py +++ b/src/ycli/yandex/tracker/filters/models.py @@ -1,10 +1,11 @@ """Pydantic models for Tracker saved filters (Filter + nested permission models).""" -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import Reference, UserReference @@ -51,7 +52,9 @@ class Filter(APIModel): 'My open issues' """ - id: int | None = Field(default=None, description="Unique identifier of the filter.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the filter." + ) self_url: str | None = Field( default=None, alias="self", diff --git a/src/ycli/yandex/tracker/issuetypes/models.py b/src/ycli/yandex/tracker/issuetypes/models.py index 9e9caba0d..208708fda 100644 --- a/src/ycli/yandex/tracker/issuetypes/models.py +++ b/src/ycli/yandex/tracker/issuetypes/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker issue types (IssueType + ItemList[IssueType] + write bodies).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import LocalizedName @@ -17,7 +20,9 @@ class IssueType(APIModel): 'Task' """ - key: str | None = Field(default=None, description="Key of the issue type, e.g. ``task``.") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Key of the issue type, e.g. ``task``." + ) name: str | None = Field(default=None, description="Display name of the issue type.") display: str | None = Field( default=None, diff --git a/src/ycli/yandex/tracker/links/models.py b/src/ycli/yandex/tracker/links/models.py index 9ac65446f..21fb867a5 100644 --- a/src/ycli/yandex/tracker/links/models.py +++ b/src/ycli/yandex/tracker/links/models.py @@ -1,6 +1,6 @@ """Pydantic models for Tracker issue links (Link + ItemList[Link]).""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field @@ -11,6 +11,7 @@ KeyStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference #: The link verbs ``POST /issues/{key}/links`` documents. @@ -41,7 +42,9 @@ class Link(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource URL of the link." ) - id: int | str | None = Field(default=None, description="Link identifier.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Link identifier." + ) type: IDStr = Field(default=None, description="Identifier of the link type, e.g. ``relates``.") direction: str | None = Field( default=None, diff --git a/src/ycli/yandex/tracker/localfields/models.py b/src/ycli/yandex/tracker/localfields/models.py index c1df1321f..6400413d4 100644 --- a/src/ycli/yandex/tracker/localfields/models.py +++ b/src/ycli/yandex/tracker/localfields/models.py @@ -5,9 +5,12 @@ queue; the same object shape serves both endpoints. """ +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import ( FieldSchema, KeyedReference, @@ -72,7 +75,9 @@ class LocalField(APIModel): id: str | None = Field(default=None, description="Unique identifier of the field.") name: str | None = Field(default=None, description="Human-readable name of the field.") description: str | None = Field(default=None, description="Free-text description of the field.") - key: str | None = Field(default=None, description="Key of the field (used to reference it).") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Key of the field (used to reference it)." + ) version: int | None = Field( default=None, description="Field version; incremented on every change to the field." ) diff --git a/src/ycli/yandex/tracker/macros/models.py b/src/ycli/yandex/tracker/macros/models.py index cdac06765..dfa96e679 100644 --- a/src/ycli/yandex/tracker/macros/models.py +++ b/src/ycli/yandex/tracker/macros/models.py @@ -6,11 +6,12 @@ of field→value on the way in (see :class:`MacroCreate`). """ -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference, Reference @@ -45,7 +46,9 @@ class Macro(APIModel): alias="self", description="API resource URL that returns the macro's parameters.", ) - id: int | None = Field(default=None, description="Unique identifier of the macro.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the macro." + ) queue: KeyedReference | None = Field( default=None, description="Queue whose issues the macro applies to." ) diff --git a/src/ycli/yandex/tracker/models.py b/src/ycli/yandex/tracker/models.py index 9b4666d84..ddc0ce342 100644 --- a/src/ycli/yandex/tracker/models.py +++ b/src/ycli/yandex/tracker/models.py @@ -6,9 +6,12 @@ fields to it, whichever resource reads them. """ +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, DisplayStr, KeyStr, RequestBody +from ycli.yandex.sync.marks import Identity class Reference(APIModel): @@ -180,7 +183,9 @@ class LinkType(APIModel): 'relates' """ - id: str | None = Field(default=None, description="Link type identifier, e.g. ``relates``.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Link type identifier, e.g. ``relates``." + ) inward: str | None = Field( default=None, description="Name of the link as seen from the linked issue." ) @@ -296,7 +301,7 @@ class IssueChecklistItem(APIModel): 'do it' """ - id: str | None = Field(default=None, description="Checklist item id.") + id: Annotated[str | None, Identity()] = Field(default=None, description="Checklist item id.") text: str | None = Field(default=None, description="Item text.") text_html: str | None = Field( default=None, alias="textHtml", description="Item text rendered to HTML." @@ -319,7 +324,9 @@ class Issue(APIModel): 'task' """ - key: str | None = Field(default=None, description="Issue key, e.g. ``TEST-1``.") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Issue key, e.g. ``TEST-1``." + ) summary: str | None = Field(default=None, description="Issue title.") type: KeyStr = Field(default=None, description="Key of the issue type, e.g. ``task``.") status: KeyStr = Field(default=None, description="Key of the current status.") @@ -428,7 +435,9 @@ class Application(APIModel): alias="self", description="API resource URL that returns full information about the application.", ) - id: str | None = Field(default=None, description="Unique identifier of the application.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Unique identifier of the application." + ) type: str | None = Field( default=None, description="Type of the application; matches the value of the id parameter." ) @@ -452,7 +461,9 @@ class User(APIModel): default=None, description="Unique identifier of the user account in Tracker (the default id type).", ) - login: str | None = Field(default=None, description="Login (username) of the user.") + login: Annotated[str | None, Identity()] = Field( + default=None, description="Login (username) of the user." + ) tracker_uid: int | None = Field( default=None, alias="trackerUid", diff --git a/src/ycli/yandex/tracker/priorities/models.py b/src/ycli/yandex/tracker/priorities/models.py index 35800de87..4208e7c07 100644 --- a/src/ycli/yandex/tracker/priorities/models.py +++ b/src/ycli/yandex/tracker/priorities/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker priorities (Priority + ItemList[Priority] + typed write bodies).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import LocalizedName @@ -18,7 +21,9 @@ class Priority(APIModel): 'Normal' """ - key: str | None = Field(default=None, description="Key of the priority, e.g. ``normal``.") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Key of the priority, e.g. ``normal``." + ) name: str | LocalizedName | None = Field( default=None, description="Name in the caller's language, or in every language when not localized.", diff --git a/src/ycli/yandex/tracker/projects/models.py b/src/ycli/yandex/tracker/projects/models.py index c82fa75e3..0a6f5e327 100644 --- a/src/ycli/yandex/tracker/projects/models.py +++ b/src/ycli/yandex/tracker/projects/models.py @@ -4,11 +4,12 @@ portfolios (``ycli tracker entities``); these models serve the older endpoints. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import UserReference #: The stage of a project, as a request spells it (replies print it in lower case). @@ -26,7 +27,9 @@ class Project(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource URL of the project." ) - id: int | str | None = Field(default=None, description="Identifier of the project.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Identifier of the project." + ) version: int | None = Field( default=None, description="Version of the project; each change increments it." ) diff --git a/src/ycli/yandex/tracker/queues/models.py b/src/ycli/yandex/tracker/queues/models.py index 104b392da..688a4811a 100644 --- a/src/ycli/yandex/tracker/queues/models.py +++ b/src/ycli/yandex/tracker/queues/models.py @@ -6,11 +6,12 @@ so a plain list stays valid. """ -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import ( AccessPermissions, KeyedReference, @@ -63,7 +64,7 @@ class Queue(APIModel): default=None, description="Unique identifier of the queue (a number; may arrive as an int or a string).", ) - key: str | None = Field( + key: Annotated[str | None, Identity()] = Field( default=None, description="Queue key (case-sensitive), e.g. TEST — used as the issue prefix.", ) @@ -152,7 +153,9 @@ class QueueVersionInfo(APIModel): alias="self", description="API resource URL that returns full information about the version.", ) - id: int | None = Field(default=None, description="Unique identifier of the version.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the version." + ) version: int | None = Field(default=None, description="Sequence number of the version.") queue: KeyedReference | None = Field( default=None, description="Reference to the queue this version belongs to." @@ -188,7 +191,9 @@ class QueueField(APIModel): alias="self", description="API resource URL that returns full information about the field.", ) - id: str | None = Field(default=None, description="Identifier of the field.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the field." + ) name: str | None = Field(default=None, description="Human-readable name of the field.") version: int | None = Field( default=None, description="Field version; incremented on every change to the field." diff --git a/src/ycli/yandex/tracker/remotelinks/models.py b/src/ycli/yandex/tracker/remotelinks/models.py index b29d3bfdb..629445c67 100644 --- a/src/ycli/yandex/tracker/remotelinks/models.py +++ b/src/ycli/yandex/tracker/remotelinks/models.py @@ -1,5 +1,7 @@ """Pydantic models for Tracker issue remote links (links to external-application objects).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import ( @@ -7,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import Application, LinkType @@ -41,7 +44,9 @@ class RemoteLink(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource address of this remote link." ) - id: int | str | None = Field(default=None, description="Identifier of the remote link.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Identifier of the remote link." + ) type: LinkType | None = Field(default=None, description="The link type.") direction: str | None = Field( default=None, description="Link direction (``outward`` / ``inward``) for asymmetric types." diff --git a/src/ycli/yandex/tracker/resolutions/models.py b/src/ycli/yandex/tracker/resolutions/models.py index 9c1302e7f..8791519fc 100644 --- a/src/ycli/yandex/tracker/resolutions/models.py +++ b/src/ycli/yandex/tracker/resolutions/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker resolutions (Resolution + ItemList[Resolution] + write bodies).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import LocalizedName @@ -22,7 +25,9 @@ class Resolution(APIModel): id: int | None = Field( default=None, description="Unique identifier of the resolution in Tracker." ) - key: str | None = Field(default=None, description="Key of the resolution.") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Key of the resolution." + ) version: int | None = Field(default=None, description="Version of the resolution.") name: str | None = Field(default=None, description="Display name of the resolution.") description: str | None = Field(default=None, description="Description of the resolution.") diff --git a/src/ycli/yandex/tracker/sprints/models.py b/src/ycli/yandex/tracker/sprints/models.py index 89ac4f875..102679a5d 100644 --- a/src/ycli/yandex/tracker/sprints/models.py +++ b/src/ycli/yandex/tracker/sprints/models.py @@ -1,6 +1,6 @@ """Pydantic models for Tracker sprints (Reference + Sprint + ItemList[Sprint]).""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field @@ -9,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import Reference #: The stage of a sprint. @@ -31,7 +32,9 @@ class Sprint(APIModel): alias="self", description="API resource URL that returns full information about the sprint.", ) - id: int | None = Field(default=None, description="Unique identifier of the sprint.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the sprint." + ) version: int | None = Field( default=None, description="Sprint version; every change to the sprint increments this number.", diff --git a/src/ycli/yandex/tracker/statuses/models.py b/src/ycli/yandex/tracker/statuses/models.py index ffbf557cd..7a541ae70 100644 --- a/src/ycli/yandex/tracker/statuses/models.py +++ b/src/ycli/yandex/tracker/statuses/models.py @@ -1,10 +1,11 @@ """Pydantic models for Tracker statuses (Status + ItemList[Status] + typed write bodies).""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import LocalizedName #: The kind of an issue status: where in the life of an issue it stands. @@ -28,7 +29,9 @@ class Status(APIModel): default=None, description="Unique identifier of the issue status in Tracker." ) version: int | None = Field(default=None, description="Version of the issue status.") - key: str | None = Field(default=None, description="Key of the issue status.") + key: Annotated[str | None, Identity()] = Field( + default=None, description="Key of the issue status." + ) name: str | None = Field(default=None, description="Display name of the issue status.") description: str | None = Field(default=None, description="Description of the issue status.") order: int | None = Field( diff --git a/src/ycli/yandex/tracker/transitions/models.py b/src/ycli/yandex/tracker/transitions/models.py index 007a7992b..93655fdcd 100644 --- a/src/ycli/yandex/tracker/transitions/models.py +++ b/src/ycli/yandex/tracker/transitions/models.py @@ -1,8 +1,11 @@ """Pydantic models for Tracker issue transitions (Transition + ItemList[Transition]).""" +from typing import Annotated + from pydantic import ConfigDict, Field from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference, Reference @@ -22,7 +25,9 @@ class Transition(APIModel): 'Closed' """ - id: str | None = Field(default=None, description="Transition identifier, e.g. ``close``.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Transition identifier, e.g. ``close``." + ) display: str | None = Field( default=None, description="Display name of the transition, as on the Tracker button.", diff --git a/src/ycli/yandex/tracker/triggers/models.py b/src/ycli/yandex/tracker/triggers/models.py index 66079dcbe..c0e88d2b3 100644 --- a/src/ycli/yandex/tracker/triggers/models.py +++ b/src/ycli/yandex/tracker/triggers/models.py @@ -9,11 +9,12 @@ from __future__ import annotations -from typing import Any +from typing import Annotated, Any from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import AutomationAction, KeyedReference @@ -50,7 +51,9 @@ class Trigger(APIModel): alias="self", description="API resource URL that returns the trigger's parameters.", ) - id: int | None = Field(default=None, description="Unique identifier of the trigger.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Unique identifier of the trigger." + ) queue: KeyedReference | None = Field( default=None, description="Queue the trigger is configured in." ) @@ -125,7 +128,9 @@ class WebhookLogEntry(APIModel): 235 """ - id: str | None = Field(default=None, description="Identifier of the trigger run.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the trigger run." + ) start_time: str | None = Field( default=None, alias="startTime", diff --git a/src/ycli/yandex/tracker/workflows/models.py b/src/ycli/yandex/tracker/workflows/models.py index 2ee7a66da..57d547d5e 100644 --- a/src/ycli/yandex/tracker/workflows/models.py +++ b/src/ycli/yandex/tracker/workflows/models.py @@ -11,11 +11,12 @@ snake_case. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import AliasChoices, Field, RootModel from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference, LocalizedName, Reference, UserReference @@ -70,7 +71,9 @@ class Workflow(APIModel): self_url: str | None = Field( default=None, alias="self", description="API resource URL of the workflow." ) - id: str | None = Field(default=None, description="Identifier of the workflow.") + id: Annotated[str | None, Identity()] = Field( + default=None, description="Identifier of the workflow." + ) name: str | None = Field(default=None, description="Name of the workflow.") version: int | None = Field( default=None, description="Version of the workflow; each change increments it." diff --git a/src/ycli/yandex/tracker/worklog/models.py b/src/ycli/yandex/tracker/worklog/models.py index 6fbac5c32..1e9451235 100644 --- a/src/ycli/yandex/tracker/worklog/models.py +++ b/src/ycli/yandex/tracker/worklog/models.py @@ -1,5 +1,7 @@ """Pydantic models for Tracker worklog (Worklog + ItemList[Worklog]).""" +from typing import Annotated + from pydantic import Field from ycli.yandex.models import ( @@ -7,6 +9,7 @@ DisplayStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.tracker.models import KeyedReference, UserReference @@ -20,7 +23,9 @@ class Worklog(APIModel): 'X' """ - id: int | str | None = Field(default=None, description="Worklog record identifier.") + id: Annotated[int | str | None, Identity()] = Field( + default=None, description="Worklog record identifier." + ) created_at: str | None = Field( default=None, alias="createdAt", description="When the record was created (ISO 8601)." ) diff --git a/src/ycli/yandex/wiki/access/models.py b/src/ycli/yandex/wiki/access/models.py index 515ff7a90..a25f381de 100644 --- a/src/ycli/yandex/wiki/access/models.py +++ b/src/ycli/yandex/wiki/access/models.py @@ -7,11 +7,12 @@ Replies keep unknown fields (:class:`~ycli.yandex.models.APIModel`); request bodies refuse them. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field from ycli.yandex.models import APIModel, GroupSource, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.wiki.models import PageAccessType, User, UserIdentity #: What a grant lets its holder do, weakest first. @@ -63,7 +64,9 @@ class PageAccess(APIModel): 'reader' """ - id: str = Field(description="Id of the grant, the ``access_id`` of update and delete.") + id: Annotated[str, Identity()] = Field( + description="Id of the grant, the ``access_id`` of update and delete." + ) created_at: str | None = Field(default=None, description="ISO-8601 time of the grant.") user: User | None = Field(default=None, description="The user, for a user grant.") group: AccessGroup | None = Field(default=None, description="The group, for a group grant.") diff --git a/src/ycli/yandex/wiki/attachments/models.py b/src/ycli/yandex/wiki/attachments/models.py index 1121a8b4f..2ef0c433e 100644 --- a/src/ycli/yandex/wiki/attachments/models.py +++ b/src/ycli/yandex/wiki/attachments/models.py @@ -1,10 +1,11 @@ """Pydantic v2 models for Yandex Wiki /pages/{id}/attachments responses.""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.wiki.models import User #: What a listing of attachments can be sorted by. @@ -35,7 +36,9 @@ class AttachedFile(APIModel): 7 """ - id: int | None = Field(default=None, description="Numeric id of the new attachment.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Numeric id of the new attachment." + ) name: str | None = Field(default=None, description="File name of the attachment.") is_downloadable: bool | None = Field( default=None, description="Whether the file's bytes can be downloaded." diff --git a/src/ycli/yandex/wiki/comments/models.py b/src/ycli/yandex/wiki/comments/models.py index 7928e2ad8..0ef848201 100644 --- a/src/ycli/yandex/wiki/comments/models.py +++ b/src/ycli/yandex/wiki/comments/models.py @@ -1,6 +1,6 @@ """Pydantic v2 models for Yandex Wiki /pages/{id}/comments responses.""" -from typing import Any +from typing import Annotated, Any from pydantic import Field @@ -9,6 +9,7 @@ DisplayNameStr, RequestBody, # pydantic resolves field types via get_type_hints() at runtime ) +from ycli.yandex.sync.marks import Identity from ycli.yandex.wiki.models import ResolveStatus, User @@ -44,7 +45,9 @@ class Comment(APIModel): 'ok' """ - id: int | None = Field(default=None, description="Numeric id of the comment.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Numeric id of the comment." + ) parent_id: int | None = Field( default=None, description="Id of the comment this one replies to; ``None`` on a root." ) @@ -101,7 +104,9 @@ class CommentCreated(APIModel): 5 """ - id: int | None = Field(default=None, description="Numeric id of the created comment.") + id: Annotated[int | None, Identity()] = Field( + default=None, description="Numeric id of the created comment." + ) body: str | None = Field(default=None, description="The stored comment text.") inline_text: str | None = Field( default=None, description="Page fragment the comment is pinned to, if inline." diff --git a/src/ycli/yandex/wiki/grids/models.py b/src/ycli/yandex/wiki/grids/models.py index 0eef257fc..a01bf6299 100644 --- a/src/ycli/yandex/wiki/grids/models.py +++ b/src/ycli/yandex/wiki/grids/models.py @@ -14,11 +14,12 @@ Replies keep unknown fields (:class:`~ycli.yandex.models.APIModel`); request bodies refuse them. """ -from typing import Any, Literal +from typing import Annotated, Any, Literal from pydantic import Field, RootModel from ycli.yandex.models import APIModel, RequestBody, SortDirection +from ycli.yandex.sync.marks import Identity from ycli.yandex.wiki.models import PageIdentity #: Sort order of a column in the grid's default sort. @@ -224,7 +225,9 @@ class Grid(APIModel): '3' """ - id: str | int | None = Field(default=None, description="The grid's identifier (uuid4 or int).") + id: Annotated[str | int | None, Identity()] = Field( + default=None, description="The grid's identifier (uuid4 or int)." + ) created_at: str | None = Field(default=None, description="ISO-8601 creation timestamp.") title: str | None = Field(default=None, description="Human-readable grid title.") page: PageIdentity | None = Field(default=None, description="Page the grid belongs to.") @@ -537,7 +540,9 @@ class ColumnSuggestion(APIModel): ['name_1'] """ - slug: str | None = Field(default=None, description="The slug that was checked.") + slug: Annotated[str | None, Identity()] = Field( + default=None, description="The slug that was checked." + ) occupied: bool | None = Field( default=None, description="Whether a column already has that slug." ) diff --git a/src/ycli/yandex/wiki/models.py b/src/ycli/yandex/wiki/models.py index e351a2a7a..03ce02a40 100644 --- a/src/ycli/yandex/wiki/models.py +++ b/src/ycli/yandex/wiki/models.py @@ -1,10 +1,11 @@ """Wiki models that several resources share: one class per shape.""" -from typing import Literal +from typing import Annotated, Literal from pydantic import Field from ycli.yandex.models import APIModel +from ycli.yandex.sync.marks import Identity #: Kind of deferred Wiki operation: the ``type`` of the reference a trigger returns. OperationType = Literal["move", "clone", "clone_inline_grid"] | str @@ -41,7 +42,9 @@ class PageIdentity(APIModel): """ id: int | None = Field(default=None, description="Numeric id of the page.") - slug: str | None = Field(default=None, description="Slug of the page, e.g. ``data/x``.") + slug: Annotated[str | None, Identity()] = Field( + default=None, description="Slug of the page, e.g. ``data/x``." + ) class OperationIdentity(APIModel): diff --git a/src/ycli/yandex/wiki/pages/models.py b/src/ycli/yandex/wiki/pages/models.py index 5af1c4a9f..4b7f13b0d 100644 --- a/src/ycli/yandex/wiki/pages/models.py +++ b/src/ycli/yandex/wiki/pages/models.py @@ -7,7 +7,7 @@ from ycli.yandex.models import APIModel, RequestBody from ycli.yandex.sync.document import Body -from ycli.yandex.sync.marks import Place, Version +from ycli.yandex.sync.marks import Identity, Place, Version from ycli.yandex.wiki.access.models import PageAccessLists, PageAccessPolicy, PageOwner from ycli.yandex.wiki.models import ( Location, @@ -52,7 +52,7 @@ class PageRef(APIModel): """ id: int = Field(description="Numeric id of the page.") - slug: str = Field(description="Slug of the page, e.g. ``data/a``.") + slug: Annotated[str, Identity()] = Field(description="Slug of the page, e.g. ``data/a``.") class PageSummary(PageRef): @@ -158,7 +158,7 @@ class PageRevision(APIModel): 'ivan' """ - id: Annotated[int, Version()] = Field( + id: Annotated[int, Version(), Identity()] = Field( description="Revision id (the ``revision_id`` of ``GET /pages``)." ) author: User | None = Field(default=None, description="Who saved the revision.") @@ -189,7 +189,9 @@ class PageDetails(APIModel): """ id: int = Field(description="Numeric id of the page.") - slug: Annotated[str, Place()] = Field(description="Slug of the page, e.g. ``data/x``.") + slug: Annotated[str, Place(), Identity()] = Field( + description="Slug of the page, e.g. ``data/x``." + ) title: str = Field(description="Title of the page.") page_type: str | None = Field( default=None, description="Kind of page: page, grid, cloud_page, wysiwyg or template." @@ -234,7 +236,7 @@ class GridRef(APIModel): 'Roadmap' """ - id: str = Field(description="The grid's permanent UUID4 identifier.") + id: Annotated[str, Identity()] = Field(description="The grid's permanent UUID4 identifier.") title: str | None = Field(default=None, description="Human-readable grid title.") created_at: str | None = Field( default=None, description="ISO-8601 timestamp of when the grid was created." diff --git a/src/ycli/yandex/wiki/uploadsessions/models.py b/src/ycli/yandex/wiki/uploadsessions/models.py index c96792d29..16eaf8aa0 100644 --- a/src/ycli/yandex/wiki/uploadsessions/models.py +++ b/src/ycli/yandex/wiki/uploadsessions/models.py @@ -5,9 +5,12 @@ The lone typed request body is :class:`UploadSessionCreate` (``file_name`` + ``file_size``). """ +from typing import Annotated + from pydantic import Field from ycli.yandex.models import APIModel, RequestBody +from ycli.yandex.sync.marks import Identity from ycli.yandex.wiki.models import User @@ -23,7 +26,7 @@ class UploadSession(APIModel): 's1' """ - session_id: str | None = Field( + session_id: Annotated[str | None, Identity()] = Field( default=None, description="UUID4 identifying the upload session across the pipeline." ) file_name: str | None = Field(default=None, description="Name of the file being uploaded.") diff --git a/tests/architecture/test_names.py b/tests/architecture/test_names.py new file mode 100644 index 000000000..f968a95a0 --- /dev/null +++ b/tests/architecture/test_names.py @@ -0,0 +1,94 @@ +"""``-o name``: the item of every listing names itself, or says why it cannot. + +A reply model marks the one field the read command of its resource takes with ``Identity()`` +(``docs/conventions/resources.md``); ``-o name`` prints it, so +``ycli … list -o name | xargs -n1 ycli … get`` works. +""" + +from __future__ import annotations + +import inspect +from typing import Annotated, Any, get_origin, get_type_hints + +from tests.snapshots._surface import cli_leaves +from ycli.cli.output import _identifier, _kinds, has_names +from ycli.yandex.core.listing import Listing +from ycli.yandex.models import APIModel, ItemList, Listed +from ycli.yandex.sync.marks import Identity + +#: An item with no identifier of its own, and why. Checked both ways. +NO_NAME = { + "ycli.yandex.forms.access.models.Permission": "a grant is told by what it gives and to whom", + "ycli.yandex.forms.models.FileOut": "a file being checked is not read back by any command", + "ycli.yandex.tracker.entities.models.Link": "a link is told by its two ends", + "ycli.yandex.tracker.gaps.models.UserGaps": "the absences of a user, not one object", + "ycli.yandex.wiki.resources.models.ResourceItem": "wraps a file or a grid of another kind", +} +#: The models generated from the DataLens specification name their identifier per resource, +#: where the generator can read it. Until then no listing of DataLens prints names. +GENERATED = "ycli.yandex.datalens.schemas." + + +def _returns() -> dict[str, Any]: + """What every command says it returns, by its path.""" + return { + path: get_type_hints(inspect.unwrap(command.callback)).get("return") + for path, command in cli_leaves().items() + } + + +def _is_listing(declared: object) -> bool: + plain = isinstance(declared, type) and issubclass(declared, ItemList | Listed) + return get_origin(declared) is Listing or plain + + +def _name(kind: type) -> str: + return f"{kind.__module__}.{kind.__qualname__}" + + +def unnamed(returns: dict[str, Any]) -> dict[str, list[str]]: + """The item classes of listings that have no one ``Identity()`` field, with their commands.""" + found: dict[str, list[str]] = {} + for path, declared in returns.items(): + if _is_listing(declared): + for kind in _kinds(declared): + if _identifier(kind) is None: + found.setdefault(_name(kind), []).append(path) + return found + + +def test_the_item_of_every_listing_names_itself_or_says_why_not(): + found = unnamed(_returns()) + generated = {name for name in found if name.startswith(GENERATED)} + unexplained = found.keys() - generated - NO_NAME.keys() + assert not unexplained, {name: found[name] for name in unexplained} + assert not NO_NAME.keys() - found.keys(), "a reason for an item that names itself" + assert generated, "no generated model is left without a name: drop GENERATED" + + +def test_the_check_bites(): + class _Marked(APIModel): + id: int | None = None + + class _Twice(APIModel): + id: Annotated[int, Identity()] + key: Annotated[str, Identity()] + + found = unnamed({"x list": Listing[_Marked], "y list": ItemList[_Twice], "z get": _Marked}) + assert found == {_name(_Marked): ["x list"], _name(_Twice): ["y list"]} + + +def test_what_is_read_made_or_changed_is_named_where_the_listing_is(): + """A resource whose listing prints names prints the name of the object it makes too.""" + groups: dict[str, dict[str, Any]] = {} + for path, declared in _returns().items(): + group, _, command = path.rpartition(" ") + groups.setdefault(group, {})[command] = declared + silent = [ + f"{group} {command}" + for group, commands in groups.items() + if "list" in commands and has_names(commands["list"]) + for command in ("create", "get", "update") + if command in commands and not has_names(commands[command]) + ] + assert not silent diff --git a/tests/contract/test_output_formats.py b/tests/contract/test_output_formats.py index bb0ae3d9c..c3571585e 100644 --- a/tests/contract/test_output_formats.py +++ b/tests/contract/test_output_formats.py @@ -19,7 +19,9 @@ from tests.contract.test_contract import CASES, _serve from ycli.cli.app import app +from ycli.cli.inject import NO_NAME from ycli.cli.output import _columns +from ycli.yandex.errors import YandexUnexpectedReplyError from ycli.yandex.models import APIModel if TYPE_CHECKING: @@ -150,3 +152,68 @@ def test_the_header_is_the_same_for_an_empty_listing_as_for_a_full_one( printed = _printed(empty, "csv", monkeypatch).decode() assert printed.count("\n") == 1 # the header line, and nothing else assert printed.rstrip("\n").split(",") == _header(case, monkeypatch) + + +#: Operations with a case whose reply leaves out the field that names the item: ``-o name`` +#: says so and prints nothing, so a script does not act on fewer objects than were listed. +SPARSE = { + "forms.filling.submit", + "tracker.boards.list", + "tracker.comments.list", + "tracker.resolutions.update", + "tracker.statuses.update", + "tracker.users.list", + "tracker.worklog.list", +} + + +def _named(case: Case, monkeypatch: pytest.MonkeyPatch) -> tuple[Any, Any]: + assert case.cli is not None + for name, value in case.env.items(): + monkeypatch.setenv(name, value) + api = _serve(monkeypatch, case) + confirmed = ["--yes"] if case.expected_effect == "destructive" else [] + return CliRunner().invoke(app, ["--format", "name", *confirmed, *case.cli]), api + + +def test_every_sparse_operation_has_a_case_that_leaves_an_item_unnamed(monkeypatch): + refused = { + case.operation + for case in CLI_CASES + if case.operation in SPARSE + and isinstance(_named(case, monkeypatch)[0].exception, YandexUnexpectedReplyError) + } + assert refused == SPARSE + + +@pytest.mark.parametrize("case", CLI_CASES, ids=[case.id for case in CLI_CASES]) +def test_name_prints_one_identifier_for_each_item_or_refuses_before_any_request( + case: Case, monkeypatch +): + result, api = _named(case, monkeypatch) + said = " ".join(result.output.replace("│", " ").split()) + if isinstance(result.exception, YandexUnexpectedReplyError): + assert "`-o name` cannot name it" in str(result.exception) + assert result.stdout == "" + assert case.operation in SPARSE + return + if result.exit_code: + assert result.exit_code == 2, result.output + assert NO_NAME in said + assert api.calls == [] + return + as_json = _printed(case, "json", monkeypatch) + try: + shown = json.loads(as_json) + except ValueError: + shown = None + if not isinstance(shown, dict | list): + # Text, a count, bytes: printed as they are in every format. + assert result.stdout_bytes == as_json + return + items = _items(shown) + names = result.stdout.splitlines() + assert len(names) == len(items) and all(names) + for name, item in zip(names, items, strict=True): + own = item.values() if isinstance(item, dict) else [item] + assert name in {value if isinstance(value, str) else json.dumps(value) for value in own} diff --git a/tests/unit/cli/test_inject.py b/tests/unit/cli/test_inject.py index cfa4d8bc1..b08cb1a33 100644 --- a/tests/unit/cli/test_inject.py +++ b/tests/unit/cli/test_inject.py @@ -1,9 +1,12 @@ """inject_dependencies skips registrations that have nothing to wrap.""" +import pytest import typer from typer.models import CommandInfo, TyperInfo +from typer.testing import CliRunner -from ycli.cli.inject import inject_dependencies +from ycli.cli.app import app as root +from ycli.cli.inject import NO_NAME, inject_dependencies def test_registrations_without_a_callback_or_an_app_are_left_alone(): @@ -13,3 +16,18 @@ def test_registrations_without_a_callback_or_an_app_are_left_alone(): inject_dependencies(app) assert app.registered_commands[0].callback is None assert app.registered_groups[0].typer_instance is None + + +@pytest.mark.parametrize( + "argv", + [ + # Typer holds the choice as the text given until the command's own callback runs. + ["--format", "name", "forms", "access", "list", "s1"], + ["forms", "access", "list", "s1", "-o", "name"], + ], +) +def test_name_is_refused_before_the_command_runs_where_the_result_has_no_identifier(api, argv): + result = CliRunner().invoke(root, argv) + assert result.exit_code == 2 + assert NO_NAME in " ".join(result.output.replace("│", " ").split()) + assert api.calls == [] diff --git a/tests/unit/cli/test_output_strategies.py b/tests/unit/cli/test_output_strategies.py index 2f9920297..d8b41dafe 100644 --- a/tests/unit/cli/test_output_strategies.py +++ b/tests/unit/cli/test_output_strategies.py @@ -7,6 +7,7 @@ from io import StringIO from typing import Annotated, Any +import pytest from pydantic import BaseModel, ConfigDict, Field, RootModel from rich.console import Console @@ -15,14 +16,18 @@ CSVStrategy, JSONStrategy, MarkdownStrategy, + NameStrategy, NDJSONStrategy, OutputFormat, PrettyStrategy, SerializationStrategy, YAMLStrategy, + has_names, ) from ycli.yandex.core.listing import Listing +from ycli.yandex.errors import YandexUnexpectedReplyError from ycli.yandex.models import ItemList, Listed +from ycli.yandex.sync.marks import Identity class _Row(BaseModel): @@ -278,3 +283,40 @@ def test_a_result_that_is_no_model_gives_no_columns(): def test_the_declared_kinds_come_first_and_what_else_came_is_added(): printed = _printed(CSVStrategy(Listing[_M]), Listed[Any](items=[_Row(key="A", name="x")])) assert printed == "key,name\nA,x\n" + + +class _Named(BaseModel): + id: int + key: Annotated[str | None, Identity()] = Field(default=None, serialization_alias="issueKey") + + +def test_name_prints_the_marked_field_of_each_item_on_a_line(): + listed = Listed[_Named](items=[_Named(id=1, key="A-1"), _Named(id=2, key="A-2")], next="eJw") + assert _printed(NameStrategy(), listed) == "A-1\nA-2\n" + assert _printed(NameStrategy(), _Named(id=1, key="A-1")) == "A-1\n" + assert _printed(NameStrategy(), ItemList[str](["bug", "ui"])) == "bug\nui\n" + assert isinstance(SerializationStrategy.from_format(OutputFormat.name), NameStrategy) + + +def test_a_result_that_is_not_what_the_command_declares_is_printed_as_json_under_name(): + # The plan of --dry-run comes back in place of the object: it has no name. + assert _printed(NameStrategy(), _Row(key="A", name="x")) == '{"key":"A","name":"x"}\n' + + +def test_a_command_has_names_when_every_kind_it_returns_marks_one_field(): + assert has_names(Listing[_Named]) and has_names(_Named) and has_names(Listing[str]) + assert not has_names(Listing[_Named | _Row]) + assert not has_names(_Row) and not has_names(None) and not has_names(str) + + +def test_name_prints_nothing_and_says_which_item_the_reply_left_unnamed(): + listed = Listed[_Named](items=[_Named(id=1, key="A-1"), _Named(id=2), _Named(id=3)]) + console, buf = _console(terminal=False) + with pytest.raises(YandexUnexpectedReplyError) as failed: + NameStrategy().render(listed, console) + assert str(failed.value) == ( + "item 2 of this listing has no issueKey (and 1 more): `-o name` cannot name it" + ) + assert buf.getvalue() == "" + with pytest.raises(YandexUnexpectedReplyError, match="item 1 of this listing has no issueKey:"): + NameStrategy().render(_Named(id=1), console)