Documents & filesYandex Disk

Yandex Disk CLI commands

Find every Yandex Disk CLI command, option and exit code in the generated reference.

Every command, option and exit code, generated from the program itself. For the same list as JSON, run ydisk commands --json.

The first word is the profile, a name you choose: ydisk personal config show. YDISK_PROFILE does the same for a whole shell session. No profile is assumed: a command that uses an account stops without one and lists the profiles on this computer.

Options for every command

OptionWhat it does
-V, --versionoutput the version number.
-v, --verbosemore detail in what is shown: -v ids, -vv everything we know. Default: 0.
--jsonmachine-readable output: one JSON value on stdout; --json=id,text keeps only those fields.
--jsonlmachine-readable output: one JSON object per line, for streaming and jq.
--quietdiagnostics off; a failure is still said.
--tracethe connection's own log lines on stderr — never content.
--debugon a failure, its whole record — cause and stack — in place of the short line.
--timeout <duration>give up on the whole command after this — 30s, 2m, 500ms.
--offlineanswer from what was recorded and never connect; fails if nothing was.
--no-inputnever prompt or open interactive login; piped input remains available.
--max-input-bytes <bytes>maximum buffered input bytes (default: 16777216).
--max-output-bytes <bytes>maximum machine output bytes (default: 4194304; 0 disables).
--brieffound items as reference, title, time, author and excerpt only.
--fullfound items with their whole text and every provider field.
--compactone line per item for an agent: reference first, text last, paging and next steps as # lines.
--dry-runpreview parsed arguments and permissions before running the action.
--yesgo ahead without the question an ask level puts before a write.
--recordkeep this run even where the config says record false; record_input false leaves the typed words out.
--no-recorddo not keep this run, even if it fails.

ydisk commands

every command by section; --json prints its contract, one path per call

ydisk commands info

one command contract, or all schemas, error reasons and explicit overrides

ydisk commands info [path]
ArgumentRequirementWhat it is
pathoptionalone command path; without one, export schemas, error reasons and explicit overrides.

Example: ydisk commands info commands

ydisk session

keep this profile's Yandex Disk token in the OS keyring

ydisk session start

sign this profile in: the Yandex Disk API token is asked hidden or read from stdin, never taken as an argument, checked against the service, and only then kept in the keyring, or in a private file

Changes something on this computer only.

ydisk session start [options]
OptionWhat it does
--credential-storage <storage>where the token is kept: keyring, which falls back to a private file by itself when no keyring works; file skips the keyring, so keep it for a computer that has none. Default: keyring.

Example: ydisk personal session start

ydisk session status

show where this profile's token comes from: YDISK_TOKEN, the keyring or a file, never the token; --check asks Yandex Disk whose token it is

ydisk session status [options]
OptionWhat it does
--checkask Yandex Disk whether the token still works, and whose it is.

Example: ydisk personal session status, ydisk personal session status --check --json

ydisk session end

forget this profile's token on this computer; the token itself stays valid in Yandex Disk

Changes something on this computer only.

ydisk session end

Example: ydisk personal session end

ydisk session list

list the profiles on this computer and whether each has a token; picks none

ydisk session list

Example: ydisk session list, ydisk session list --json

ydisk account

this profile on this computer

ydisk account remove

sign the profile out, then forget it on this computer: its settings, its saved sign-in and its files; --keep-data leaves its messages in the store, where search still finds them, --delete-data deletes them; asks first, or --yes

Changes something on this computer only.

ydisk account remove [options]
OptionWhat it does
--keep-dataleave what the store holds of this account, still searchable.
--delete-datadelete what the store and the tool's own files hold of this account.
--dry-runlist what it would remove and keep, and change nothing.

Returns: account removal — profile, data, dry_run, account, revoked, config_file, removed, kept; every field: ydisk commands info account remove

Example: ydisk personal account remove --keep-data --dry-run, ydisk personal account remove --delete-data --yes

ydisk folders

choose the Disk folders sync copies

ydisk folders add

import a folder and everything under it on the next sync

Changes something on this computer only.

ydisk folders add <folder>
ArgumentRequirementWhat it is
folderrequiredDisk path to add, like /Documents; its id to remove.

Example: ydisk personal folders add /Documents

ydisk folders list

list the folder ids sync imports

ydisk folders list [query]
ArgumentRequirementWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.

Returns: selected folder — id; every field: ydisk commands info folders list

Example: ydisk personal folders list

ydisk folders browse

list Disk folders one level at a time, live, to choose one for folders add; has_children says whether a folder holds a folder, or is null when the level has more than 20 folders and it is not looked up

ydisk folders browse [options]
OptionWhat it does
--folder <folder>the Disk folder to list inside, by its path; the top of the Disk without it.
--cursor <cursor>go on from where the last page stopped; page.next_cursor gives it, with the same --folder.

Next usually: ydisk folders add <folder>

Example: ydisk personal folders browse, ydisk personal folders browse --folder /Work --json

ydisk folders remove

stop importing a folder; the next sync drops its documents

Changes something on this computer only.

ydisk folders remove <folder>
ArgumentRequirementWhat it is
folderrequiredDisk path to add, like /Documents; its id to remove.

Example: ydisk personal folders remove FOLDER_ID

ydisk sync

import what changed in the chosen folders, and finish an unfinished sync; one sync walks about 10000 entries under the chosen folders, saves where it stopped, and the next sync goes on from there

Changes something on this computer only.

ydisk sync [options]
OptionWhat it does
--limit <n>how many files to read from Yandex Disk in this run. Default: 200.
--rescanread every chosen folder again instead of only what changed; each --rescan starts the walk over, so run it once and continue with a plain sync.
--embedalso index pending text for meaning search, with a model already downloaded.

Example: ydisk personal sync, ydisk personal sync --rescan --limit 500

ydisk status

show the last sync, imported documents and pending work

ydisk status

Example: ydisk personal status

ydisk documents

read the Yandex Disk files synced to this computer

ydisk documents list

list the synced files with their Disk paths

ydisk documents list [query] [options]
ArgumentRequirementWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many documents to return. Default: 50.
--page <n>which page to return. Default: 1.

Next usually: ydisk documents show <document>, ydisk documents context <document>, ydisk tags list <document> [query]

Example: ydisk personal documents list, ydisk personal documents list tag:budget, ydisk personal documents list person:PERSON_UID --limit 10

ydisk documents show

show an imported document's text, tabs and metadata

ydisk documents show <document>
ArgumentRequirementWhat it is
documentrequiredfile id (resource_id) or a search hit's document: ref.

Example: ydisk personal documents show DOC_ID, ydisk personal documents show document:42 --offline

ydisk documents export

write an imported document to a new Markdown file

Changes something on this computer only.

ydisk documents export <document> [options]
ArgumentRequirementWhat it is
documentrequiredfile id (resource_id) or a search hit's document: ref.
OptionWhat it does
--output <file>path of the Markdown file to write; an existing file is refused.

Example: ydisk personal documents export DOC_ID --output notes.md

ydisk documents context

show a document with its tags, relationships, notes, memories and editors

ydisk documents context <document>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.

Example: ydisk personal documents context DOC_ID

search imported documents by words, and by meaning when indexed

ydisk search <query> [options]
ArgumentRequirementWhat it is
queryrequiredwords to look for, and fields such as tag: and date: that every hit must match.
OptionWhat it does
--limit <n>how many results to return. Default: 20.
--page <n>which page to return. Default: 1.
--exactmatch the words exactly: no word forms, no meaning.

Example: ydisk personal search budget, ydisk personal search "quarterly plan" --exact --limit 5

ydisk catalog

browse stored Yandex Disk files and folders offline

ydisk catalog import

put cached file and folder metadata into the shared database

Changes something on this computer only.

ydisk catalog import

Example: ydisk personal catalog import --offline

ydisk catalog show

show stored metadata and the stable file or folder reference

ydisk catalog show <file>
ArgumentRequirementWhat it is
filerequiredYandex Disk file or folder id, or its URL.

Next usually: ydisk documents show <document>, ydisk documents context <document>, ydisk tags list <document> [query]

Example: ydisk personal catalog show FILE_ID --offline

ydisk catalog list

list cached files and folders using metadata queries

ydisk catalog list [query] [options]
ArgumentRequirementWhat it is
queryoptionalmetadata query: kind, mime, name, parent, person, tag; AND, OR, NOT.
OptionWhat it does
--limit <n>how many entries to return (at most 1000). Default: 50.
--page <n>which page to return. Default: 1.

Next usually: ydisk documents show <document>, ydisk documents context <document>, ydisk tags list <document> [query]

Example: ydisk personal catalog list "parent:FOLDER_ID AND kind:file" --offline

search cached names, descriptions, types and observed people

ydisk catalog search <query> [options]
ArgumentRequirementWhat it is
queryrequiredmetadata query: kind, mime, name, parent, person, tag; AND, OR, NOT.
OptionWhat it does
--limit <n>how many entries to return (at most 1000). Default: 50.
--page <n>which page to return. Default: 1.

Next usually: ydisk documents show <document>, ydisk documents context <document>, ydisk tags list <document> [query]

Example: ydisk personal catalog search "budget AND person:Rin*" --offline

ydisk catalog tree

show the cached hierarchy below a folder or all selected roots

ydisk catalog tree [folder] [options]
ArgumentRequirementWhat it is
folderoptionalYandex Disk folder id or URL; defaults to the explicitly selected profile's roots.
OptionWhat it does
--depth <n>maximum descendant depth, from 0 to 50. Default: 5.

Example: ydisk personal catalog tree --offline, ydisk personal catalog tree FOLDER_ID --depth 3 --offline

ydisk catalog tags

add owner tags to cached files or folders

ydisk catalog tags list

list local tags on a cached file or folder

ydisk catalog tags list <file> [query]
ArgumentRequirementWhat it is
filerequiredYandex Disk file or folder id, or its URL.
queryoptionalfield:value terms that narrow the list — the fields are below.

Returns: document tag — tag; every field: ydisk commands info catalog tags list

Example: ydisk personal catalog tags list FOLDER_ID --offline

ydisk catalog tags add

add local tags on a cached file or folder

Changes something on this computer only.

ydisk catalog tags add <file> <tags>
ArgumentRequirementWhat it is
filerequiredYandex Disk file or folder id, or its URL.
tagsrequiredlocal tag names.

Example: ydisk personal catalog tags add FOLDER_ID project --offline

ydisk catalog tags remove

remove local tags on a cached file or folder

Changes something on this computer only.

ydisk catalog tags remove <file> <tags>
ArgumentRequirementWhat it is
filerequiredYandex Disk file or folder id, or its URL.
tagsrequiredlocal tag names.

Example: ydisk personal catalog tags remove FOLDER_ID project --offline

ydisk tags

label imported documents; labels survive a sync

ydisk tags list

list a document's tags

ydisk tags list <document> [query]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.

Returns: document tag — tag; every field: ydisk commands info tags list

Example: ydisk personal tags list DOC_ID

ydisk tags add

tag a document

Changes something on this computer only.

ydisk tags add <document> <tags>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
tagsrequiredone or more tags.

Example: ydisk personal tags add DOC_ID budget q3

ydisk tags remove

untag a document

Changes something on this computer only.

ydisk tags remove <document> <tags>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
tagsrequiredone or more tags.

Example: ydisk personal tags remove DOC_ID budget q3

ydisk relationships

connect a document to people, projects, notes and other references

ydisk relationships list

list a document's relationships

ydisk relationships list <document> [query]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.

Returns: document relationship — id, from, to, kind, role, confirmed, origin; every field: ydisk commands info relationships list

Example: ydisk personal relationships list DOC_ID

ydisk relationships add

connect a document to another reference

Changes something on this computer only.

ydisk relationships add <document> <reference> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
referencerequiredwhat it connects to, such as person:, project: or note:.
OptionWhat it does
--kind <kind>how the two relate. One of: links-to, about, evidence, created-from, related-to, assigned-to. Default: related-to.
--role <role>the part the reference plays, in a word or two.
--reason <text>why the two are connected.

Example: ydisk personal relationships add DOC_ID project:PROJECT_ID --kind about, ydisk personal relationships add DOC_ID person:PERSON_UID --kind assigned-to --role reviewer

ydisk relationships remove

remove one of a document's relationships

Changes something on this computer only.

ydisk relationships remove <document> <relationship-id>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
relationship-idrequiredid, as relationships list prints it.

Example: ydisk personal relationships remove DOC_ID LINK_ID

ydisk notes

write notes about an imported document

ydisk notes add

write a note about a document

Changes something on this computer only.

ydisk notes add <document> <text> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
textrequiredthe note's text.
OptionWhat it does
--title <title>a title for the note.

Returns: note — ref, id, source, folder_id, path, title, text, revision, and 15 more; every field: ydisk commands info notes add

Next usually: ydisk notes show <document> <note>, ydisk notes edit <document> <note> <text>, ydisk notes remove <document> <note>

Example: ydisk personal notes add DOC_ID "Check the numbers" --title Review

ydisk notes list

list a document's notes

ydisk notes list <document> [query] [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many notes to return. Default: 50.
--page <n>which page to return. Default: 1.

Returns: note — ref, id, source, folder_id, path, title, text, revision, and 15 more; every field: ydisk commands info notes list

Next usually: ydisk notes show <document> <note>, ydisk notes edit <document> <note> <text>, ydisk notes remove <document> <note>

Example: ydisk personal notes list DOC_ID, ydisk personal notes list DOC_ID text:review --limit 10

ydisk notes show

show one note

ydisk notes show <document> <note>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
noterequirednote: reference, as notes list prints it.

Returns: note — ref, id, source, folder_id, path, title, text, revision, and 15 more; every field: ydisk commands info notes show

Next usually: ydisk notes edit <document> <note> <text>, ydisk notes remove <document> <note>

Example: ydisk personal notes show DOC_ID note:NOTE_ID

ydisk notes edit

replace a note's text

Changes something on this computer only.

ydisk notes edit <document> <note> <text> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
noterequirednote: reference, as notes list prints it.
textrequiredthe note's new text.
OptionWhat it does
--revision <n>revision from notes show; a newer note is not overwritten.

Returns: note — ref, id, source, folder_id, path, title, text, revision, and 15 more; every field: ydisk commands info notes edit

Next usually: ydisk notes show <document> <note>, ydisk notes remove <document> <note>

Example: ydisk personal notes edit DOC_ID note:NOTE_ID "Numbers checked" --revision 2

ydisk notes remove

delete one note

Changes something on this computer only.

ydisk notes remove <document> <note>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
noterequirednote: reference, as notes list prints it.

Example: ydisk personal notes remove DOC_ID note:NOTE_ID

ydisk memories

keep what was learned from a document, with evidence; an agent's stay proposed

ydisk memories add

record a memory about a document

Changes something on this computer only.

ydisk memories add <document> <text> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
textrequiredwhat to remember.
OptionWhat it does
--scope <scope>whose memory it is: personal or work. One of: personal, work.
--kind <kind>what kind of memory it is. One of: summary, digest, preference. Default: summary.
--supersedes <ref>a memory: about the same document that this one replaces.

Example: ydisk personal memories add DOC_ID "The team prefers async reviews" --scope work --kind preference

ydisk memories list

list a document's memories

ydisk memories list <document> [query] [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many memories to return. Default: 50.

Returns: memory — ref, id, kind, text, subject, author, model, confidence, and 13 more; every field: ydisk commands info memories list

Example: ydisk personal memories list DOC_ID scope:work, ydisk personal memories list DOC_ID kind:preference status:confirmed

ydisk memories show

show one memory

ydisk memories show <document> <memory>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
memoryrequiredmemory: reference, as memories list prints it.

Example: ydisk personal memories show DOC_ID memory:MEMORY_ID

ydisk memories confirm

confirm a proposed memory as true

Changes something on this computer only.

ydisk memories confirm <document> <memory>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
memoryrequiredmemory: reference, as memories list prints it.

Example: ydisk personal memories confirm DOC_ID memory:MEMORY_ID

ydisk memories stale

mark a memory as out of date

Changes something on this computer only.

ydisk memories stale <document> <memory>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
memoryrequiredmemory: reference, as memories list prints it.

Example: ydisk personal memories stale DOC_ID memory:MEMORY_ID

search a document's memories by words

ydisk memories search <document> <query>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryrequiredwords to look for, and scope:personal or scope:work — the fields are below.

Returns: memory — ref, id, kind, text, subject, author, model, confidence, and 13 more; every field: ydisk commands info memories search

Example: ydisk personal memories search DOC_ID reviews scope:work, ydisk personal memories search DOC_ID "async reviews"

ydisk memories extract

send a document's text to the model and show the memories it proposes

Changes something in the service.

ydisk memories extract <document> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
OptionWhat it does
--scope <scope>whose memories they become: personal or work. One of: personal, work.
--tab <id>send only this tab of the document.
--yessave the proposals, each with its quote and the document's version.

Example: ydisk personal memories extract DOC_ID --scope work, ydisk personal memories extract DOC_ID --scope work --yes

ydisk facts

what happened, as a document shows it; an agent's stay proposed until confirmed

ydisk facts add

record a fact a document shows

Changes something on this computer only.

ydisk facts add <document> <statement> [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
statementrequiredthe fact, in one sentence.
OptionWhat it does
--type <type>what kind of fact it is. One of: fact, statement, question, decision, promise. Default: fact.
--scope <scope>whose fact it is: personal or work. One of: personal, work.
--supersedes <ref>a decision only: the decision this one replaces.
--occurred-time <time>when it happened, as the evidence shows, ISO 8601; a time without a zone is read in this computer's zone, a date alone as its midnight.

Example: ydisk personal facts add DOC_ID "Budget approved" --type decision --scope work

ydisk facts list

list a document's facts

ydisk facts list <document> [query] [options]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many facts to return. Default: 50.

Returns: fact — ref, id, kind, text, status, project, subject, occurred_at, and 14 more; every field: ydisk commands info facts list

Example: ydisk personal facts list DOC_ID status:proposed, ydisk personal facts list DOC_ID kind:decision

ydisk facts show

show one fact

ydisk facts show <document> <fact>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
factrequiredfact: reference, as facts list prints it.

Example: ydisk personal facts show DOC_ID fact:FACT_ID

ydisk facts confirm

confirm a proposed fact; a decision it supersedes stops holding

Changes something on this computer only.

ydisk facts confirm <document> <fact>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
factrequiredfact: reference, as facts list prints it.

Example: ydisk personal facts confirm DOC_ID fact:FACT_ID

ydisk facts reverse

an accepted decision no longer holds, and nothing replaced it

Changes something on this computer only.

ydisk facts reverse <document> <fact>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
factrequiredfact: reference, as facts list prints it.

Example: ydisk personal facts reverse DOC_ID fact:FACT_ID

ydisk identities

the Yandex Disk accounts seen on a document, and the people they belong to

ydisk identities list

list the people Yandex Disk shows for a document

ydisk identities list <document> [query]
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
queryoptionalfield:value terms that narrow the list — the fields are below.

Returns: document identity — remote_id, provider, role, person; every field: ydisk commands info identities list

Example: ydisk personal identities list DOC_ID

record that a Yandex Disk account belongs to a known person

Changes something on this computer only.

ydisk identities link <document> <disk-id> <person>
ArgumentRequirementWhat it is
documentrequiredYandex Disk file or folder id or URL in the local catalog, or a document: ref.
disk-idrequiredYandex Disk account id, as identities list prints it.
personrequiredperson: reference of someone already known.

Example: ydisk personal identities link DOC_ID DISK_ID person:PERSON_UID

ydisk files

the files on Yandex Disk, live: list, read, download, upload and change them

ydisk files list

list what a Disk folder holds, live, a page at a time

ydisk files list [options]
OptionWhat it does
--folder <folder>the Disk folder to list, by its path; the top of the Disk without it.
--cursor <cursor>go on from where the last page stopped; page.next_cursor gives it, with the same --folder.

Next usually: ydisk files show <path>, ydisk files download <path>

Example: ydisk personal files list, ydisk personal files list --folder /Documents --json

ydisk files show

show one file or folder on the Disk, live

ydisk files show <path>
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.

Next usually: ydisk files download <path>

Example: ydisk personal files show /plan.pdf

ydisk files download

read a Disk file's text (PDF, docx, xlsx, CSV, TSV, text, Markdown), or with --output save the file itself; the token never goes to the download host

Changes something on this computer only.

ydisk files download <path> [options]
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.
OptionWhat it does
--output <file>save the file here instead of answering its text.
--replacereplace an existing output file.

Example: ydisk personal files download /notes.md --json, ydisk personal files download /plan.pdf --output ./plan.pdf

ydisk files upload

put a local file on the Disk; --replace replaces one already there and asks as files.delete does. Credential files, browser profiles and the WireCat folders are refused

Changes something in the service.

ydisk files upload <file> [options]
ArgumentRequirementWhat it is
filerequiredlocal file to upload.
OptionWhat it does
--folder <folder>the Disk folder to put it in, by its path; the top of the Disk without it.
--name <name>its name on the Disk; the local name without it.
--replacereplace a file already at that path.
--allow-any-filesend a file from a place that is otherwise refused.

Example: ydisk personal files upload ./plan.pdf --folder /Documents

ydisk files copy

copy a file or folder on the Disk into --folder, under --name or its own; --replace replaces what is there and asks as files.delete does

Changes something in the service.

ydisk files copy <path> [options]
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.
OptionWhat it does
--folder <folder>the Disk folder it goes into, by its path.
--name <name>its name there; its own without it.
--replacereplace what is already there.

Example: ydisk personal files copy /plan.pdf --folder /Archive

ydisk files move

move a file or folder on the Disk into --folder, under --name or its own; --replace replaces what is there and asks as files.delete does

Changes something in the service.

ydisk files move <path> [options]
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.
OptionWhat it does
--folder <folder>the Disk folder it goes into, by its path.
--name <name>its name there; its own without it.
--replacereplace what is already there.

Example: ydisk personal files move /plan.pdf --folder /Archive

ydisk files create

create a folder on the Disk at this path

Changes something in the service.

ydisk files create <path>
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.

Example: ydisk personal files create /Documents/Reports

ydisk files delete

move a file or folder to the Disk's trash; files restore brings it back

Changes something in the service.

ydisk files delete <path>
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.

Example: ydisk personal files delete /Documents/old.pdf

ydisk files restore

bring a file or folder back from the Disk's trash

Changes something in the service.

ydisk files restore <path>
ArgumentRequirementWhat it is
pathrequiredits path in the trash, like trash:/old.pdf.

Example: ydisk personal files restore trash:/old.pdf

ydisk files publish

open a file or folder to anyone with its public link; asks as files.share does

Changes something in the service.

ydisk files publish <path>
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.

Example: ydisk personal files publish /Documents/plan.pdf

ydisk files unpublish

close a file's or folder's public link; asks as files.share does

Changes something in the service.

ydisk files unpublish <path>
ArgumentRequirementWhat it is
pathrequiredDisk path, like /Documents/plan.pdf or disk:/Documents/plan.pdf.

Example: ydisk personal files unpublish /Documents/plan.pdf

ydisk store

the shared local store every WireCat tool reads

ydisk store info

the store file: where it is, its size, its schema against the one this tool speaks, which tools used it and how many rows it holds, by provider, chat kind, account, year (UTC) and attachment kind, over every account; changes nothing

ydisk store info

Returns: store info — path, exists, schema, opens, error, bytes, journal_mode, pages, and 12 more; every field: ydisk commands info store info

Example: ydisk personal store info --json

ydisk api

the raw Yandex Disk API, one command per operation of its OpenAPI document

ydisk api list

list every Yandex Disk API operation this CLI offers, without calling Yandex Disk

ydisk api list [query]
ArgumentRequirementWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.

Example: ydisk personal api list, ydisk personal api list effect:destructive --json=command,path

ydisk api show

show one operation's parameters and request schema, without calling Yandex Disk

ydisk api show <operation>
ArgumentRequirementWhat it is
operationrequiredthe operation, as api list prints it.

Example: ydisk personal api show disk-get --json

ydisk api disk-get

Получить метаинформацию о диске пользователя — read (GET /v1/disk)

ydisk api disk-get [options]
OptionWhat it does
--extra-fields <value>Дополнительные поля, которые нужно вернуть.
--fields <value>Список возвращаемых атрибутов.

Example: ydisk personal api disk-get

ydisk api resources-list

Получить метаинформацию о файле или каталоге — read (GET /v1/disk/resources)

ydisk api resources-list [options]
OptionWhat it does
--path <value>Путь к ресурсу.
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество выводимых вложенных ресурсов.
--offset <value>Смещение от начала списка вложенных ресурсов.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.
--sort <value>Поле для сортировки вложенных ресурсов.
--allread every page, as the API pages it.

Example: ydisk personal api resources-list --path <value>

ydisk api resources-create

Создать каталог — write (PUT /v1/disk/resources)

Changes something in the service.

ydisk api resources-create [options]
OptionWhat it does
--path <value>Путь к создаваемой папке.
--fields <value>Список возвращаемых атрибутов.

Example: ydisk personal api resources-create --path <value>

ydisk api resources-update

Обновить пользовательские данные ресурса — write (PATCH /v1/disk/resources)

Changes something in the service.

ydisk api resources-update [options]
OptionWhat it does
--path <value>Путь к обновляемому ресурсу.
--fields <value>Список возвращаемых атрибутов.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: ydisk personal api resources-update --path <value>

ydisk api resources-delete

Удалить файл или папку — destructive (DELETE /v1/disk/resources)

Changes something in the service.

ydisk api resources-delete [options]
OptionWhat it does
--path <value>Путь к файлу или папке.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--md5 <value>md5 удаляемого файла.
--permanently <value>Удалить ресурс не помещая в Корзину.

Example: ydisk personal api resources-delete --path <value>

ydisk api resources-copy

Создать копию файла или папки — write (POST /v1/disk/resources/copy)

Changes something in the service.

ydisk api resources-copy [options]
OptionWhat it does
--from <value>Путь к копируемому ресурсу.
--path <value>Путь к создаваемому ресурсу.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--overwrite <value>Перезаписать существующий ресурс.

Example: ydisk personal api resources-copy --from <value> --path <value>

ydisk api resources-files-list

Получить список файлов упорядоченный по имени — read (GET /v1/disk/resources/files)

ydisk api resources-files-list [options]
OptionWhat it does
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество последних загруженных файлов в ответе.
--media-type <value>Фильтр по медиа типу. Несколько типов перечисляются через запятую.
--offset <value>Смещение от начала списка вложенных ресурсов.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.
--sort <value>Поле для сортировки ресурсов.
--allread every page, as the API pages it.

Example: ydisk personal api resources-files-list

ydisk api resources-last-uploaded-list

Получить список файлов упорядоченный по дате загрузки — read (GET /v1/disk/resources/last-uploaded)

ydisk api resources-last-uploaded-list [options]
OptionWhat it does
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество последних загруженных файлов в ответе.
--media-type <value>Фильтр по медиа типу. Несколько типов перечисляются через запятую.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.

Example: ydisk personal api resources-last-uploaded-list

ydisk api resources-move

Переместить файл или папку — write (POST /v1/disk/resources/move)

Changes something in the service.

ydisk api resources-move [options]
OptionWhat it does
--from <value>Путь к перемещаемому ресурсу.
--path <value>Путь к создаваемому ресурсу.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--overwrite <value>Перезаписать существующий ресурс.

Example: ydisk personal api resources-move --from <value> --path <value>

ydisk api resources-public-list

Получить список опубликованных ресурсов — read (GET /v1/disk/resources/public)

ydisk api resources-public-list [options]
OptionWhat it does
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество выводимых ресурсов.
--offset <value>Смещение от начала списка ресурсов.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.
--type <value>Фильтр по типам ресурсов.
--allread every page, as the API pages it.

Example: ydisk personal api resources-public-list

ydisk api resources-publish

Опубликовать ресурс — write (PUT /v1/disk/resources/publish)

Changes something in the service.

ydisk api resources-publish [options]
OptionWhat it does
--path <value>Путь к публикуемому ресурсу.
--allow-address-access <value>Возможность клиента обрабатывать ответы от адресного доступа.
--fields <value>Список возвращаемых атрибутов.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: ydisk personal api resources-publish --path <value>

ydisk api resources-unpublish

Отменить публикацию ресурса — write (PUT /v1/disk/resources/unpublish)

Changes something in the service.

ydisk api resources-unpublish [options]
OptionWhat it does
--path <value>Путь к ресурсу.
--fields <value>Список возвращаемых атрибутов.

Example: ydisk personal api resources-unpublish --path <value>

ydisk api resources-upload-url

Загрузить файл в Диск по URL — write (POST /v1/disk/resources/upload)

Changes something in the service.

ydisk api resources-upload-url [options]
OptionWhat it does
--path <value>Путь, куда будет помещён ресурс.
--url <value>URL внешнего ресурса, который следует загрузить.
--disable-redirects <value>Запретить делать редиректы.
--fields <value>Список возвращаемых атрибутов.

Example: ydisk personal api resources-upload-url --path <value> --url <value>

ydisk api public-resources-get

Получить метаинформацию о публичном файле или каталоге — read (GET /v1/disk/public/resources)

ydisk api public-resources-get [options]
OptionWhat it does
--public-key <value>Ключ или публичный URL ресурса.
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество выводимых вложенных ресурсов.
--offset <value>Смещение от начала списка вложенных ресурсов.
--path <value>Путь к ресурсу в публичной папке.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.
--sort <value>Поле для сортировки вложенных ресурсов.
--allread every page, as the API pages it.

Example: ydisk personal api public-resources-get --public-key <value>

ydisk api public-settings-update

Обновить настройки публичных ссылок — write (PATCH /v1/disk/public/resources/public-settings)

Changes something in the service.

ydisk api public-settings-update [options]
OptionWhat it does
--path <value>Путь к ресурсу.
--fields <value>Список возвращаемых атрибутов.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: ydisk personal api public-settings-update --path <value>

ydisk api public-resources-save-to-disk

Сохранить публичный ресурс в папку Загрузки — write (POST /v1/disk/public/resources/save-to-disk)

Changes something in the service.

ydisk api public-resources-save-to-disk [options]
OptionWhat it does
--public-key <value>Ключ или публичный URL ресурса.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--name <value>Имя, под которым ресурс будет сохранён в папке.
--path <value>Путь к копируемому ресурсу в публичной папке.
--save-path <value>Путь к папке, в которую будет сохранен ресурс. По умолчанию «Загрузки».

Example: ydisk personal api public-resources-save-to-disk --public-key <value>

ydisk api trash-resources-list

Получить содержимое Корзины — read (GET /v1/disk/trash/resources)

ydisk api trash-resources-list [options]
OptionWhat it does
--path <value>Путь к ресурсу в Корзине.
--apply-photoslice-filter <value>Требуется ли отдавать только фотосрез.
--fields <value>Список возвращаемых атрибутов.
--limit <value>Количество выводимых вложенных ресурсов.
--offset <value>Смещение от начала списка вложенных ресурсов.
--preview-crop <value>Разрешить обрезку превью.
--preview-size <value>Размер превью.
--sort <value>Поле для сортировки вложенных ресурсов.
--allread every page, as the API pages it.

Example: ydisk personal api trash-resources-list --path <value>

ydisk api trash-resources-delete

Очистить Корзину — destructive (DELETE /v1/disk/trash/resources)

Changes something in the service.

ydisk api trash-resources-delete [options]
OptionWhat it does
--apply-photoslice-filter <value>Требуется ли удалять только файлы фотосреза.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--path <value>Путь к ресурсу в Корзине.

Example: ydisk personal api trash-resources-delete

ydisk api trash-resources-restore

Восстановить ресурс из Корзины — write (PUT /v1/disk/trash/resources/restore)

Changes something in the service.

ydisk api trash-resources-restore [options]
OptionWhat it does
--path <value>Путь к ресурсу в Корзине.
--fields <value>Список возвращаемых атрибутов.
--force-async <value>Выполнить асинхронно.
--name <value>Имя, под которым будет восстановлен ресурс.
--overwrite <value>Перезаписать существующий ресурс восстанавливаемым.

Example: ydisk personal api trash-resources-restore --path <value>

ydisk api operations-get

Получить статус асинхронной операции — read (GET /v1/disk/operations/{operation_id})

ydisk api operations-get [options]
OptionWhat it does
--operation-id <value>Идентификатор операции.
--fields <value>Список возвращаемых атрибутов.

Example: ydisk personal api operations-get --operation-id <value>

ydisk doctor

the state this installation is in, without connecting unless --online

ydisk doctor [options]
OptionWhat it does
--onlinealso connect once and read the account; sends nothing.

Example: ydisk doctor, ydisk doctor --json

ydisk doctor reports

problem reports

ydisk doctor reports show

what a problem report holds; writes nothing

ydisk doctor reports show

Example: ydisk doctor reports show

ydisk doctor reports create

write a problem report to a file, and say where to send it

Changes something on this computer only.

ydisk doctor reports create [options]
OptionWhat it does
--run <id>the run the report is about; the newest failed one if not given.
--output <file>where to write it; a new file in this directory if not given.

Example: ydisk doctor reports create --output ./problem-report.json

ydisk skill

the instructions an agent is given for this tool

ydisk skill show

print SKILL.md — ydisk skill install puts it where Claude Code, Codex, Gemini CLI and OpenClaw look for it, and where Hermes does on request; --for prints the copy already there

ydisk skill show [name] [options]
ArgumentRequirementWhat it is
nameoptionala part of this skill, or a skill shipped for a task: api-disk, api-disk-trash-resources, api-disk-resources, api-disk-public-resources, api-disk-operations-operation-id, api.
OptionWhat it does
--for <agents>print the copy installed for these agents instead of this version's. One of: claude, agents.

Example: ydisk skill show

ydisk skill install

write SKILL.md to ~/.claude/skills/yandex-disk-cli/ (Claude Code) and ~/.agents/skills/yandex-disk-cli/ (Codex, Gemini CLI, OpenClaw); --for hermes also has Hermes read ~/.agents/skills, which changes Hermes's own settings, so all leaves it out

Changes something on this computer only.

ydisk skill install [options]
OptionWhat it does
--for <agents>which agents to install for. One of: claude, agents, hermes, all. Default: all.

Example: ydisk skill install --for agents

ydisk skill status

for each place ydisk skill install writes to, and for the copy Hermes reads: the path, the version installed there, and whether it is current, stale, missing or unversioned

ydisk skill status

Example: ydisk skill status, ydisk skill status --json

ydisk mcp

serve this profile to an agent over MCP and set it up — claude mcp add ydisk -- ydisk <profile> mcp serve

ydisk mcp serve

serve this profile to an agent over MCP, on stdin and stdout — claude mcp add ydisk -- ydisk <profile> mcp serve; ydisk mcp serve --profiles a,b or --profiles all serves those profiles from one server and each tool asks which

Changes something in the service.

ydisk mcp serve [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like files.delete=deny; it never loosens the profile; repeat for more keys.
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.
--httpserve over HTTP on 127.0.0.1 for ChatGPT and Claude in the browser, behind your tunnel; the profile's permissions decide.
--port <port>the local port for --http (default 8765).
--public-url <url>the tunnel's https address the browser apps use, e.g. https://.ts.net or https://.ts.net/tg.

Example: ydisk personal mcp serve, ydisk mcp serve --profiles work,personal, ydisk personal mcp serve --http --public-url https://laptop.example.ts.net

ydisk mcp revoke

forget every login mcp serve --http gave a browser app, of this profile or of the server --profiles names; each app must log in again

Changes something on this computer only.

ydisk mcp revoke [options]
OptionWhat it does
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.

Example: ydisk personal mcp revoke, ydisk mcp revoke --profiles all

ydisk mcp server

start, stop and check mcp serve --http in the background; status shows the login code for a browser app

ydisk mcp server start

start mcp serve --http apart from this shell and answer once it listens, with its login code

Changes something on this computer only.

ydisk mcp server start [options]
OptionWhat it does
--port <port>the local port (default 8765).
--public-url <url>the tunnel's https address the browser apps use, e.g. https://.ts.net or https://.ts.net/tg.
--permission <key=level>make a permission stricter for this server only; repeat for more keys.
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: ydisk personal mcp server start --public-url https://laptop.example.ts.net

ydisk mcp server stop

stop mcp serve --http — only one that mcp server start started

Changes something on this computer only.

ydisk mcp server stop [options]
OptionWhat it does
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: ydisk personal mcp server stop

ydisk mcp server status

whether mcp serve --http runs, on which port and address, the login code for a new browser app, and the apps logged in

ydisk mcp server status [options]
OptionWhat it does
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: ydisk personal mcp server status --json

ydisk mcp config

print the mcpServers entry for Claude Desktop, Cursor and others, with full paths; writes nothing

ydisk mcp config [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like files.delete=deny; it never loosens the profile; repeat for more keys.
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.

Example: ydisk personal mcp config, ydisk mcp config --profiles all

ydisk mcp add

add this profile's local MCP server to Codex or Claude Code

Changes something on this computer only.

ydisk mcp add <client> [options]
ArgumentRequirementWhat it is
clientrequiredcodex or claude-code.
OptionWhat it does
--allow-writesacknowledge that this profile offers writing tools.
--permission <key=level>make a permission stricter for this server only, like files.delete=deny; it never loosens the profile; repeat for more keys.

Example: ydisk personal mcp add codex --allow-writes

ydisk mcp check

check this profile's local MCP handshake and tool list

ydisk mcp check [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like files.delete=deny; it never loosens the profile; repeat for more keys.

Example: ydisk personal mcp check

ydisk upgrade

upgrade ydisk with the package manager that installed it; --check only looks

Changes something on this computer only.

ydisk upgrade [options]
OptionWhat it does
--checksay whether a newer version exists, and install nothing.

Example: ydisk upgrade --check

ydisk config

the settings in force, and where each one came from

ydisk config show

the profile, the profiles that exist, and each setting with where it came from

ydisk config show

Example: ydisk personal config show

ydisk config set

save a setting to the configuration file

Changes something on this computer only.

ydisk config set <setting> <value> [options]
ArgumentRequirementWhat it is
settingrequiredone of: limit, timeout_ms, color, record, record_input, keep_runs_for_days, keep_successful_runs_for_days, keep_store_runs_for_days, runs_size_limit_mb, permissions, requests_per_minute, search_reranker, embedding_provider, embedding_model, embedding_base_url, embedding_dims, models, update_check, skill_hint, search_stemmers.cyrillic, search_stemmers.latin, owner_languages, crm.:.links, crm.:.company-types, crm.:.scope, crm.:.unassigned, crm.:.self, crm.:.stage-tasks, crm.:.activities, crm.:.files.max_files, crm.:.files.max_file_mb, crm.:.files.max_run_mb, crm.:.files.run_minutes, crm.:.files.days, crm.:.files.max_total_mb.
valuerequireda number, true or false; for a group tg:work,max:Alice,email:me@x.
OptionWhat it does
--defaultschange what every profile gets, rather than this profile.

Example: ydisk personal config set limit 20

ydisk config unset

remove a setting from the configuration file

Changes something on this computer only.

ydisk config unset <setting> [options]
ArgumentRequirementWhat it is
settingrequiredone of: limit, timeout_ms, color, record, record_input, keep_runs_for_days, keep_successful_runs_for_days, keep_store_runs_for_days, runs_size_limit_mb, permissions, requests_per_minute, search_reranker, embedding_provider, embedding_model, embedding_base_url, embedding_dims, models, update_check, skill_hint, search_stemmers.cyrillic, search_stemmers.latin, owner_languages, crm.:.links, crm.:.company-types, crm.:.scope, crm.:.unassigned, crm.:.self, crm.:.stage-tasks, crm.:.activities, crm.:.files.max_files, crm.:.files.max_file_mb, crm.:.files.max_run_mb, crm.:.files.run_minutes, crm.:.files.days, crm.:.files.max_total_mb.
OptionWhat it does
--defaultschange what every profile gets, rather than this profile.

Example: ydisk personal config unset limit

ydisk config migrate

write each setting the file lacks at its default, keeping yours

Changes something on this computer only.

ydisk config migrate

Example: ydisk config migrate

ydisk config repair

fix broken JSON syntax in the settings file — comments, a missing or extra comma, unquoted keys, single quotes, missing closing brackets at the end — keeping every value, with a backup beside it; refuses anything with more than one reading and changes nothing then

Changes something on this computer only.

ydisk config repair [options]
OptionWhat it does
--dry-runsay what it would fix, and change nothing.

Example: ydisk config repair, ydisk config repair --dry-run

ydisk runs

recorded runs — what this tool did, and when

ydisk runs list

recorded runs, newest first

ydisk runs list [query] [options]
ArgumentRequirementWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many to show.
--page <n>which page, starting at 1.

Returns: run — run_id, command, started_at, status, cli_version, profile, completed_at, requests, and 23 more; every field: ydisk commands info runs list

Example: ydisk personal runs list --limit 10

ydisk runs show

one run: what it was, how it ended, and every event it logged

ydisk runs show <run-id> [options]
ArgumentRequirementWhat it is
run-idrequiredan id from ydisk runs list.
OptionWhat it does
--problemsonly failed responses, warnings and crashes.

Returns: run details — run_id, command, started_at, status, cli_version, directory, event_count, events, and 22 more; every field: ydisk commands info runs show

Example: ydisk personal runs show run-101

ydisk runs path

the directory holding one run

ydisk runs path <run-id>
ArgumentRequirementWhat it is
run-idrequiredan id from ydisk runs list.

Returns: run location — path; every field: ydisk commands info runs path

Example: ydisk personal runs path run-101

Exit codes

Branch on the code, not on the text: the text can change, the code does not.

CodeWhen
0it worked
2validation_error
3configuration_error
4authentication_error
5permission_error
6not_found
7confirmation_required
8rate_limited
9timeout
10network_error
11provider_error
12provider_unavailable
13invalid_response
14outcome_unknown
15conflict
130cancelled
1anything else