Skip to content

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).
  • search: Wiki full-text search.
  • 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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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 page body (default...
  • descendants: Print descendant slugs under SLUG...
  • get-by-id: Fetch a page by numeric id (GET...
  • descendants-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 /pages/{id}).
  • 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...

ycli wiki pages get

Print the page body (default fields=content) for SLUG.

Usage:

$ ycli wiki pages get [OPTIONS] SLUG

Arguments:

  • SLUG: Wiki page slug. [required]

Options:

  • --fields TEXT: Comma-separated fields, e.g. content,attributes. [default: content]
  • --revision-id INTEGER: Show this past revision (ids from revisions-list).
  • --raise-on-redirect: Fail if the page is a redirect, do not follow it.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki pages descendants

Print descendant slugs under SLUG (auto-paginated; --all for everything).

Usage:

$ ycli wiki pages descendants [OPTIONS] SLUG

Arguments:

  • SLUG: Wiki page slug. [required]

Options:

  • --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --include-self: Also list the ancestor page itself.
  • --show-all: The API's show_all flag.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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. [default: content]
  • --revision-id INTEGER: Show this past revision (ids from revisions-list).
  • --raise-on-redirect: Fail if the page is a redirect, do not follow it.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki pages descendants-by-id

Print descendant slugs under a numeric PAGE_ID (auto-paginated; --all for everything).

Usage:

$ ycli wiki pages descendants-by-id [OPTIONS] PAGE_ID

Arguments:

  • PAGE_ID: Numeric page id. [required]

Options:

  • --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --include-self: Also list the ancestor page itself.
  • --show-all: The API's show_all flag.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --order-by TEXT: Sort field: title or created_at.
  • --order-direction TEXT: Sort direction for --order-by: asc or desc.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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.
  • --silent: Do not notify the page's subscribers.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki pages update

Update a wiki page by id (POST /pages/{id}).

Usage:

$ ycli wiki pages update [OPTIONS] PAGE_ID

Arguments:

  • PAGE_ID: Numeric page id. [required]

Options:

  • --content TEXT: Markdown body — pass "$(cat file.md)". [required]
  • --title TEXT: New title (optional).
  • --fields TEXT: Comma-separated blocks to include in the reply.
  • --silent: Do not notify the page's subscribers.
  • --allow-merge: Merge with a concurrent edit instead of failing.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: Also delete every page under it.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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, so the CLI always sends the whole-page body selector — --location bottom unless overridden with --location top.

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: top or bottom (default: bottom). [default: bottom]
  • --fields TEXT: Comma-separated blocks to include in the reply.
  • --silent: Do not notify the page's subscribers.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: Subscribe yourself to the copy.
  • --wait / --no-wait: Poll to a terminal status before printing. [default: wait]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: before or after --next-to.
  • --copy-inherited-access / --no-copy-inherited-access: Copy accesses inherited from the old parent (the API needs an explicit choice). [default: no-copy-inherited-access]
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

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: Links to the page's whole subtree.
  • --show-all: The API's show_all flag (no effect seen live).
  • --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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.

Usage:

$ ycli wiki access create [OPTIONS] PAGE_ID

Arguments:

  • PAGE_ID: Numeric page id. [required]

Options:

  • --role [reader|editor|extra_editor|author]: Role to grant: reader, editor, extra_editor or 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 [dir|cloud|com|staff]: Directory of the group to grant: dir, cloud, com, staff.
  • --group-id TEXT: Id of the group to grant in that directory.
  • --inheritance [inherited|not_inherited]: Whether the access also covers subpages: inherited or not_inherited.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki access update

Change the role or reach of an access (POST /pages/{id}/access/{access_id}).

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 [reader|editor|extra_editor|author]: New role: reader, editor, extra_editor or author.
  • --inheritance [inherited|not_inherited]: Whether the access also covers subpages: inherited or not_inherited.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: Refuse the change if it would leave you without read access or the right to change accesses.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: Refuse the change if it would leave you without read access or the right to change accesses.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --order-by TEXT: Sort field: created_at.
  • --order-direction TEXT: Sort direction for --order-by: asc or desc.
  • --status TEXT: Only resolved or only unresolved comments.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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). [default: 0]
  • --thread-id INTEGER: File into this existing thread id. [default: 0]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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...
  • preview: 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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --order-by TEXT: Sort field: name, size or created_at.
  • --order-direction TEXT: Sort direction for --order-by: asc or desc.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki attachments preview

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 preview [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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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/. [required]

Options:

  • --output TEXT: Write bytes to this path; omit / '-' streams to stdout.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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 TEXT: Finished upload-session id to attach (repeatable). [required]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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; 0 uses the default cap. [default: 0; x>=0]
  • --all: Fetch everything, ignoring the cap.
  • --q TEXT: Title search filter.
  • --types TEXT: Comma-separated kinds: attachment,grid.
  • --order-by TEXT: Sort field: name_title or created_at.
  • --order-direction TEXT: Sort direction for --order-by: asc or desc.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • restore: Restore a deleted page by its recovery...

ycli wiki recovery restore

Restore a deleted page by its recovery TOKEN (POST /recovery_tokens/{token}/recover).

Usage:

$ ycli wiki recovery restore [OPTIONS] TOKEN

Arguments:

  • TOKEN: recovery_token from wiki pages delete. [required]

Options:

  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

Wiki full-text search.

Usage:

$ ycli wiki search [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • query: Search pages and files by text (POST...

ycli wiki search query

Search pages and files by text (POST /search); prints one page, --cursor picks which.

A date window needs both ends (--created-from with --created-to, likewise --modified-*).

Usage:

$ ycli wiki search query [OPTIONS] QUERY

Arguments:

  • QUERY: Text to search for. [required]

Options:

  • --type [page|file]: Only pages or only files.
  • --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: Also return obsolete documents.
  • --order-by [relevancy|creation_date|modified_date]: relevancy, creation_date or modified_date. [default: relevancy]
  • --highlight: Wrap matches in tags.
  • --limit INTEGER RANGE: Results per page. [default: 10; 1<=x<=50]
  • --cursor INTEGER RANGE: Result page to fetch, from 1 (see next_cursor). [default: 1; 1<=x<=500]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki grids create

Create a grid on a page (POST /grids). Pass one of --page-slug / --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. [default: 0]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: Current grid revision (optimistic lock). [required]
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: 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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • add: Insert rows into a grid (POST...
  • remove: 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 add

Insert rows into a grid (POST /grids/{id}/rows).

Usage:

$ ycli wiki grids rows add [OPTIONS] GRID_ID

Arguments:

  • GRID_ID: Grid UUID. [required]

Options:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --rows TEXT: Rows as JSON, e.g. '[{"name":"x"}]' (slug→value). [required]
  • --position INTEGER: Zero-based target index.
  • --after-row-id TEXT: Insert after this row id.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki grids rows remove

Delete rows from a grid by id (DELETE /grids/{id}/rows).

Usage:

$ ycli wiki grids rows remove [OPTIONS] GRID_ID

Arguments:

  • GRID_ID: Grid UUID. [required]

Options:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --row-id TEXT: Row id to delete (repeatable). [required]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --row-id TEXT: Id of the first row to move.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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, e.g. mint.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • add: Add columns to a grid (POST...
  • remove: 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 add

Add columns to a grid (POST /grids/{id}/columns).

The API requires a slug on every column; a column without one gets a slug derived from its title (lowercased, non-alphanumeric runs collapsed to _).

Usage:

$ ycli wiki grids columns add [OPTIONS] GRID_ID

Arguments:

  • GRID_ID: Grid UUID. [required]

Options:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --columns TEXT: Columns as JSON, e.g. '[{"title":"C","type":"string"}]' (slug derived from the title when omitted). [required]
  • --position INTEGER: Zero-based target index.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki grids columns remove

Delete columns from a grid by slug (DELETE /grids/{id}/columns).

Usage:

$ ycli wiki grids columns remove [OPTIONS] GRID_ID

Arguments:

  • GRID_ID: Grid UUID. [required]

Options:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --column-slug TEXT: Column slug to delete (repeatable). [required]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --column-slug TEXT: Slug of the first column to move.
  • --position INTEGER: Zero-based target index.
  • --columns-count INTEGER: How many consecutive columns to move.
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki grids columns suggest

Check a column slug (POST /grids/{id}/columns/suggest; reads only; undocumented API).

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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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: % or px.
  • --pinned TEXT: left or right.
  • --color TEXT: Column background colour.
  • --select-option TEXT: Allowed choice of a select column (repeatable).
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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:

  • --revision TEXT: Current grid revision (optimistic lock). [required]
  • --cells TEXT: Cells as JSON, e.g. '[{"row_id":1,"column_slug":"name","value":"x"}]'. [required]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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...
  • gridclone-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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki operations gridclone-get

Print a grid-clone operation's status (GET /operations/clone_inline_grid/{task_id}).

Usage:

$ ycli wiki operations gridclone-get [OPTIONS] TASK_ID

Arguments:

  • TASK_ID: Operation task id (from a clone or move trigger). [required]

Options:

  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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...
  • upload-part: 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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.

ycli wiki uploadsessions upload-part

Upload one octet-stream part from FILE_PATH (PUT .../{session_id}/upload_part).

Usage:

$ ycli wiki uploadsessions upload-part [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). [default: 1]
  • -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --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]: Output format (auto = pretty on a TTY, JSON when piped).
  • --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
  • -y, --yes: Do not ask before an operation that deletes data.
  • --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
  • --help: Show this message and exit.