ycli wiki¶
Yandex Wiki: pages, grids, comments, attachments.
Usage:
$ ycli wiki [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
auth: Check that the token works for wiki.me: Wiki authenticated user.pages: Wiki pages.access: Wiki page access: grant, change, revoke...comments: Wiki page comments.attachments: Wiki page attachments.resources: Wiki page resources (attachments + grids).recovery: Wiki page recovery (restore by token).grids: Wiki dynamic tables (grids).operations: Wiki async operation status (clone and...uploadsessions: Wiki file upload sessions (the binary...
ycli wiki auth¶
Check that the token works for wiki.
Usage:
$ ycli wiki auth [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Probe wiki with its own read; exit 1 when...
ycli wiki auth status¶
Probe wiki with its own read; exit 1 when the token is rejected.
Usage:
$ ycli wiki auth status [OPTIONS]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki me¶
Wiki authenticated user.
Usage:
$ ycli wiki me [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get: Print the authenticated user (a safe auth...
ycli wiki me get¶
Print the authenticated user (a safe auth probe).
Usage:
$ ycli wiki me get [OPTIONS]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages¶
Wiki pages.
Usage:
$ ycli wiki pages [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get: Print the text of the page SLUG;...get-meta: Print the page SLUG without its text: id,...descendants-list: Print descendant slugs under SLUG...get-by-id: Fetch a page by numeric id (GET...descendants-list-by-id: Print descendant slugs under a numeric...grids-list: List dynamic tables (grids) attached to a...create: Create a wiki page (POST /pages).update: Update a wiki page by id (POST...delete: Delete a wiki page (DELETE /pages/{id});...append: Append content to a wiki page (POST...clone: Copy a page to a new address (POST...move: Move or rename a page (POST /pages/move;...revisions-list: List a page's saved revisions (GET...backlinks-list: List the pages that link to PAGE_ID (GET...search: Search pages and files by text (POST...
ycli wiki pages get¶
Print the text of the page SLUG; get-meta prints what is known about it.
Usage:
$ ycli wiki pages get [OPTIONS] SLUG
Arguments:
SLUG: Wiki page slug. [required]
Options:
--revision-id INTEGER: Show this past revision (ids fromrevisions-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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages get-meta¶
Print the page SLUG without its text: id, title, attributes and owner.
Usage:
$ ycli wiki pages get-meta [OPTIONS] SLUG
Arguments:
SLUG: Wiki page slug. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages descendants-list¶
Print descendant slugs under SLUG (auto-paginated; --all for everything).
Usage:
$ ycli wiki pages descendants-list [OPTIONS] SLUG
Arguments:
SLUG: Wiki page slug. [required]
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.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages get-by-id¶
Fetch a page by numeric id (GET /pages/{id}); dumps the full model.
Usage:
$ ycli wiki pages get-by-id [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--fields TEXT: Comma-separated fields, e.g. content,attributes.--revision-id INTEGER: Show this past revision (ids fromrevisions-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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages descendants-list-by-id¶
Print descendant slugs under a numeric PAGE_ID (auto-paginated; --all for everything).
Usage:
$ ycli wiki pages descendants-list-by-id [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages grids-list¶
List dynamic tables (grids) attached to a numeric PAGE_ID (auto-paginated).
Usage:
$ ycli wiki pages grids-list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages create¶
Create a wiki page (POST /pages).
Usage:
$ ycli wiki pages create [OPTIONS]
Options:
--slug TEXT: Target slug, e.g. data/x. [required]--title TEXT: Page title. [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages update¶
Update a wiki page by id (POST /pages/{id}): only what is given changes.
Usage:
$ ycli wiki pages update [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--content TEXT: New Markdown body, replacing the whole one — pass "$(cat file.md)".--title TEXT: New title.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages delete¶
Delete a wiki page (DELETE /pages/{id}); emits the recovery_token to undo it.
Usage:
$ ycli wiki pages delete [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--recursive / --no-recursive: Also delete every page under it.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages append¶
Append content to a wiki page (POST /pages/{id}/append-content).
The API requires exactly one placement selector (body / section / anchor) and
rejects a bare {content} with 400: --location gives the whole-page body selector.
Usage:
$ ycli wiki pages append [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--content TEXT: YFM fragment to append — pass "$(cat file.md)". [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages clone¶
Copy a page to a new address (POST /pages/{id}/clone; async). --wait polls to completion.
Usage:
$ ycli wiki pages clone [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--target TEXT: Destination slug for the copy. [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages move¶
Move or rename a page (POST /pages/move; async, undocumented by Yandex). --wait polls.
Usage:
$ ycli wiki pages move [OPTIONS] SOURCE TARGET
Arguments:
SOURCE: Slug of the page to move. [required]TARGET: New slug for the page. [required]
Options:
--next-to TEXT: Sibling slug to place the page next to.--position TEXT: Which side of --next-to. Known values: before, after.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages revisions-list¶
List a page's saved revisions (GET /pages/{id}/revisions; undocumented by Yandex).
Usage:
$ ycli wiki pages revisions-list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--ids TEXT: Only these revision ids (comma separated).--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages backlinks-list¶
List the pages that link to PAGE_ID (GET /pages/{id}/backlinks; undocumented by Yandex).
Usage:
$ ycli wiki pages backlinks-list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--for-cluster / --no-for-cluster: Links to the page's whole subtree.--show-all / --no-show-all: The API's show_all flag (no effect seen live).--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki pages search¶
Search pages and files by text (POST /search); prints one page, --cursor picks which.
The API has refused a date window with one end (400), so give both.
Usage:
$ ycli wiki pages search [OPTIONS] QUERY
Arguments:
QUERY: Text to search for. [required]
Options:
--type TEXT: Only pages or only files. Known values: page, file.--cluster TEXT: Only documents under this page slug, e.g. team/handbook.--author-uid TEXT: Only documents by this passport uid (repeatable).--author-cloud-uid TEXT: Only documents by this cloud uid (repeatable).--created-from [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: Created from (with --created-to).--created-to [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: Created until (with --created-from).--modified-from [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: Modified from (with --modified-to).--modified-to [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: Modified until (with --modified-from).--show-obsolete / --no-show-obsolete: Also return obsolete documents.--order-by TEXT: What to sort the hits by. Known values: relevancy, creation_date, modified_date.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki access¶
Wiki page access: grant, change, revoke (read back with pages get-by-id --fields access_policy,access_lists).
Usage:
$ ycli wiki access [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
create: Grant a user or a group a role on a page...update: Change the role or reach of an access...delete: Revoke one access (DELETE...clear: Revoke every personal access but the...
ycli wiki access create¶
Grant a user or a group a role on a page (POST /pages/{id}/access).
Name the user with --user-uid / --user-cloud-uid, or the group with --group-src and --group-id.
Grants access: asks before it is sent (--yes to skip).
Usage:
$ ycli wiki access create [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--role TEXT: Role to grant. Known values: reader, editor, extra_editor, author. [required]--user-uid TEXT: Passport uid of the user to grant.--user-cloud-uid TEXT: Cloud uid of the user to grant.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki access update¶
Change the role or reach of an access (POST /pages/{id}/access/{access_id}).
Grants access: asks before it is sent (--yes to skip).
Usage:
$ ycli wiki access update [OPTIONS] PAGE_ID ACCESS_ID
Arguments:
PAGE_ID: Numeric page id. [required]ACCESS_ID: Id of the access entry. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki access delete¶
Revoke one access (DELETE /pages/{id}/access/{access_id}).
Usage:
$ ycli wiki access delete [OPTIONS] PAGE_ID ACCESS_ID
Arguments:
PAGE_ID: Numeric page id. [required]ACCESS_ID: Id of the access entry. [required]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki access clear¶
Revoke every personal access but the owner's (DELETE /pages/{id}/access).
Usage:
$ ycli wiki access clear [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki comments¶
Wiki page comments.
Usage:
$ ycli wiki comments [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List comments on a page id (GET...thread-list: Print the thread for COMMENT_ID on...thread-get: Print what the server returns as the...create: Add a comment to a page (POST...delete: Delete a comment (DELETE...
ycli wiki comments list¶
List comments on a page id (GET /pages/{id}/comments; auto-paginated).
Usage:
$ ycli wiki comments list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki comments thread-list¶
Print the thread for COMMENT_ID on PAGE_ID: the comment plus its replies.
Reconstructed from the page's comment list (the Wiki /thread endpoint, see thread-get, is
dead); the comment comes first, then its descendants chained by parent_id.
Usage:
$ ycli wiki comments thread-list [OPTIONS] PAGE_ID COMMENT_ID
Arguments:
PAGE_ID: Numeric page id. [required]COMMENT_ID: Root comment id. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki comments thread-get¶
Print what the server returns as the thread of COMMENT_ID (GET .../comments/{id}/thread).
The server answers an empty list for every real thread (checked 2026-10-02); use thread-list,
which rebuilds it from the comment list.
Usage:
$ ycli wiki comments thread-get [OPTIONS] PAGE_ID COMMENT_ID
Arguments:
PAGE_ID: Numeric page id. [required]COMMENT_ID: Root comment id. [required]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki comments create¶
Add a comment to a page (POST /pages/{id}/comments).
Usage:
$ ycli wiki comments create [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--body TEXT: Comment text. [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki comments delete¶
Delete a comment (DELETE /pages/{id}/comments/{comment_id}); emits the remaining count.
Usage:
$ ycli wiki comments delete [OPTIONS] PAGE_ID COMMENT_ID
Arguments:
PAGE_ID: Numeric page id. [required]COMMENT_ID: Comment id to delete. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments¶
Wiki page attachments.
Usage:
$ ycli wiki attachments [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List attachments on a page id (GET...get: Show one attachment's metadata (GET...previews-download: Save an attachment's preview image to...download: Download an attachment by id to --output...download-by-url: Download an attachment by page-slug URL to...delete: Delete an attachment by id (DELETE...attach: Attach uploaded file(s) to a page by...upload: Upload a local file and attach it to a...
ycli wiki attachments list¶
List attachments on a page id (GET /pages/{id}/attachments; auto-paginated).
Usage:
$ ycli wiki attachments list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments get¶
Show one attachment's metadata (GET /pages/{id}/attachments/{file_id}); undocumented API.
Usage:
$ ycli wiki attachments get [OPTIONS] PAGE_ID FILE_ID
Arguments:
PAGE_ID: Numeric page id. [required]FILE_ID: Numeric attachment id. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments previews-download¶
Save an attachment's preview image to --output (or stdout); undocumented API.
A file with no preview (attachments get says has_preview: false) comes back as the
base64 text of a 1-pixel PNG, not an image.
Usage:
$ ycli wiki attachments previews-download [OPTIONS] PAGE_ID FILE_ID
Arguments:
PAGE_ID: Numeric page id. [required]FILE_ID: Numeric attachment id. [required]
Options:
--output TEXT: Write bytes to this path; omit / '-' streams to stdout.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments download¶
Download an attachment by id to --output (or stdout) as raw bytes.
Usage:
$ ycli wiki attachments download [OPTIONS] PAGE_ID FILE_ID
Arguments:
PAGE_ID: Numeric page id. [required]FILE_ID: Numeric attachment id. [required]
Options:
--output TEXT: Write bytes to this path; omit / '-' streams to stdout.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments download-by-url¶
Download an attachment by page-slug URL to --output (or stdout) as raw bytes.
Usage:
$ ycli wiki attachments download-by-url [OPTIONS] URL
Arguments:
URL: Page-slug URL:/.files/ , or an attachment's download_url. [required]
Options:
--output TEXT: Write bytes to this path; omit / '-' streams to stdout.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments delete¶
Delete an attachment by id (DELETE /pages/{id}/attachments/{file_id}).
Usage:
$ ycli wiki attachments delete [OPTIONS] PAGE_ID FILE_ID
Arguments:
PAGE_ID: Numeric page id. [required]FILE_ID: Numeric attachment id. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments attach¶
Attach uploaded file(s) to a page by upload-session id (POST /pages/{id}/attachments).
Usage:
$ ycli wiki attachments attach [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
Options:
--session-ids TEXT: Finished upload-session id to attach (repeatable). [required]-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki attachments upload¶
Upload a local file and attach it to a page in one step (create→upload→finish→attach).
Usage:
$ ycli wiki attachments upload [OPTIONS] PAGE_ID FILE_PATH
Arguments:
PAGE_ID: Numeric page id. [required]FILE_PATH: Path to the local file to upload + attach. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki resources¶
Wiki page resources (attachments + grids).
Usage:
$ ycli wiki resources [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List a page's resources — attachments and...
ycli wiki resources list¶
List a page's resources — attachments and grids (GET /pages/{id}/resources).
Usage:
$ ycli wiki resources list [OPTIONS] PAGE_ID
Arguments:
PAGE_ID: Numeric page id. [required]
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.--q TEXT: Title search filter.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki recovery¶
Wiki page recovery (restore by token).
Usage:
$ ycli wiki recovery [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
recover: Restore a deleted page by its recovery...
ycli wiki recovery recover¶
Restore a deleted page by its recovery TOKEN (POST /recovery_tokens/{token}/recover).
Usage:
$ ycli wiki recovery recover [OPTIONS] TOKEN
Arguments:
TOKEN: recovery_token fromwiki pages delete. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids¶
Wiki dynamic tables (grids).
Usage:
$ ycli wiki grids [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get: Fetch a grid by GRID_ID (GET /grids/{id});...create: Create a grid on a page (POST /grids);...update: Rename / re-sort a grid (POST /grids/{id};...delete: Delete a grid (DELETE /grids/{id}).clone: Copy a grid onto another page (POST...rows: Grid rows.columns: Grid columns.cells: Grid cells.
ycli wiki grids get¶
Fetch a grid by GRID_ID (GET /grids/{id}); read its revision to drive later writes.
Usage:
$ ycli wiki grids get [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--fields TEXT: Extra blocks, e.g. attributes,user_permissions.--row-filter TEXT: Row filter expr, e.g. [slug] ~ wiki.--only-cols TEXT: Only these column slugs (CSV).--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids create¶
Create a grid on a page (POST /grids); name the page by --page-slug or --page-id.
Usage:
$ ycli wiki grids create [OPTIONS]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids update¶
Rename / re-sort a grid (POST /grids/{id}; POST not PATCH).
--default-sort takes the API's write shape (column slug → direction mappings), not the
{slug, title, direction} read shape that grids get returns.
Usage:
$ ycli wiki grids update [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids delete¶
Delete a grid (DELETE /grids/{id}).
Usage:
$ ycli wiki grids delete [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids clone¶
Copy a grid onto another page (POST /grids/{id}/clone; async). --wait polls to completion.
Usage:
$ ycli wiki grids clone [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--target TEXT: Destination page slug (created if absent). [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids rows¶
Grid rows.
Usage:
$ ycli wiki grids rows [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
create: Insert rows into a grid (POST...delete: Delete rows from a grid by id (DELETE...move: Reorder rows in a grid (POST...update: Pin or colour a row (POST...
ycli wiki grids rows create¶
Insert rows into a grid (POST /grids/{id}/rows).
Usage:
$ ycli wiki grids rows create [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--rows TEXT: Rows as JSON, e.g. '[{"name":"x"}]' (slug→value). [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids rows delete¶
Delete rows from a grid by id (DELETE /grids/{id}/rows).
Usage:
$ ycli wiki grids rows delete [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids rows move¶
Reorder rows in a grid (POST /grids/{id}/rows/move).
Usage:
$ ycli wiki grids rows move [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--row-id TEXT: Id of the first row to move. [required]--revision TEXT: Grid revision the edit is based on.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids rows update¶
Pin or colour a row (POST /grids/{id}/rows/{row_id}; undocumented by Yandex).
Usage:
$ ycli wiki grids rows update [OPTIONS] GRID_ID ROW_ID
Arguments:
GRID_ID: Grid UUID. [required]ROW_ID: Id of the row to update. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids columns¶
Grid columns.
Usage:
$ ycli wiki grids columns [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
create: Add columns to a grid (POST...delete: Delete columns from a grid by slug (DELETE...move: Reorder columns in a grid (POST...suggest: Check a column slug (POST...update: Edit a column in place (POST...
ycli wiki grids columns create¶
Add columns to a grid (POST /grids/{id}/columns).
The API requires a slug on every column.
Usage:
$ ycli wiki grids columns create [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids columns delete¶
Delete columns from a grid by slug (DELETE /grids/{id}/columns).
Usage:
$ ycli wiki grids columns delete [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids columns move¶
Reorder columns in a grid (POST /grids/{id}/columns/move).
Usage:
$ ycli wiki grids columns move [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--column-slug TEXT: Slug of the first column to move. [required]--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids columns suggest¶
Check a column slug (POST /grids/{id}/columns/suggest; reads only; undocumented API).
Give --slug or --title, exactly one: the API answers 400 for neither and for both.
Usage:
$ ycli wiki grids columns suggest [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--title TEXT: Title to turn into a slug and check.--slug TEXT: Slug to check.-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids columns update¶
Edit a column in place (POST /grids/{id}/column/{slug}; undocumented by Yandex).
Only the options given change; the column type and slug cannot be edited.
Usage:
$ ycli wiki grids columns update [OPTIONS] GRID_ID COLUMN_SLUG
Arguments:
GRID_ID: Grid UUID. [required]COLUMN_SLUG: Slug of the column to edit. [required]
Options:
--revision TEXT: Grid revision (this endpoint does not enforce it).--title TEXT: New column header.--description TEXT: New description.--required / --no-required: Whether a value is mandatory.--width INTEGER: Column width.--width-units TEXT: Unit of --width. Known values: %, px.--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki grids cells¶
Grid cells.
Usage:
$ ycli wiki grids cells [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
update: Set individual cell values in a grid (POST...
ycli wiki grids cells update¶
Set individual cell values in a grid (POST /grids/{id}/cells).
Usage:
$ ycli wiki grids cells update [OPTIONS] GRID_ID
Arguments:
GRID_ID: Grid UUID. [required]
Options:
--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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki operations¶
Wiki async operation status (clone and move polling).
Usage:
$ ycli wiki operations [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
clone-get: Print a page-clone operation's status (GET...clone-inline-grid-get: Print a grid-clone operation's status (GET...move-get: Print a page-move operation's status (GET...
ycli wiki operations clone-get¶
Print a page-clone operation's status (GET /operations/clone/{task_id}).
Usage:
$ ycli wiki operations clone-get [OPTIONS] TASK_ID
Arguments:
TASK_ID: Operation task id (from a clone or move trigger). [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki operations clone-inline-grid-get¶
Print a grid-clone operation's status (GET /operations/clone_inline_grid/{task_id}).
Usage:
$ ycli wiki operations clone-inline-grid-get [OPTIONS] TASK_ID
Arguments:
TASK_ID: Operation task id (from a clone or move trigger). [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki operations move-get¶
Print a page-move operation's status (GET /operations/move/{task_id}); undocumented API.
Usage:
$ ycli wiki operations move-get [OPTIONS] TASK_ID
Arguments:
TASK_ID: Operation task id (from a clone or move trigger). [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions¶
Wiki file upload sessions (the binary upload pipeline).
Usage:
$ ycli wiki uploadsessions [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
create: Open an upload session (POST...get: Get an upload session's current state (GET...parts-upload: Upload one octet-stream part from...finish: Finish an upload session (POST...abort: Abort one upload session (POST...abort-all: Abort ALL active upload sessions to free...
ycli wiki uploadsessions create¶
Open an upload session (POST /upload_sessions).
Usage:
$ ycli wiki uploadsessions create [OPTIONS]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions get¶
Get an upload session's current state (GET /upload_sessions/{session_id}).
Usage:
$ ycli wiki uploadsessions get [OPTIONS] SESSION_ID
Arguments:
SESSION_ID: UUID4 of the upload session. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions parts-upload¶
Upload one octet-stream part from FILE_PATH (PUT .../{session_id}/upload_part).
Usage:
$ ycli wiki uploadsessions parts-upload [OPTIONS] SESSION_ID FILE_PATH
Arguments:
SESSION_ID: UUID4 of the upload session. [required]FILE_PATH: Path to the file part's bytes to upload. [required]
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|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions finish¶
Finish an upload session (POST /upload_sessions/{session_id}/finish).
Usage:
$ ycli wiki uploadsessions finish [OPTIONS] SESSION_ID
Arguments:
SESSION_ID: UUID4 of the upload session. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions abort¶
Abort one upload session (POST /upload_sessions/{session_id}/abort).
Usage:
$ ycli wiki uploadsessions abort [OPTIONS] SESSION_ID
Arguments:
SESSION_ID: UUID4 of the upload session. [required]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.
ycli wiki uploadsessions abort-all¶
Abort ALL active upload sessions to free quota (POST .../abort_active_uploads).
Usage:
$ ycli wiki uploadsessions abort-all [OPTIONS]
Options:
-o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).-y, --yes: Do not ask before an operation that deletes data or grants access.--dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.--profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read.ycli auth profileslists 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.--body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.--help: Show this message and exit.