Skip to content

commands

github-actions[bot] edited this page Nov 3, 2026 · 1 revision

Drive commands

Look up every supported command and option here. Account operations require an explicit profile: the first word, as in drive personal documents show DOC_ID, or DRIVE_PROFILE; there is no --profile. Help, scenarios, the agent skill, model downloads, discovery, API method listings, schemas, shell completion, doctor and upgrade do not select an account. See recipes for complete workflows and import and storage for file-type and disk-use limits.

Global options

These options apply to the selected profile and current invocation.

Option What it does
-V, --version output the version number.
-v, --verbose more detail in what is shown: -v ids, -vv everything we know. Default: 0.
--json machine-readable output: one JSON value on stdout; --json=id,text keeps only those fields.
--jsonl machine-readable output: one JSON object per line, for streaming and jq.
--quiet diagnostics off; a failure is still said.
--trace the connection's own log lines on stderr — never content.
--debug on 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.
--offline answer from what was recorded and never connect; fails if nothing was.
--no-input never 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).
--brief found items as reference, title, time, author and excerpt only.
--full found items with their whole text and every provider field.
--compact one line per item for an agent: reference first, text last, paging and next steps as # lines.
--dry-run preview parsed arguments and permissions before running the action.
--yes go ahead without the question an ask level puts before a write.
--record keep this run even where the config says record false; record_input false leaves the typed words out.
--no-record do not keep this run, even if it fails.
--read-only refuse local and remote mutations.
--allow-dangerous answer a permanent-deletion confirmation.
--permission <key=level> make a permission stricter for this run only; repeat to add keys.

drive doctor

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

drive doctor [options]
Option What it does
--online also connect once and read the account; sends nothing.

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

Example: drive doctor, drive doctor --json

drive skill

the instructions an agent is given for this tool

drive skill show

print SKILL.md — drive 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

drive skill show [options]
Option What it does
--for <agents> print the copy installed for these agents instead of this version's. One of: claude, agents.

Returns: print the tool's instructions for AI agents

Example: drive skill show

drive skill install

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

This command changes local state.

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

Returns: install the tool's instructions for AI agents

Example: drive skill install --for agents

drive skill status

for each place drive 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

drive skill status

Returns: whether the installed instructions for AI agents match this version

Example: drive skill status, drive skill status --json

drive mcp

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

drive mcp serve

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

This command can change Google data or send data to the configured model.

drive <profile> mcp serve [options]
Option What it does
--permission <key=level> make a permission stricter for this server only, like files.trash=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.
--http serve 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.

Returns: serve this profile's commands to an AI agent

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

drive 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

This command changes local state.

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

Returns: forget every login given to a browser app

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

drive mcp server

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

drive mcp server start

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

This command changes local state.

drive <profile> mcp server start [options]
Option What 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.

Returns: start the HTTP MCP server in the background

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

drive mcp server stop

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

This command changes local state.

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

Returns: stop the background HTTP MCP server

Example: drive personal mcp server stop

drive 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

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

Returns: whether the HTTP MCP server runs, its login code and the apps logged in

Example: drive personal mcp server status --json

drive mcp config

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

drive <profile> mcp config [options]
Option What it does
--permission <key=level> make a permission stricter for this server only, like files.trash=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.

Returns: print the local MCP configuration of this profile, or of those --profiles names

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

drive mcp add

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

This command changes local state.

drive <profile> mcp add <client> [options]
Argument What it is
client required codex or claude-code.
Option What it does
--allow-writes acknowledge that this profile offers writing tools.
--permission <key=level> make a permission stricter for this server only, like files.trash=deny; it never loosens the profile; repeat for more keys.

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

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

drive mcp check

check this profile's local MCP handshake and tool list

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

Returns: check this profile's local MCP handshake and tool list

Example: drive personal mcp check

drive session

sign in to Google and manage local profiles

drive session start

sign in to Google in the browser; read-only unless you pass --grant write

This command can change Google data or send data to the configured model.

drive <profile> session start [options]
Option What it does
--client-file <file> path to your own Desktop OAuth client JSON, used instead of WireCat's.
--credential-storage <storage> where the sign-in is kept: keyring (the default, which falls back to a private file by itself when no keyring works), or file, not recommended. Default: keyring.
--no-browser print the sign-in URL instead of opening a browser.
--grant <scopes> also ask for these permissions, comma-separated: write (change Drive files and Docs), activity (read Drive Activity history), apps (see installed Drive apps).

Returns: sign in to Google in the browser; read-only unless you pass --grant write

Example: drive personal session start, drive work session start --grant write,activity

drive session list

list the configured profiles; credentials are never printed

drive session list [query]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.

Returns: drive session — profile, selected_folders, storage; every field: drive commands info session list

Example: drive session list

drive session end

sign this profile out; imported documents stay

This command changes local state.

drive <profile> session end

Returns: sign this profile out; imported documents stay

Example: drive personal session end

drive folders

choose the Google Drive folders that sync imports

drive folders add

import a folder and everything under it on the next sync

This command changes local state.

drive <profile> folders add <folder>
Argument What it is
folder required folder id or Google Drive URL.

Returns: import a folder and everything under it on the next sync

Example: drive personal folders add FOLDER_ID

drive folders list

list the folder ids sync imports

drive <profile> folders list [query]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.

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

Example: drive personal folders list

drive folders remove

stop importing a folder; the next sync drops its documents

This command changes local state.

drive <profile> folders remove <folder>
Argument What it is
folder required folder id or Google Drive URL.

Returns: stop importing a folder; the next sync drops its documents

Example: drive personal folders remove FOLDER_ID

drive sync

import what changed in the chosen folders, and finish an unfinished sync; one sync reads at most 10000 entries under the chosen folders, and as many changes

This command changes local state.

drive <profile> sync [options]
Option What it does
--limit <n> how many documents to read from Google in this run. Default: 200.
--rescan read every chosen folder again instead of only what changed.
--embed also index pending text for meaning search, with a model already downloaded.

Returns: import what changed in the chosen folders, and finish an unfinished sync

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

drive status

show the last sync, imported documents and pending work

drive <profile> status

Returns: show the last sync, imported documents and pending work

Example: drive personal status

drive store

the shared store, and importing this profile's previous document database

drive store info

the shared store file: where it is, its size, its schema against the one drive speaks, which tools used it and how many rows it holds; changes nothing

drive store info

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

Example: drive store info --json

drive store check

preview documents, annotations and unresolved references without changing either database

drive <profile> store check <source> [bindings]
Argument What it is
source required previous Drive database file.
bindings optional optional JSON file mapping source references to destination references.

Returns: preview copying document context without changing either database

Example: drive personal store check /path/to/previous.db --offline

drive store import

copy the reviewed document annotations and bind this profile to the selected store; retain the source

This command changes local state.

drive <profile> store import <source> [bindings] [options]
Argument What it is
source required previous Drive database file.
bindings optional the same optional reference mapping JSON file used for store check.
Option What it does
--fingerprint <hash> refuse if the reviewed source, destination or reference decisions changed.

Returns: copy reviewed document context and bind this profile to the selected store

Example: drive personal store import /path/to/previous.db --fingerprint HASH --offline

drive documents

read imported documents and Google Docs

drive documents list

list imported documents with their Google URLs

drive <profile> documents list [query] [options]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.
Option What it does
--limit <n> how many documents to return. Default: 50.
--page <n> which page to return. Default: 1.

Returns: list imported documents with their Google URLs

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

drive documents show

show an imported document's text, tabs and metadata

drive <profile> documents show <document>
Argument What it is
document required document id, Google Docs URL, or a search hit's document: ref.

Returns: show an imported document's text, tabs and metadata

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

drive documents export

write an imported document to a new Markdown file

This command changes local state.

drive <profile> documents export <document> [options]
Argument What it is
document required document id, Google Docs URL, or a search hit's document: ref.
Option What it does
--output <file> path of the Markdown file to write; an existing file is refused.

Returns: write an imported document to a new Markdown file

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

drive documents context

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

drive <profile> documents context <document>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.

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

Example: drive personal documents context DOC_ID

drive documents get

read a document live from Google Docs, as JSON with every tab

drive <profile> documents get <document>
Argument What it is
document required document id or Google Docs URL.

Returns: read a document live from Google Docs, as JSON with every tab

Example: drive personal documents get DOC_ID --json

drive documents check

ask Google whether an imported document changed since its local copy was made

drive <profile> documents check <document>
Argument What it is
document required document id or Google Docs URL.

Returns: ask Google whether an imported document changed since its local copy was made

Example: drive personal documents check DOC_ID

drive documents create

create an empty Google Doc

This command can change Google data or send data to the configured model.

drive <profile> documents create [options]
Option What it does
--title <title> title of the new document.

Returns: create an empty Google Doc

Example: drive personal documents create --title "Meeting notes"

drive documents update

change a Google Doc with a Docs batchUpdate request

This command can change Google data or send data to the configured model.

drive <profile> documents update <document> [options]
Argument What it is
document required document id or Google Docs URL.
Option What it does
--body <json> Docs batchUpdate body: requests and an optional writeControl.

Returns: change a Google Doc with a Docs batchUpdate request

Example: drive personal documents update DOC_ID --body '{"requests":[]}'

drive documents history

list the revisions Google kept, or who did what with --activity

drive <profile> documents history <document> [options]
Argument What it is
document required document id or Google Docs URL.
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.
--activity list activity events instead of revisions; needs session start --grant activity.

Returns: list the revisions Google kept, or who did what with --activity

Example: drive personal documents history DOC_ID, drive personal documents history DOC_ID --activity

drive search

search imported documents by words, and by meaning when indexed

drive <profile> search <query> [options]
Argument What it is
query required words to look for, and fields such as tag: and date: that every hit must match.
Option What it does
--limit <n> how many results to return. Default: 20.
--page <n> which page to return. Default: 1.
--exact match the words exactly: no word forms, no meaning.

Returns: search imported documents by words, and by meaning when indexed

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

drive catalog

browse stored Drive files and folders offline

drive catalog import

put cached file and folder metadata into the shared database

This command changes local state.

drive <profile> catalog import

Returns: put cached file and folder metadata into the shared database

Example: drive personal catalog import --offline

drive catalog show

show stored metadata and the stable file or folder reference

drive <profile> catalog show <file>
Argument What it is
file required Google file or folder id, or its Drive URL.

Returns: show stored metadata and the stable file or folder reference

Next usually: drive documents show <document>, drive documents context <document>, drive documents get <document>

Example: drive personal catalog show FILE_ID --offline

drive catalog list

list cached files and folders using metadata queries

drive <profile> catalog list [query] [options]
Argument What it is
query optional metadata query: kind, mime, name, parent, person, tag; AND, OR, NOT.
Option What it does
--limit <n> how many entries to return (at most 1000). Default: 50.
--page <n> which page to return. Default: 1.

Returns: list cached files and folders using metadata queries

Next usually: drive documents show <document>, drive documents context <document>, drive documents get <document>

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

drive catalog search

search cached names, descriptions, types and observed people

drive <profile> catalog search <query> [options]
Argument What it is
query required metadata query: kind, mime, name, parent, person, tag; AND, OR, NOT.
Option What it does
--limit <n> how many entries to return (at most 1000). Default: 50.
--page <n> which page to return. Default: 1.

Returns: search cached names, descriptions, types and observed people

Next usually: drive documents show <document>, drive documents context <document>, drive documents get <document>

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

drive catalog tree

show the cached hierarchy below a folder or all selected roots

drive <profile> catalog tree [folder] [options]
Argument What it is
folder optional Google folder id or URL; defaults to the explicitly selected profile's roots.
Option What it does
--depth <n> maximum descendant depth, from 0 to 50. Default: 5.

Returns: show the cached hierarchy below a folder or all selected roots

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

drive catalog tags

add owner tags to cached files or folders

drive catalog tags list

list local tags on a cached file or folder

drive <profile> catalog tags list <file> [query]
Argument What it is
file required Google file or folder id, or its Drive URL.
query optional field:value terms that narrow the list — the fields are below.

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

Example: drive personal catalog tags list FOLDER_ID --offline

drive catalog tags add

add local tags on a cached file or folder

This command changes local state.

drive <profile> catalog tags add <file> <tags>
Argument What it is
file required Google file or folder id, or its Drive URL.
tags required local tag names.

Returns: add local tags on a cached file or folder

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

drive catalog tags remove

remove local tags on a cached file or folder

This command changes local state.

drive <profile> catalog tags remove <file> <tags>
Argument What it is
file required Google file or folder id, or its Drive URL.
tags required local tag names.

Returns: remove local tags on a cached file or folder

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

drive tags

label imported documents; labels survive a sync

drive tags list

list a document's tags

drive <profile> tags list <document> [query]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.

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

Example: drive personal tags list DOC_ID

drive tags add

tag a document

This command changes local state.

drive <profile> tags add <document> <tags>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
tags required one or more tags.

Returns: tag a document

Example: drive personal tags add DOC_ID budget q3

drive tags remove

untag a document

This command changes local state.

drive <profile> tags remove <document> <tags>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
tags required one or more tags.

Returns: untag a document

Example: drive personal tags remove DOC_ID budget q3

drive relationships

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

drive relationships list

list a document's relationships

drive <profile> relationships list <document> [query]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.

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

Example: drive personal relationships list DOC_ID

drive relationships add

connect a document to another reference

This command changes local state.

drive <profile> relationships add <document> <reference> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
reference required what it connects to, such as person:, project: or note:.
Option What 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.

Returns: connect a document to another reference

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

drive relationships remove

remove one of a document's relationships

This command changes local state.

drive <profile> relationships remove <document> <relationship-id>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
relationship-id required id, as relationships list prints it.

Returns: remove one of a document's relationships

Example: drive personal relationships remove DOC_ID LINK_ID

drive notes

write notes about an imported document

drive notes add

write a note about a document

This command changes local state.

drive <profile> notes add <document> <text> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
text required the note's text.
Option What 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: drive commands info notes add

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

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

drive notes list

list a document's notes

drive <profile> notes list <document> [query] [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.
Option What 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: drive commands info notes list

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

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

drive notes show

show one note

drive <profile> notes show <document> <note>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
note required note: reference, as notes list prints it.

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

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

Example: drive personal notes show DOC_ID note:NOTE_ID

drive notes edit

replace a note's text

This command changes local state.

drive <profile> notes edit <document> <note> <text> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
note required note: reference, as notes list prints it.
text required the note's new text.
Option What 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: drive commands info notes edit

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

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

drive notes remove

delete one note

This command changes local state.

drive <profile> notes remove <document> <note>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
note required note: reference, as notes list prints it.

Returns: delete one note

Example: drive personal notes remove DOC_ID note:NOTE_ID

drive memories

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

drive memories add

record a memory about a document

This command changes local state.

drive <profile> memories add <document> <text> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
text required what to remember.
Option What 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.

Returns: record a memory about a document

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

drive memories list

list a document's memories

drive <profile> memories list <document> [query] [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.
Option What it does
--limit <n> how many memories to return. Default: 50.

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

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

drive memories show

show one memory

drive <profile> memories show <document> <memory>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
memory required memory: reference, as memories list prints it.

Returns: show one memory

Example: drive personal memories show DOC_ID memory:MEMORY_ID

drive memories confirm

confirm a proposed memory as true

This command changes local state.

drive <profile> memories confirm <document> <memory>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
memory required memory: reference, as memories list prints it.

Returns: confirm a proposed memory as true

Example: drive personal memories confirm DOC_ID memory:MEMORY_ID

drive memories stale

mark a memory as out of date

This command changes local state.

drive <profile> memories stale <document> <memory>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
memory required memory: reference, as memories list prints it.

Returns: mark a memory as out of date

Example: drive personal memories stale DOC_ID memory:MEMORY_ID

drive memories search

search a document's memories by words

drive <profile> memories search <document> <query>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query required words to look for, and scope:personal or scope:work — the fields are below.

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

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

drive memories extract

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

This command can change Google data or send data to the configured model.

drive <profile> memories extract <document> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
Option What it does
--scope <scope> whose memories they become: personal or work. One of: personal, work.
--tab <id> send only this tab of the document.
--yes save the proposals, each with its quote and the document's version.

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

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

drive facts

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

drive facts add

record a fact a document shows

This command changes local state.

drive <profile> facts add <document> <statement> [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
statement required the fact, in one sentence.
Option What 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.

Returns: record a fact a document shows

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

drive facts list

list a document's facts

drive <profile> facts list <document> [query] [options]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.
Option What it does
--limit <n> how many facts to return. Default: 50.

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

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

drive facts show

show one fact

drive <profile> facts show <document> <fact>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
fact required fact: reference, as facts list prints it.

Returns: show one fact

Example: drive personal facts show DOC_ID fact:FACT_ID

drive facts confirm

confirm a proposed fact; a decision it supersedes stops holding

This command changes local state.

drive <profile> facts confirm <document> <fact>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
fact required fact: reference, as facts list prints it.

Returns: confirm a proposed fact; a decision it supersedes stops holding

Example: drive personal facts confirm DOC_ID fact:FACT_ID

drive facts reverse

an accepted decision no longer holds, and nothing replaced it

This command changes local state.

drive <profile> facts reverse <document> <fact>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
fact required fact: reference, as facts list prints it.

Returns: an accepted decision no longer holds, and nothing replaced it

Example: drive personal facts reverse DOC_ID fact:FACT_ID

drive identities

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

drive identities list

list the owners and last editor Google shows for a document

drive <profile> identities list <document> [query]
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
query optional field:value terms that narrow the list — the fields are below.

Returns: drive document identity — google_id, role, person; every field: drive commands info identities list

Example: drive personal identities list DOC_ID

drive identities link

record that a Google account belongs to a known person

This command changes local state.

drive <profile> identities link <document> <google-id> <person>
Argument What it is
document required Google file or folder id or URL in the local catalog, or a document: ref.
google-id required Google account id, as identities list prints it.
person required person: reference of someone already known.

Returns: record that a Google account belongs to a known person

Example: drive personal identities link DOC_ID GOOGLE_ID person:PERSON_UID

drive api

discover and call the official Drive, Docs, Sheets and Activity API methods

drive api list

list the Google API methods drive can call

drive api list [query]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.

Returns: api method — name, mutates, destructive, scope; every field: drive commands info api list

Example: drive api list, drive api list service:docs

drive api show

show one method's request schema and contract, without calling Google

drive api show <method>
Argument What it is
method required Google method name, as api list prints it.

Returns: show one method's request schema and contract, without calling Google

Example: drive api show docs.documents.batchUpdate --json

drive api call

call one Google API method by name with JSON parameters

This command can change Google data or send data to the configured model.

drive <profile> api call <method> [options]
Argument What it is
method required Google method name, as api list prints it.
Option What it does
--params <json> query and path parameters as a JSON object. Default: [object Object].
--body <json> request body as a JSON object.
--allow-writes allow a method that changes Google data.
--allow-delete allow a method that deletes for good or empties the trash.

Returns: call one Google API method by name with JSON parameters

Example: drive personal api call drive.files.get --params '{"fileId":"FILE_ID"}', drive personal api call drive.files.update --params '{"fileId":"FILE_ID"}' --body '{"name":"New"}' --allow-writes

drive api docs-documents-batch-update

Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. — write (POST v1/documents/{documentId}:batchUpdate)

This command can change Google data or send data to the configured model.

drive <profile> api docs-documents-batch-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--document-id <value> The ID of the document to update.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Applies one or more updates to the document. Each request is validated…

Example: drive personal api docs-documents-batch-update --document-id <value>

drive api docs-documents-create

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document. — write (POST v1/documents)

This command can change Google data or send data to the configured model.

drive <profile> api docs-documents-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a blank document using the title given in the request. Other fields…

Example: drive personal api docs-documents-create

drive api docs-documents-get

Gets the latest version of the specified document. — read (GET v1/documents/{documentId})

drive <profile> api docs-documents-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--document-id <value> The ID of the document to retrieve.
--comments-view-mode <value> The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to true or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED.
--include-tabs-content <value> Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When true: Document content populates in the Document.tabs field instead of the text content fields in Document. - When false: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. If you use a field mask that references the Document.tabs field (or any subfield), the API implicitly treats the request as if you set include_tabs_content to true.
--suggestions-view-mode <value> The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.

Returns: Gets the latest version of the specified document. — read (GET…

Example: drive personal api docs-documents-get --document-id <value>

drive api drive-about-get

Gets information about the user, the user's Drive, and system capabilities. For more information, see Return user info. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields. — read (GET about)

drive <profile> api drive-about-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns: Gets information about the user, the user's Drive, and system capabilities.…

Example: drive personal api drive-about-get

drive api drive-accessproposals-get

Retrieves an access proposal by ID. For more information, see Manage pending access proposals. — read (GET files/{fileId}/accessproposals/{proposalId})

drive <profile> api drive-accessproposals-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--proposal-id <value> Required. The ID of the access proposal to resolve.
--file-id <value> Required. The ID of the item the request is on.

Returns: Retrieves an access proposal by ID. For more information, see [Manage…

Example: drive personal api drive-accessproposals-get --proposal-id <value> --file-id <value>

drive api drive-accessproposals-list

List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned. — read (GET files/{fileId}/accessproposals)

drive <profile> api drive-accessproposals-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--page-token <value> Optional. The continuation token on the list of access requests.
--file-id <value> Required. The ID of the item the request is on.
--page-size <value> Optional. The number of results per page.

Returns: List the access proposals on a file. For more information, see [Manage…

Example: drive personal api drive-accessproposals-list --file-id <value>

drive api drive-accessproposals-resolve

Approves or denies an access proposal. For more information, see Manage pending access proposals. — write (POST files/{fileId}/accessproposals/{proposalId}:resolve)

This command can change Google data or send data to the configured model.

drive <profile> api drive-accessproposals-resolve [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the item the request is on.
--proposal-id <value> Required. The ID of the access proposal to resolve.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Approves or denies an access proposal. For more information, see [Manage…

Example: drive personal api drive-accessproposals-resolve --file-id <value> --proposal-id <value>

drive api drive-approvals-approve

Approves an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of APPROVED. If this is the last required reviewer response, this also completes the approval and sets the approval Status to APPROVED. — write (POST files/{fileId}/approvals/{approvalId}:approve)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-approve [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--approval-id <value> Required. The ID of the approval to approve.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Approves an approval. For more information, see [Manage…

Example: drive personal api drive-approvals-approve --file-id <value> --approval-id <value>

drive api drive-approvals-cancel

Cancels an approval. For more information, see Manage approvals. Updates the approval Status to CANCELLED. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS. — write (POST files/{fileId}/approvals/{approvalId}:cancel)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-cancel [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--approval-id <value> Required. The ID of the approval to cancel.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Cancels an approval. For more information, see [Manage…

Example: drive personal api drive-approvals-cancel --file-id <value> --approval-id <value>

drive api drive-approvals-comment

Comments on an approval. For more information, see Manage approvals. This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log. — write (POST files/{fileId}/approvals/{approvalId}:comment)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-comment [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--approval-id <value> Required. The ID of the approval to comment on.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Comments on an approval. For more information, see [Manage…

Example: drive personal api drive-approvals-comment --file-id <value> --approval-id <value>

drive api drive-approvals-decline

Declines an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of DECLINED. This also completes the approval and sets the approval Status to DECLINED. — write (POST files/{fileId}/approvals/{approvalId}:decline)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-decline [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--approval-id <value> Required. The ID of the approval to decline.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Declines an approval. For more information, see [Manage…

Example: drive personal api drive-approvals-decline --file-id <value> --approval-id <value>

drive api drive-approvals-get

Gets an approval by ID. For more information, see Manage approvals. — read (GET files/{fileId}/approvals/{approvalId})

drive <profile> api drive-approvals-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--approval-id <value> Required. The ID of the approval.

Returns: Gets an approval by ID. For more information, see [Manage…

Example: drive personal api drive-approvals-get --file-id <value> --approval-id <value>

drive api drive-approvals-list

Lists the approvals on a file. For more information, see Manage approvals. By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the fields query parameter. To return the exact fields you need, see Return specific fields. — read (GET files/{fileId}/approvals)

drive <profile> api drive-approvals-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is on.
--page-size <value> The maximum number of approvals to return. When not set, at most 100 approvals are returned.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

Returns: Lists the approvals on a file. For more information, see [Manage…

Example: drive personal api drive-approvals-list --file-id <value>

drive api drive-approvals-reassign

Reassigns the reviewers on an approval. For more information, see Manage approvals. Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS and the Response for the reviewer being reassigned is NO_RESPONSE. A user with the reader permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed. — write (POST files/{fileId}/approvals/{approvalId}:reassign)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-reassign [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--approval-id <value> Required. The ID of the approval to reassign.
--file-id <value> Required. The ID of the file that the approval is on.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Reassigns the reviewers on an approval. For more information, see [Manage…

Example: drive personal api drive-approvals-reassign --approval-id <value> --file-id <value>

drive api drive-approvals-start

Starts an approval on a file. For more information, see Manage approvals. — write (POST files/{fileId}/approvals:start)

This command can change Google data or send data to the configured model.

drive <profile> api drive-approvals-start [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file that the approval is created on.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Starts an approval on a file. For more information, see [Manage…

Example: drive personal api drive-approvals-start --file-id <value>

drive api drive-apps-get

Gets a specific app. For more information, see Return user info. — read (GET apps/{appId})

drive <profile> api drive-apps-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--app-id <value> The ID of the app.

Returns: Gets a specific app. For more information, see [Return user…

Example: drive personal api drive-apps-get --app-id <value>

drive api drive-apps-list

Lists a user's installed apps. For more information, see Return user info. — read (GET apps)

drive <profile> api drive-apps-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--language-code <value> A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
--app-filter-extensions <value> A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given file extensions are included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
--app-filter-mime-types <value> A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.

Returns: Lists a user's installed apps. For more information, see [Return user…

Example: drive personal api drive-apps-list

drive api drive-changes-get-start-page-token

Gets the starting pageToken for listing future changes. For more information, see Retrieve changes. — read (GET changes/startPageToken)

drive <profile> api drive-changes-get-start-page-token [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--drive-id <value> The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--team-drive-id <value> Deprecated: Use driveId instead.

Returns: Gets the starting pageToken for listing future changes. For more…

Example: drive personal api drive-changes-get-start-page-token

drive api drive-changes-list

Lists the changes for a user or shared drive. For more information, see Retrieve changes. — read (GET changes)

drive <profile> api drive-changes-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--drive-id <value> The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
--restrict-to-my-drive <value> Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
--include-items-from-all-drives <value> Whether both My Drive and shared drive items should be included in results.
--include-corpus-removals <value> Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
--include-team-drive-items <value> Deprecated: Use includeItemsFromAllDrives instead.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only 'published' is supported.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
--page-size <value> The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
--include-removed <value> Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--team-drive-id <value> Deprecated: Use driveId instead.
--spaces <value> A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.

Returns: Lists the changes for a user or shared drive. For more information, see…

Example: drive personal api drive-changes-list --page-token <value>

drive api drive-changes-watch

Subscribes to changes for a user. For more information, see Notifications for resource changes. — write (POST changes/watch)

This command can change Google data or send data to the configured model.

drive <profile> api drive-changes-watch [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--spaces <value> A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
--include-items-from-all-drives <value> Whether both My Drive and shared drive items should be included in results.
--page-size <value> The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--restrict-to-my-drive <value> Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
--team-drive-id <value> Deprecated: Use driveId instead.
--include-corpus-removals <value> Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
--include-team-drive-items <value> Deprecated: Use includeItemsFromAllDrives instead.
--include-removed <value> Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
--drive-id <value> The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only 'published' is supported.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Subscribes to changes for a user. For more information, see [Notifications…

Example: drive personal api drive-changes-watch --page-token <value>

drive api drive-channels-stop

Stops watching resources through this channel. For more information, see Notifications for resource changes. — write (POST channels/stop)

This command can change Google data or send data to the configured model.

drive <profile> api drive-channels-stop [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Stops watching resources through this channel. For more information, see…

Example: drive personal api drive-channels-stop

drive api drive-comments-create

Creates a comment on a file. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields. — write (POST files/{fileId}/comments)

This command can change Google data or send data to the configured model.

drive <profile> api drive-comments-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a comment on a file. For more information, see [Manage comments and…

Example: drive personal api drive-comments-create --file-id <value>

drive api drive-comments-delete

Deletes a comment. For more information, see Manage comments and replies. — destructive (DELETE files/{fileId}/comments/{commentId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-comments-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--comment-id <value> The ID of the comment.
--file-id <value> The ID of the file.

Returns: Deletes a comment. For more information, see [Manage comments and…

Example: drive personal api drive-comments-delete --comment-id <value> --file-id <value>

drive api drive-comments-get

Gets a comment by ID. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields. — read (GET files/{fileId}/comments/{commentId})

drive <profile> api drive-comments-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--include-deleted <value> Whether to return deleted comments. Deleted comments will not include their original content.
--comment-id <value> The ID of the comment.

Returns: Gets a comment by ID. For more information, see [Manage comments and…

Example: drive personal api drive-comments-get --file-id <value> --comment-id <value>

drive api drive-comments-list

Lists a file's comments. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields. — read (GET files/{fileId}/comments)

drive <profile> api drive-comments-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--include-deleted <value> Whether to include deleted comments. Deleted comments will not include their original content.
--page-size <value> The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
--file-id <value> The ID of the file.
--start-modified-time <value> The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).

Returns: Lists a file's comments. For more information, see [Manage comments and…

Example: drive personal api drive-comments-list --file-id <value>

drive api drive-comments-update

Updates a comment with patch semantics. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields. — write (PATCH files/{fileId}/comments/{commentId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-comments-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--comment-id <value> The ID of the comment.
--file-id <value> The ID of the file.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates a comment with patch semantics. For more information, see [Manage…

Example: drive personal api drive-comments-update --comment-id <value> --file-id <value>

drive api drive-drives-create

Creates a shared drive. For more information, see Manage shared drives. — write (POST drives)

This command can change Google data or send data to the configured model.

drive <profile> api drive-drives-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--request-id <value> Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a shared drive. For more information, see [Manage shared…

Example: drive personal api drive-drives-create --request-id <value>

drive api drive-drives-delete

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. For more information, see Manage shared drives. — destructive (DELETE drives/{driveId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-drives-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--drive-id <value> The ID of the shared drive.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
--allow-item-deletion <value> Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.

Returns: Permanently deletes a shared drive for which the user is an organizer. The…

Example: drive personal api drive-drives-delete --drive-id <value>

drive api drive-drives-get

Gets a shared drive's metadata by ID. For more information, see Manage shared drives. — read (GET drives/{driveId})

drive <profile> api drive-drives-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--drive-id <value> The ID of the shared drive.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

Returns: Gets a shared drive's metadata by ID. For more information, see [Manage…

Example: drive personal api drive-drives-get --drive-id <value>

drive api drive-drives-hide

Hides a shared drive from the default view. For more information, see Manage shared drives. — write (POST drives/{driveId}/hide)

This command can change Google data or send data to the configured model.

drive <profile> api drive-drives-hide [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--drive-id <value> The ID of the shared drive.

Returns: Hides a shared drive from the default view. For more information, see…

Example: drive personal api drive-drives-hide --drive-id <value>

drive api drive-drives-list

Lists the user's shared drives. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide. — read (GET drives)

drive <profile> api drive-drives-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--q <value> Query string for searching shared drives.
--page-token <value> Page token for shared drives.
--page-size <value> The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.

Returns: Lists the user's shared drives. This method accepts the q parameter,…

Example: drive personal api drive-drives-list

drive api drive-drives-unhide

Restores a shared drive to the default view. For more information, see Manage shared drives. — write (POST drives/{driveId}/unhide)

This command can change Google data or send data to the configured model.

drive <profile> api drive-drives-unhide [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--drive-id <value> The ID of the shared drive.

Returns: Restores a shared drive to the default view. For more information, see…

Example: drive personal api drive-drives-unhide --drive-id <value>

drive api drive-drives-update

Updates the metadata for a shared drive. For more information, see Manage shared drives. — write (PATCH drives/{driveId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-drives-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
--drive-id <value> The ID of the shared drive.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates the metadata for a shared drive. For more information, see [Manage…

Example: drive personal api drive-drives-update --drive-id <value>

drive api drive-files-copy

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files. — write (POST files/{fileId}/copy)

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-copy [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--ignore-default-visibility <value> Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
--keep-revision-forever <value> Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--copy-comments <value> Whether to copy the open (unresolved) comments associated with the file.
--enforce-single-parent <value> Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.
--ocr-language <value> A language hint for OCR processing during image import (ISO 639-1 code).
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a copy of a file and applies any requested updates with patch…

Example: drive personal api drive-files-copy --file-id <value>

drive api drive-files-create

Creates a file. For more information, see Create and manage files. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data. Apps creating shortcuts with the create method must specify the MIME type application/vnd.google-apps.shortcut. Apps should specify a file extension in the name property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "name": "cat.jpg" in the metadata. Subsequent GET requests include the read-only fileExtension property populated with the extension originally specified in the name property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. — write (POST files)

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--enforce-single-parent <value> Deprecated: Creating files in multiple folders is no longer supported.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--ignore-default-visibility <value> Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
--ocr-language <value> A language hint for OCR processing during image import (ISO 639-1 code).
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--use-content-as-indexable-text <value> Whether to use the uploaded content as indexable text.
--keep-revision-forever <value> Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a file. For more information, see [Create and manage…

Example: drive personal api drive-files-create

drive api drive-files-delete

Permanently deletes a file owned by the user without moving it to the trash. For more information, see Trash or delete files and folders. If the file belongs to a shared drive, the user must be an organizer on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. — destructive (DELETE files/{fileId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--file-id <value> The ID of the file.
--enforce-single-parent <value> Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.

Returns: Permanently deletes a file owned by the user without moving it to the trash.…

Example: drive personal api drive-files-delete --file-id <value>

drive api drive-files-download

Downloads the content of a file. For more information, see Download and export files. Operations are valid for 24 hours from the time of creation. — read (POST files/{fileId}/download)

drive <profile> api drive-files-download [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> Required. The ID of the file to download.
--mime-type <value> Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see Export MIME types for Google Workspace documents. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
--revision-id <value> Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns INVALID_ARGUMENT if downloading a specific revision on the file is unsupported.

Returns: Downloads the content of a file. For more information, see [Download and…

Example: drive personal api drive-files-download --file-id <value>

drive api drive-files-empty-trash

Permanently deletes all of the user's trashed files. For more information, see Trash or delete files and folders. — destructive (DELETE files/trash)

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-empty-trash [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--enforce-single-parent <value> Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
--drive-id <value> If set, empties the trash of the provided shared drive.

Returns: Permanently deletes all of the user's trashed files. For more information,…

Example: drive personal api drive-files-empty-trash

drive api drive-files-export

Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see Download and export files. Note that the exported content is limited to 10 MB. — read (GET files/{fileId}/export)

drive <profile> api drive-files-export [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--mime-type <value> Required. The MIME type of the format requested for this export. For a list of supported MIME types, see Export MIME types for Google Workspace documents.
--file-id <value> The ID of the file.

Returns: Exports a Google Workspace document to the requested MIME type and returns…

Example: drive personal api drive-files-export --mime-type <value> --file-id <value>

drive api drive-files-generate-cse-token

Generates a CSE token which can be used to create or update CSE files. — read (GET files/generateCseToken)

drive <profile> api drive-files-generate-cse-token [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--parent <value> The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.
--file-id <value> The ID of the file for which the JWT should be generated. If not provided, an id will be generated.

Returns: Generates a CSE token which can be used to create or update CSE files. —…

Example: drive personal api drive-files-generate-cse-token

drive api drive-files-generate-ids

Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files. — read (GET files/generateIds)

drive <profile> api drive-files-generate-ids [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--space <value> The space in which the IDs can be used to create files. Supported values are drive and appDataFolder. (Default: drive.) For more information, see File organization.
--type <value> The type of items which the IDs can be used for. Supported values are files and shortcuts. Note that shortcuts are only supported in the drive space. (Default: files.) For more information, see File organization.
--count <value> The number of IDs to return.

Returns: Generates a set of file IDs which can be provided in create or copy…

Example: drive personal api drive-files-generate-ids

drive api drive-files-get

Gets a file's metadata or content by ID. For more information, see Search for files and folders. If you provide the URL parameter alt=media, then the response includes the file contents in the response body. Downloading content with alt=media only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use files.export instead. For more information, see Download and export files. — read (GET files/{fileId})

drive <profile> api drive-files-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--acknowledge-abuse <value> Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--file-id <value> The ID of the file.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.

Returns: Gets a file's metadata or content by ID. For more information, see [Search…

Example: drive personal api drive-files-get --file-id <value>

drive api drive-files-list

Lists the user's files. For more information, see Search for files and folders. This method accepts the q parameter, which is a search query combining one or more search terms. This method returns all files by default, including trashed files. If you don't want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results. — read (GET files)

drive <profile> api drive-files-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--corpus <value> Deprecated: The source of files to list. Use corpora instead.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--corpora <value> Specifies a collection of items (files or documents) to which the query applies. Supported items include: * user * domain * drive * allDrives Prefer user or drive to allDrives for efficiency. By default, corpora is set to user. However, this can change depending on the filter set through the q parameter. For more information, see File organization.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--page-size <value> The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.
--spaces <value> A comma-separated list of spaces to query within the corpora. Supported values are drive and appDataFolder. For more information, see File organization.
--team-drive-id <value> Deprecated: Use driveId instead.
--order-by <value> A comma-separated list of sort keys. Valid keys are: * createdTime: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use modifiedTime desc instead. * folder: The folder ID. This field is sorted using alphabetical ordering. * modifiedByMeTime: The last time the file was modified by the user. * modifiedTime: The last time the file was modified by anyone. * name: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * name_natural: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * quotaBytesUsed: The number of storage quota bytes used by the file. * recency: The most recent timestamp from the file's date-time fields. * sharedWithMeTime: When the file was shared with the user, if applicable. * starred: Whether the user has starred the file. * viewedByMeTime: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the desc modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response.
--include-team-drive-items <value> Deprecated: Use includeItemsFromAllDrives instead.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--include-items-from-all-drives <value> Whether both My Drive and shared drive items should be included in results.
--q <value> A query for filtering the file results. For supported syntax, see Search for files and folders.
--drive-id <value> ID of the shared drive to search.

Returns: Lists the user's files. For more information, see [Search for files and…

Example: drive personal api drive-files-list

drive api drive-files-list-labels

Lists the labels on a file. For more information, see List labels on a file. — read (GET files/{fileId}/listLabels)

drive <profile> api drive-files-list-labels [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--max-results <value> The maximum number of labels to return per page. When not set, defaults to 100.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response.
--file-id <value> The ID for the file.

Returns: Lists the labels on a file. For more information, see [List labels on a…

Example: drive personal api drive-files-list-labels --file-id <value>

drive api drive-files-modify-labels

Modifies the set of labels applied to a file. For more information, see Set a label field on a file. Returns a list of the labels that were added or modified. — write (POST files/{fileId}/modifyLabels)

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-modify-labels [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file to which the labels belong.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Modifies the set of labels applied to a file. For more information, see [Set…

Example: drive personal api drive-files-modify-labels --file-id <value>

drive api drive-files-update

Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data. — write (PATCH files/{fileId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--ocr-language <value> A language hint for OCR processing during image import (ISO 639-1 code).
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--enforce-single-parent <value> Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
--add-parents <value> A comma-separated list of parent IDs to add.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--keep-revision-forever <value> Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
--file-id <value> The ID of the file.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--remove-parents <value> A comma-separated list of parent IDs to remove.
--use-content-as-indexable-text <value> Whether to use the uploaded content as indexable text.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates a file's metadata, content, or both. When calling this method, only…

Example: drive personal api drive-files-update --file-id <value>

drive api drive-files-watch

Subscribes to changes to a file. For more information, see Notifications for resource changes. — write (POST files/{fileId}/watch)

This command can change Google data or send data to the configured model.

drive <profile> api drive-files-watch [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--include-labels <value> A comma-separated list of IDs of labels to include in the labelInfo part of the response.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--acknowledge-abuse <value> Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Subscribes to changes to a file. For more information, see [Notifications…

Example: drive personal api drive-files-watch --file-id <value>

drive api drive-operations-get

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. — read (GET operations/{name})

drive <profile> api drive-operations-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--name <value> The name of the operation resource.

Returns: Gets the latest state of a long-running operation. Clients can use this…

Example: drive personal api drive-operations-get --name <value>

drive api drive-permissions-create

Creates a permission for a file or shared drive. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — write (POST files/{fileId}/permissions)

This command can change Google data or send data to the configured model.

drive <profile> api drive-permissions-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--enforce-expansive-access <value> Deprecated: All requests use the expansive access rules.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--send-notification-email <value> Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
--use-domain-admin-access <value> Issue the request as a domain administrator. If set to true, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see Manage shared drives as domain administrators.
--transfer-ownership <value> Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see Transfer file ownership.
--file-id <value> The ID of the file or shared drive.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--email-message <value> A plain text custom message to include in the notification email.
--enforce-single-parent <value> Deprecated: See moveToNewOwnersRoot for details.
--move-to-new-owners-root <value> This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents aren't changed.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a permission for a file or shared drive. For more information, see…

Example: drive personal api drive-permissions-create --file-id <value>

drive api drive-permissions-delete

Deletes a permission. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — destructive (DELETE files/{fileId}/permissions/{permissionId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-permissions-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--use-domain-admin-access <value> Issue the request as a domain administrator. If set to true, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see Manage shared drives as domain administrators.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--permission-id <value> The ID of the permission.
--enforce-expansive-access <value> Deprecated: All requests use the expansive access rules.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--file-id <value> The ID of the file or shared drive.

Returns: Deletes a permission. For more information, see [Share files, folders, and…

Example: drive personal api drive-permissions-delete --permission-id <value> --file-id <value>

drive api drive-permissions-get

Gets a permission by ID. For more information, see Share files, folders, and drives. — read (GET files/{fileId}/permissions/{permissionId})

drive <profile> api drive-permissions-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--permission-id <value> The ID of the permission.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--use-domain-admin-access <value> Issue the request as a domain administrator. If set to true, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see Manage shared drives as domain administrators.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--file-id <value> The ID of the file.

Returns: Gets a permission by ID. For more information, see [Share files, folders,…

Example: drive personal api drive-permissions-get --permission-id <value> --file-id <value>

drive api drive-permissions-list

Lists a file's or shared drive's permissions. For more information, see Share files, folders, and drives. — read (GET files/{fileId}/permissions)

drive <profile> api drive-permissions-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--use-domain-admin-access <value> Issue the request as a domain administrator. If set to true, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see Manage shared drives as domain administrators.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response.
--file-id <value> The ID of the file or shared drive.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--page-size <value> The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.
--include-permissions-for-view <value> Specifies which additional view's permissions to include in the response. Only published is supported.

Returns: Lists a file's or shared drive's permissions. For more information, see…

Example: drive personal api drive-permissions-list --file-id <value>

drive api drive-permissions-update

Updates a permission with patch semantics. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — write (PATCH files/{fileId}/permissions/{permissionId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-permissions-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--use-domain-admin-access <value> Issue the request as a domain administrator. If set to true, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see Manage shared drives as domain administrators.
--transfer-ownership <value> Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see Transfer file ownership.
--enforce-expansive-access <value> Deprecated: All requests use the expansive access rules.
--supports-all-drives <value> Whether the requesting application supports both My Drives and shared drives.
--supports-team-drives <value> Deprecated: Use supportsAllDrives instead.
--file-id <value> The ID of the file or shared drive.
--remove-expiration <value> Whether to remove the expiration date.
--permission-id <value> The ID of the permission.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates a permission with patch semantics. For more information, see [Share…

Example: drive personal api drive-permissions-update --file-id <value> --permission-id <value>

drive api drive-replies-create

Creates a reply to a comment. For more information, see Manage comments and replies. — write (POST files/{fileId}/comments/{commentId}/replies)

This command can change Google data or send data to the configured model.

drive <profile> api drive-replies-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--comment-id <value> The ID of the comment.
--file-id <value> The ID of the file.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a reply to a comment. For more information, see [Manage comments and…

Example: drive personal api drive-replies-create --comment-id <value> --file-id <value>

drive api drive-replies-delete

Deletes a reply. For more information, see Manage comments and replies. — destructive (DELETE files/{fileId}/comments/{commentId}/replies/{replyId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-replies-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--comment-id <value> The ID of the comment.
--reply-id <value> The ID of the reply.
--file-id <value> The ID of the file.

Returns: Deletes a reply. For more information, see [Manage comments and…

Example: drive personal api drive-replies-delete --comment-id <value> --reply-id <value> --file-id <value>

drive api drive-replies-get

Gets a reply by ID. For more information, see Manage comments and replies. — read (GET files/{fileId}/comments/{commentId}/replies/{replyId})

drive <profile> api drive-replies-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--include-deleted <value> Whether to return deleted replies. Deleted replies don't include their original content.
--file-id <value> The ID of the file.
--comment-id <value> The ID of the comment.
--reply-id <value> The ID of the reply.

Returns: Gets a reply by ID. For more information, see [Manage comments and…

Example: drive personal api drive-replies-get --file-id <value> --comment-id <value> --reply-id <value>

drive api drive-replies-list

Lists a comment's replies. For more information, see Manage comments and replies. — read (GET files/{fileId}/comments/{commentId}/replies)

drive <profile> api drive-replies-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--page-size <value> The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.
--file-id <value> The ID of the file.
--comment-id <value> The ID of the comment.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response.
--include-deleted <value> Whether to include deleted replies. Deleted replies don't include their original content.

Returns: Lists a comment's replies. For more information, see [Manage comments and…

Example: drive personal api drive-replies-list --file-id <value> --comment-id <value>

drive api drive-replies-update

Updates a reply with patch semantics. For more information, see Manage comments and replies. — write (PATCH files/{fileId}/comments/{commentId}/replies/{replyId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-replies-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--comment-id <value> The ID of the comment.
--file-id <value> The ID of the file.
--reply-id <value> The ID of the reply.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates a reply with patch semantics. For more information, see [Manage…

Example: drive personal api drive-replies-update --comment-id <value> --file-id <value> --reply-id <value>

drive api drive-revisions-delete

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see Manage file revisions. — destructive (DELETE files/{fileId}/revisions/{revisionId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-revisions-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--revision-id <value> The ID of the revision.

Returns: Permanently deletes a file version. You can only delete revisions for files…

Example: drive personal api drive-revisions-delete --file-id <value> --revision-id <value>

drive api drive-revisions-get

Gets a revision's metadata or content by ID. For more information, see Manage file revisions. — read (GET files/{fileId}/revisions/{revisionId})

drive <profile> api drive-revisions-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--revision-id <value> The ID of the revision.
--file-id <value> The ID of the file.
--acknowledge-abuse <value> Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.

Returns: Gets a revision's metadata or content by ID. For more information, see…

Example: drive personal api drive-revisions-get --revision-id <value> --file-id <value>

drive api drive-revisions-list

Lists a file's revisions. For more information, see Manage file revisions. Important: The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API. — read (GET files/{fileId}/revisions)

drive <profile> api drive-revisions-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--page-size <value> The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
--file-id <value> The ID of the file.
--page-token <value> The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

Returns: Lists a file's revisions. For more information, see [Manage file…

Example: drive personal api drive-revisions-list --file-id <value>

drive api drive-revisions-update

Updates a revision with patch semantics. For more information, see Manage file revisions. — write (PATCH files/{fileId}/revisions/{revisionId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-revisions-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--file-id <value> The ID of the file.
--revision-id <value> The ID of the revision.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Updates a revision with patch semantics. For more information, see [Manage…

Example: drive personal api drive-revisions-update --file-id <value> --revision-id <value>

drive api drive-teamdrives-create

Deprecated: Use drives.create instead. — write (POST teamdrives)

This command can change Google data or send data to the configured model.

drive <profile> api drive-teamdrives-create [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--request-id <value> Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Deprecated: Use drives.create instead. — write (POST teamdrives)

Example: drive personal api drive-teamdrives-create --request-id <value>

drive api drive-teamdrives-delete

Deprecated: Use drives.delete instead. — destructive (DELETE teamdrives/{teamDriveId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-teamdrives-delete [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--team-drive-id <value> The ID of the Team Drive.

Returns: Deprecated: Use drives.delete instead. — destructive (DELETE…

Example: drive personal api drive-teamdrives-delete --team-drive-id <value>

drive api drive-teamdrives-get

Deprecated: Use drives.get instead. — read (GET teamdrives/{teamDriveId})

drive <profile> api drive-teamdrives-get [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--team-drive-id <value> The ID of the Team Drive.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.

Returns: Deprecated: Use drives.get instead. — read (GET teamdrives/{teamDriveId})

Example: drive personal api drive-teamdrives-get --team-drive-id <value>

drive api drive-teamdrives-list

Deprecated: Use drives.list instead. — read (GET teamdrives)

drive <profile> api drive-teamdrives-list [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--q <value> Query string for searching Team Drives.
--page-size <value> Maximum number of Team Drives to return.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
--page-token <value> Page token for Team Drives.

Returns: Deprecated: Use drives.list instead. — read (GET teamdrives)

Example: drive personal api drive-teamdrives-list

drive api drive-teamdrives-update

Deprecated: Use drives.update instead. — write (PATCH teamdrives/{teamDriveId})

This command can change Google data or send data to the configured model.

drive <profile> api drive-teamdrives-update [options]
Option What it does
--fields <value> Selector specifying which fields to include in a partial response.
--pretty-print <value> Returns response with indentations and line breaks.
--$.xgafv <value> V1 error format.
--callback <value> JSONP.
--alt <value> Data format for response.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--use-domain-admin-access <value> Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
--team-drive-id <value> The ID of the Team Drive.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Deprecated: Use drives.update instead. — write (PATCH…

Example: drive personal api drive-teamdrives-update --team-drive-id <value>

drive api driveactivity-activity-query

Query past activity in Google Drive. — read (POST v2/activity:query)

drive <profile> api driveactivity-activity-query [options]
Option What it does
--alt <value> Data format for response.
--callback <value> JSONP.
--$.xgafv <value> V1 error format.
--pretty-print <value> Returns response with indentations and line breaks.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--fields <value> Selector specifying which fields to include in a partial response.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Query past activity in Google Drive. — read (POST v2/activity:query)

Example: drive personal api driveactivity-activity-query

drive api sheets-spreadsheets-batch-update

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. — write (POST v4/spreadsheets/{spreadsheetId}:batchUpdate)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-batch-update [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The spreadsheet to apply the updates to.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Applies one or more updates to the spreadsheet. Each request is validated…

Example: drive personal api sheets-spreadsheets-batch-update --spreadsheet-id <value>

drive api sheets-spreadsheets-create

Creates a spreadsheet, returning the newly created spreadsheet. — write (POST v4/spreadsheets)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-create [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Creates a spreadsheet, returning the newly created spreadsheet. — write…

Example: drive personal api sheets-spreadsheets-create

drive api sheets-spreadsheets-developer-metadata-get

Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see Read, write, and search metadata. — read (GET v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId})

drive <profile> api sheets-spreadsheets-developer-metadata-get [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--metadata-id <value> The ID of the developer metadata to retrieve.
--spreadsheet-id <value> The ID of the spreadsheet to retrieve metadata from.

Returns: Returns the developer metadata with the specified ID. The caller must…

Example: drive personal api sheets-spreadsheets-developer-metadata-get --metadata-id <value> --spreadsheet-id <value>

drive api sheets-spreadsheets-developer-metadata-search

Returns all developer metadata matching the specified DataFilter. For more information, see Read, write, and search metadata. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region. — read (POST v4/spreadsheets/{spreadsheetId}/developerMetadata:search)

drive <profile> api sheets-spreadsheets-developer-metadata-search [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to retrieve metadata from.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Returns all developer metadata matching the specified DataFilter. For more…

Example: drive personal api sheets-spreadsheets-developer-metadata-search --spreadsheet-id <value>

drive api sheets-spreadsheets-get

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using the fields URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using A1 notation. You can define a single cell (for example, A1) or multiple cells (for example, A1:D5). You can also get cells from other sheets within the same spreadsheet (for example, Sheet2!A1:C4) or retrieve multiple ranges at once (for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. — read (GET v4/spreadsheets/{spreadsheetId})

drive <profile> api sheets-spreadsheets-get [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--comments-view-mode <value> The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.
--spreadsheet-id <value> The spreadsheet to request.
--exclude-tables-in-banded-ranges <value> True if tables should be excluded in the banded ranges. False if not set.
--ranges <value> The ranges to retrieve from the spreadsheet.
--include-grid-data <value> True if grid data should be returned. This parameter is ignored if a field mask was set in the request.

Returns: Returns the spreadsheet at the given ID. The caller must specify the…

Example: drive personal api sheets-spreadsheets-get --spreadsheet-id <value>

drive api sheets-spreadsheets-get-by-data-filter

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see Read, write, and search metadata. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a field mask listing your desired fields using the fields URL parameter in HTTP. * Set the includeGridData parameter to true. If a field mask is set, the includeGridData parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. — read (POST v4/spreadsheets/{spreadsheetId}:getByDataFilter)

drive <profile> api sheets-spreadsheets-get-by-data-filter [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The spreadsheet to request.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Returns the spreadsheet at the given ID. The caller must specify the…

Example: drive personal api sheets-spreadsheets-get-by-data-filter --spreadsheet-id <value>

drive api sheets-spreadsheets-sheets-copy-to

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. — write (POST v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-sheets-copy-to [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--sheet-id <value> The ID of the sheet to copy.
--spreadsheet-id <value> The ID of the spreadsheet containing the sheet to copy.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Copies a single sheet from a spreadsheet to another spreadsheet. Returns the…

Example: drive personal api sheets-spreadsheets-sheets-copy-to --sheet-id <value> --spreadsheet-id <value>

drive api sheets-spreadsheets-values-append

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The valueInputOption only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. — write (POST v4/spreadsheets/{spreadsheetId}/values/{range}:append)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-append [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--insert-data-option <value> How the input data should be inserted.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--response-value-render-option <value> Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
--value-input-option <value> How the input data should be interpreted.
--response-date-time-render-option <value> Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
--range <value> The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
--include-values-in-response <value> Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Appends values to a spreadsheet. The input range is used to search for…

Example: drive personal api sheets-spreadsheets-values-append --spreadsheet-id <value> --range <value>

drive api sheets-spreadsheets-values-batch-clear

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept. — write (POST v4/spreadsheets/{spreadsheetId}/values:batchClear)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-batch-clear [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Clears one or more ranges of values from a spreadsheet. The caller must…

Example: drive personal api sheets-spreadsheets-values-batch-clear --spreadsheet-id <value>

drive api sheets-spreadsheets-values-batch-clear-by-data-filter

Clears one or more ranges of values from a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept. — write (POST v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-batch-clear-by-data-filter [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Clears one or more ranges of values from a spreadsheet. For more…

Example: drive personal api sheets-spreadsheets-values-batch-clear-by-data-filter --spreadsheet-id <value>

drive api sheets-spreadsheets-values-batch-get

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. — read (GET v4/spreadsheets/{spreadsheetId}/values:batchGet)

drive <profile> api sheets-spreadsheets-values-batch-get [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--value-render-option <value> How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
--spreadsheet-id <value> The ID of the spreadsheet to retrieve data from.
--date-time-render-option <value> How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
--major-dimension <value> The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting ranges=["A1:B2"],majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting ranges=["A1:B2"],majorDimension=COLUMNS returns [[1,3],[2,4]].
--ranges <value> The A1 notation or R1C1 notation of the range to retrieve values from.

Returns: Returns one or more ranges of values from a spreadsheet. The caller must…

Example: drive personal api sheets-spreadsheets-values-batch-get --spreadsheet-id <value>

drive api sheets-spreadsheets-values-batch-get-by-data-filter

Returns one or more ranges of values that match the specified data filters. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. — read (POST v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter)

drive <profile> api sheets-spreadsheets-values-batch-get-by-data-filter [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to retrieve data from.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Returns one or more ranges of values that match the specified data filters.…

Example: drive personal api sheets-spreadsheets-values-batch-get-by-data-filter --spreadsheet-id <value>

drive api sheets-spreadsheets-values-batch-update

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. — write (POST v4/spreadsheets/{spreadsheetId}/values:batchUpdate)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-batch-update [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Sets values in one or more ranges of a spreadsheet. The caller must specify…

Example: drive personal api sheets-spreadsheets-values-batch-update --spreadsheet-id <value>

drive api sheets-spreadsheets-values-batch-update-by-data-filter

Sets values in one or more ranges of a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. — write (POST v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-batch-update-by-data-filter [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Sets values in one or more ranges of a spreadsheet. For more information,…

Example: drive personal api sheets-spreadsheets-values-batch-update-by-data-filter --spreadsheet-id <value>

drive api sheets-spreadsheets-values-clear

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. — write (POST v4/spreadsheets/{spreadsheetId}/values/{range}:clear)

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-clear [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--range <value> The A1 notation or R1C1 notation of the values to clear.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Clears values from a spreadsheet. The caller must specify the spreadsheet ID…

Example: drive personal api sheets-spreadsheets-values-clear --spreadsheet-id <value> --range <value>

drive api sheets-spreadsheets-values-get

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. — read (GET v4/spreadsheets/{spreadsheetId}/values/{range})

drive <profile> api sheets-spreadsheets-values-get [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--range <value> The A1 notation or R1C1 notation of the range to retrieve values from.
--major-dimension <value> The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: A1=1,B1=2,A2=3,B2=4, then requesting range=Sheet1!A1:B2?majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting range=Sheet1!A1:B2?majorDimension=COLUMNS returns [[1,3],[2,4]].
--value-render-option <value> How values should be represented in the output. The default render option is FORMATTED_VALUE.
--date-time-render-option <value> How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
--spreadsheet-id <value> The ID of the spreadsheet to retrieve data from.

Returns: Returns a range of values from a spreadsheet. The caller must specify the…

Example: drive personal api sheets-spreadsheets-values-get --range <value> --spreadsheet-id <value>

drive api sheets-spreadsheets-values-update

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. — write (PUT v4/spreadsheets/{spreadsheetId}/values/{range})

This command can change Google data or send data to the configured model.

drive <profile> api sheets-spreadsheets-values-update [options]
Option What it does
--$.xgafv <value> V1 error format.
--alt <value> Data format for response.
--fields <value> Selector specifying which fields to include in a partial response.
--callback <value> JSONP.
--quota-user <value> Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
--pretty-print <value> Returns response with indentations and line breaks.
--value-input-option <value> How the input data should be interpreted.
--include-values-in-response <value> Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
--response-date-time-render-option <value> Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
--spreadsheet-id <value> The ID of the spreadsheet to update.
--range <value> The A1 notation of the values to update.
--response-value-render-option <value> Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
--body <json> the request body as JSON; - reads it from stdin.
--body-file <path> the request body from a JSON file; - is stdin.

Returns: Sets values in a range of a spreadsheet. The caller must specify the…

Example: drive personal api sheets-spreadsheets-values-update --spreadsheet-id <value> --range <value>

drive sheets

read spreadsheet tabs and ranges, or change cells live in Google Sheets

drive sheets create

create an empty tab inside an existing spreadsheet

This command can change Google data or send data to the configured model.

drive <profile> sheets create <spreadsheet> <title>
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
title required name of the new tab.

Returns: create an empty tab inside an existing spreadsheet

Example: drive personal sheets create SHEET_ID "Quarter 2"

drive sheets rename

rename one tab while preserving its ID and other properties

This command can change Google data or send data to the configured model.

drive <profile> sheets rename <spreadsheet> <sheet-id> <title>
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
sheet-id required numeric tab ID from sheets info.
title required new tab name.

Returns: rename one tab while preserving its ID and other properties

Example: drive personal sheets rename SHEET_ID 0 "Quarter 2"

drive sheets insert

insert bounded rows or columns before a zero-based index

This command can change Google data or send data to the configured model.

drive <profile> sheets insert <spreadsheet> <sheet-id> <axis> <index> <count>
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
sheet-id required numeric tab ID from sheets info.
axis required rows or columns.
index required zero-based index to insert before.
count required number to insert, from 1 to 1000.

Returns: insert bounded rows or columns before a zero-based index

Example: drive personal sheets insert SHEET_ID 0 rows 1 3

drive sheets format

change only supplied formatting fields in at most 10000 cells

This command can change Google data or send data to the configured model.

drive <profile> sheets format <spreadsheet> <sheet-id> <range> [options]
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
sheet-id required numeric tab ID from sheets info.
range required finite cells within that tab, such as A1:C4; no tab prefix.
Option What it does
--body <json> supported CellFormat fields as JSON; values and formulas are refused.

Returns: change only supplied formatting fields in at most 10000 cells

Example: drive personal sheets format SHEET_ID 0 A1:C1 --body '{"textFormat":{"bold":true}}'

drive sheets info

list spreadsheet properties and tabs without downloading grid data

drive <profile> sheets info <spreadsheet>
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.

Returns: list spreadsheet properties and tabs without downloading grid data

Example: drive personal sheets info SHEET_ID

drive sheets show

read a live A1 range; choose formatted values, raw values or formulas

drive <profile> sheets show <spreadsheet> <range> [options]
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
range required A1 range, such as Budget!A1:C4.
Option What it does
--render <mode> how Google renders cell values. One of: formatted, unformatted, formula. Default: formatted.

Returns: read a live A1 range; choose formatted values, raw values or formulas

Example: drive personal sheets show SHEET_ID 'Budget!A1:C4', drive personal sheets show SHEET_ID 'Budget!C1:C4' --render formula

drive sheets update

set cells within a finite A1 rectangle; literal values by default

This command can change Google data or send data to the configured model.

drive <profile> sheets update <spreadsheet> <range> [options]
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
range required tab and finite A1 rectangle, such as Budget!A1:C4.
Option What it does
--values <json> JSON rows; null skips a cell and an empty string clears its value.
--input <mode> raw literals, or user-entered formulas/numbers using spreadsheet locale. One of: raw, user-entered. Default: raw.

Returns: set cells within a finite A1 rectangle; literal values by default

Example: drive personal sheets update SHEET_ID 'Budget!A1:B2' --values '[["Item",10]]'

drive sheets add

append rows after Google's detected table within a finite A1 range

This command can change Google data or send data to the configured model.

drive <profile> sheets add <spreadsheet> <range> [options]
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
range required tab and finite A1 rectangle, such as Budget!A1:C4.
Option What it does
--values <json> JSON rows; null skips a cell and an empty string clears its value.
--input <mode> raw literals, or user-entered formulas/numbers using spreadsheet locale. One of: raw, user-entered. Default: raw.

Returns: append rows after Google's detected table within a finite A1 range

Example: drive personal sheets add SHEET_ID 'Budget!A1:B2' --values '[["Item",10]]'

drive sheets clear

clear cell values in a finite A1 rectangle; formatting remains

This command can change Google data or send data to the configured model.

drive <profile> sheets clear <spreadsheet> <range>
Argument What it is
spreadsheet required spreadsheet ID or Google Sheets URL.
range required tab and finite A1 rectangle, such as Budget!A1:C4.

Returns: clear cell values in a finite A1 rectangle; formatting remains

Example: drive personal sheets clear SHEET_ID 'Budget!A2:C4'

drive files

read and change files in Google Drive; nothing is imported

drive files download

download a stored file to a local file

This command changes local state.

drive <profile> files download <file> [options]
Argument What it is
file required file id or Google Drive URL.
Option What it does
--output <file> local file to write.
--overwrite replace an existing output file.

Returns: download a stored file to a local file

Example: drive personal files download FILE_ID --output download.bin

drive files export

export a Google document to a local file

This command changes local state.

drive <profile> files export <file> [options]
Argument What it is
file required file id or Google Drive URL.
Option What it does
--output <file> local file to write.
--overwrite replace an existing output file.
--format <format> format Google should export. One of: pdf, docx, xlsx, csv.

Returns: export a Google document to a local file

Example: drive personal files export DOC_ID --format pdf --output document.pdf

drive files list

list files in Google Drive, one page at a time

drive <profile> files list [query] [options]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.
--parent <id> only the files directly inside this folder id.
--timezone <zone> zone for query dates without an offset.

Returns: drive remote file — id, name, trashed, modified_time, created_time, viewed_by_me_time; every field: drive commands info files list

Example: drive personal files list --parent FOLDER_ID, drive personal files list 'name:"Example plan"' --limit 20

drive files get

show one file's Google Drive metadata

drive <profile> files get <file>
Argument What it is
file required file id or Google Drive URL.

Returns: show one file's Google Drive metadata

Example: drive personal files get FILE_ID

drive files copy

copy a file in Google Drive

This command can change Google data or send data to the configured model.

drive <profile> files copy <file> [options]
Argument What it is
file required file id or Google Drive URL.
Option What it does
--name <name> name of the copy; Google's default when omitted.
--parent <id> folder id to put the copy in.

Returns: copy a file in Google Drive

Example: drive personal files copy FILE_ID --name "Plan copy" --parent FOLDER_ID

drive files move

move a file to another Google Drive folder

This command can change Google data or send data to the configured model.

drive <profile> files move <file> [options]
Argument What it is
file required file id or Google Drive URL.
Option What it does
--parent <id> folder id to move the file into.
--old-parent <id> folder id to take the file out of.

Returns: move a file to another Google Drive folder

Example: drive personal files move FILE_ID --parent NEW_FOLDER_ID --old-parent OLD_FOLDER_ID

drive files update

change a file's Google Drive metadata

This command can change Google data or send data to the configured model.

drive <profile> files update <file> [options]
Argument What it is
file required file id or Google Drive URL.
Option What it does
--body <json> the metadata fields to change, as a JSON object.

Returns: change a file's Google Drive metadata

Example: drive personal files update FILE_ID --body '{"name":"Renamed"}'

drive files trash

move a file to the Google Drive trash

This command can change Google data or send data to the configured model.

drive <profile> files trash <file>
Argument What it is
file required file id or Google Drive URL.

Returns: move a file to the Google Drive trash

Example: drive personal files trash FILE_ID

drive files restore

take a file out of the trash

This command can change Google data or send data to the configured model.

drive <profile> files restore <file>
Argument What it is
file required file id or Google Drive URL.

Returns: take a file out of the trash

Example: drive personal files restore FILE_ID

drive files mkdir

create an empty folder in Google Drive

This command can change Google data or send data to the configured model.

drive <profile> files mkdir <name> [options]
Argument What it is
name required folder name.
Option What it does
--parent <id> folder id to create it in; My Drive when omitted.

Returns: create an empty folder in Google Drive

Example: drive personal files mkdir Reports --parent FOLDER_ID

drive files upload

upload a local file to Google Drive; an interrupted upload resumes

This command can change Google data or send data to the configured model.

drive <profile> files upload <path> [options]
Argument What it is
path required local file to upload.
Option What it does
--parent <id> folder id to put it in; My Drive when omitted.
--name <name> name in Google Drive; the local file name when omitted.

Returns: upload a local file to Google Drive; an interrupted upload resumes

Example: drive personal files upload ./backup.db.zst --parent FOLDER_ID

drive comments

read the comments of a file in Google Drive

drive comments reply

reply to a Google Drive comment

This command can change Google data or send data to the configured model.

drive <profile> comments reply <file> <comment-id> <text>
Argument What it is
file required file id or Google Drive URL.
comment-id required comment id from comments list.
text required reply text.

Returns: reply to a Google Drive comment

Example: drive personal comments reply FILE_ID COMMENT_ID "Reply text"

drive comments resolve

resolve a Google Drive comment

This command can change Google data or send data to the configured model.

drive <profile> comments resolve <file> <comment-id>
Argument What it is
file required file id or Google Drive URL.
comment-id required comment id from comments list.

Returns: resolve a Google Drive comment

Example: drive personal comments resolve FILE_ID COMMENT_ID

drive comments reopen

reopen a Google Drive comment

This command can change Google data or send data to the configured model.

drive <profile> comments reopen <file> <comment-id>
Argument What it is
file required file id or Google Drive URL.
comment-id required comment id from comments list.

Returns: reopen a Google Drive comment

Example: drive personal comments reopen FILE_ID COMMENT_ID

drive comments list

list a file's comments

drive <profile> comments list <file> [query] [options]
Argument What it is
file required file id or Google Drive URL.
query optional field:value terms; this list filters by none yet.
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.

Returns: drive remote comment — id; every field: drive commands info comments list

Example: drive personal comments list FILE_ID

drive comments get

show one comment of a file

drive <profile> comments get <file> <comment-id>
Argument What it is
file required file id or Google Drive URL.
comment-id required comment id, as comments list prints it.

Returns: show one comment of a file

Example: drive personal comments get FILE_ID COMMENT_ID

drive permissions

read the permissions of a file in Google Drive

drive permissions list

list a file's permissions

drive <profile> permissions list <file> [query] [options]
Argument What it is
file required file id or Google Drive URL.
query optional field:value terms; this list filters by none yet.
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.

Returns: drive remote permission — id; every field: drive commands info permissions list

Example: drive personal permissions list FILE_ID

drive permissions get

show one permission of a file

drive <profile> permissions get <file> <permission-id>
Argument What it is
file required file id or Google Drive URL.
permission-id required permission id, as permissions list prints it.

Returns: show one permission of a file

Example: drive personal permissions get FILE_ID PERMISSION_ID

drive revisions

read the revisions of a file in Google Drive

drive revisions list

list a file's revisions

drive <profile> revisions list <file> [query] [options]
Argument What it is
file required file id or Google Drive URL.
query optional field:value terms; this list filters by none yet.
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.

Returns: drive remote revision — id; every field: drive commands info revisions list

Example: drive personal revisions list FILE_ID

drive revisions get

show one revision of a file

drive <profile> revisions get <file> <revision-id>
Argument What it is
file required file id or Google Drive URL.
revision-id required revision id, as revisions list prints it.

Returns: show one revision of a file

Example: drive personal revisions get FILE_ID REVISION_ID

drive shared-drives

list the shared drives this account can open

drive <profile> shared-drives [options]
Option What it does
--limit <n> how many items one page holds. Default: 100.
--cursor <cursor> continue from page.next_cursor of the previous answer.

Returns: list the shared drives this account can open

Example: drive personal shared-drives

drive mirrors

keep local folders mirrored into Google Docs and Sheets

drive mirrors add

mirror a local folder: Markdown to Google Docs, CSV/TSV/XLSX to Sheets

This command changes local state.

drive <profile> mirrors add <path> [options]
Argument What it is
path required local folder to mirror.
Option What it does
--parent <id> the Google Drive folder to write into, by id or URL.

Returns: mirror a local folder: Markdown to Google Docs, CSV/TSV/XLSX to Sheets

Example: drive personal mirrors add ./notes --parent FOLDER_ID

drive mirrors list

list this profile's mirrors

drive <profile> mirrors list [query]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.

Returns: drive mirror — id, path, folder; every field: drive commands info mirrors list

Example: drive personal mirrors list

drive mirrors remove

stop mirroring a folder; nothing in Google Drive is changed or deleted

This command changes local state.

drive <profile> mirrors remove <id>
Argument What it is
id required mirror id from mirrors list.

Returns: stop mirroring a folder; nothing in Google Drive is changed or deleted

Example: drive personal mirrors remove 1a2b3c4d

drive mirrors status

show which local files the next sync would create or send; Google is not asked

drive <profile> mirrors status [id]
Argument What it is
id optional mirror id; every mirror of the profile when omitted.

Returns: show which local files the next sync would create or send; Google is not asked

Example: drive personal mirrors status

drive mirrors sync

sync both ways with Docs and Sheets; a part changed on both sides is reported

This command can change Google data or send data to the configured model.

drive <profile> mirrors sync [id] [options]
Argument What it is
id optional mirror id; every mirror of the profile when omitted.
Option What it does
--keep <side> where a part changed on both sides, keep this side. One of: local, google, both.
--replace same as --keep local, and create again files deleted in Google.

Returns: sync both ways with Docs and Sheets; a part changed on both sides is reported

Example: drive personal mirrors sync, drive personal mirrors sync 1a2b3c4d --keep google, drive personal mirrors sync 1a2b3c4d --replace

drive mirrors watch

keep syncing both ways until Ctrl-C or --timeout: on each local save and each Google change; a part changed on both sides is reported and left for mirrors sync --keep

This command can change Google data or send data to the configured model.

drive <profile> mirrors watch [id] [options]
Argument What it is
id optional mirror id; every mirror of the profile when omitted.
Option What it does
--every <duration> how often to ask Google for changes. Default: 60s.

Returns: keep syncing both ways until Ctrl-C or --timeout

Example: drive personal mirrors watch, drive personal mirrors watch 1a2b3c4d --every 2m --jsonl

drive config

read and change settings; credentials are kept apart

drive config show

show the defaults and every profile's settings

drive config show

Returns: show the defaults and every profile's settings

Example: drive config show

drive config set

set one setting of this profile, or of the defaults

This command changes local state.

drive <profile> config set <key> <json-value> [options]
Argument What it is
key required max_text_chars, picture_search, record, record_input, keep_runs_for_days, keep_successful_runs_for_days, runs_size_limit_mb, shared AI settings, permissions. or models...
json-value required the new value, as JSON.
Option What it does
--defaults change the defaults instead of this profile.

Returns: set one setting of this profile, or of the defaults

Example: drive personal config set max_text_chars 100000, drive personal config set permissions.files '"readonly"' --defaults, drive personal config set record true --defaults

drive config unset

remove one setting from this profile, the defaults or the top of the file

This command changes local state.

drive <profile> config unset <key> [options]
Argument What it is
key required the setting, permissions. or models..; any key, known or not.
Option What it does
--defaults change the defaults instead of this profile.

Returns: remove one setting from this profile, the defaults or the top of the file

Example: drive personal config unset max_text_chars, drive personal config unset permissions.files --defaults

drive complete

print a shell completion script, or complete words

drive complete [words]
Argument What it is
words optional a shell name, or after -- the words typed so far.

Returns: print a shell completion script, or complete words

Example: drive complete zsh

drive models

choose the memory model and download the search model

drive models set

set the provider and model for one use

This command changes local state.

drive <profile> models set [options]
Option What it does
--purpose <purpose> what the model is used for. Default: memories.
--provider <provider> who runs the model, or off to use none. One of: openai, anthropic, off.
--model <model> model id at the provider.
--base-url <url> HTTP or HTTPS address of the model API, without credentials in it.

Returns: set the provider and model for one use

Example: drive personal models set --provider openai --model MODEL_ID, drive personal models set --provider off

drive models list

speech and embedding models, their download status and the default of each kind

drive models list [query]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.

Returns: model — id, kind, title, languages, size_bytes, downloaded, default, path, and 1 more; every field: drive commands info models list

Next usually: drive models download <model>, drive images models download <model>

Example: drive models list, drive models list kind:text

drive models download

download and verify one speech or embedding model

This command changes local state.

drive models download <model> [options]
Argument What it is
model required a model id from models list.
Option What it does
--offline refuse a download that needs the network.
--accept-terms accept the model's licence terms, for a model that has its own.

Returns: model — id, kind, title, languages, size_bytes, downloaded, default, path, and 1 more; every field: drive commands info models download

Next usually: drive images models download <model>

Example: drive models download e5-small

drive images

the local model that picture search uses

drive images models

models that read pictures, for picture search

drive images models download

download a picture model once into the folder every WireCat CLI shares

This command changes local state.

drive images models download <model>
Argument What it is
model required model id, such as clip-b32.

Returns: model — id, kind, title, languages, size_bytes, downloaded, default, path, and 1 more; every field: drive commands info images models download

Next usually: drive models download <model>

Example: drive images models download clip-b32

drive commands

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

drive commands info

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

drive commands info [path]
Argument What it is
path optional one command path; without one, schemas, error reasons and explicit overrides.

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

Example: drive commands info --json

drive upgrade

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

This command changes local state.

drive upgrade [options]
Option What it does
--check say whether a newer version exists, and install nothing.

Returns: upgrade drive with the package manager that installed it; --check only looks

Example: drive upgrade --check

drive runs

recorded runs — what this tool did, and when

drive runs list

recorded runs, newest first

drive runs list [query] [options]
Argument What it is
query optional field:value terms that narrow the list — the fields are below.
Option What it does
--limit <n> how many to show. Default: 20.
--page <n> which page, starting at 1. Default: 1.

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

Example: drive runs list --limit 10

drive runs show

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

drive runs show <run-id> [options]
Argument What it is
run-id required an id from drive runs list.
Option What it does
--problems only 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: drive commands info runs show

Example: drive runs show run-101

drive runs path

the directory holding one run

drive runs path <run-id>
Argument What it is
run-id required an id from drive runs list.

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

Example: drive runs path run-101

drive guide

scenarios: the commands for a common task, in order, and why each

drive guide [name]
Argument What it is
name optional one scenario; without it, the list.

Returns: scenarios: the commands for a common task, in order, and why each

Example: drive guide, drive guide agent-access --json

Exit codes

Failures use the shared WireCat error contract.

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

Clone this wiki locally