mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
zhengzhijiej-tech
e79d49e7e4
* feat(sheets): support font_family in cell styles (#1549) Add a font_family field to cell_styles so a cell's font name can be set and read back through every style entry point: - +cells-set (--cells JSON) and +cells-set-style / +cells-batch-set-style gain a font_family field / --font-family flat flag - +workbook-create / +table-put --styles accept font_family in cell_styles - +cells-get returns font_family helpers.go buildCellStyleFromFlags reads the --font-family flag; lark_sheet_workbook.go allows font_family in the --styles cell_styles whitelist; data/ + skills/ are synced from sheet-skill-spec. * docs(sheets): inline editing rules into SKILL.md and clarify flag descriptions - Move cross-cutting editing rules and execution notes into the root SKILL.md and drop the now-redundant core-operations reference - Clarify flag descriptions: offset must be explicit inside +batch-update, range prefixes written bare (no quotes), chart requires a dim index, untyped --values lose date/number types, ungroup level semantics - Sync the corresponding reference docs * feat(sheets): add --type bitable to +sheet-create for creating bitable sub-sheets (#1520) * perf(sheets): cap fan-out cell-matrix materialization to prevent OOM (#1578) * perf(sheets): cap fan-out cell-matrix materialization to prevent OOM The +cells-set-style / +dropdown-set / +cells-batch-set-style / +dropdown-update shortcuts expand a single A1 range into a rows×cols matrix of per-cell maps client-side (the backing set_cell_range tool takes an explicit cells matrix). rangeDimensions() had no upper bound, so a tiny input like "A1:Z100000" balloons into ~2.6M heap maps (~900MB, doubled again by json.Marshal) and can OOM the process before the request is even sent. Add a 50000-cell safety cap (checkStampMatrixBudget) gating every fan-out materialization point, matching the documented but never-wired --max-cells default. Oversized ranges now fail fast with a clear validation error instead of allocating. Also preallocate the per-op slices now that the range count is known up front. Adds benchmarks + a boundary test as regression guards. * perf(sheets): cap table-put/batch fan-out materialization (siblings of the cell-matrix cap) The single-range fan-out cap (maxStampMatrixCells) left three sibling ingress paths uncapped, each able to materialize an unbounded matrix or op set in memory before the request leaves: - +table-put / +workbook-create --sheets/--values: buildSheetMatrix builds the whole rows×cols matrix before slicing it into per-write batches; tablePutMaxCellsPerWrite only bounds the batch size, not the total input. Add tablePayload.checkCellBudget (1M-cell guardrail), enforced in validate() and in buildValuesPayload (the --values path bypasses validate()). - batch fan-out (+cells-batch-set-style / +dropdown-update): per-range checkStampMatrixBudget can't stop many ranges from summing past the cap. Add an aggregate cell budget (checkBatchStampBudget) and a shared maxBatchRanges (100) count cap in validateDropdownRanges — covering all fan-out commands and replacing the now-redundant +dropdown-delete count check. - +batch-update: cap --operations at maxBatchOperations (100) in translateBatchOperations. Adds boundary regression tests for each cap. go vet + gofmt clean; full shortcuts/sheets + backward suites green. * test(sheets): measure table-put matrix materialization cost Add BenchmarkBuildSheetMatrix_* and TestTablePutMatrixPeakMemory mirroring the fan-out probes. Confirms the +table-put/+workbook-create ingress has the same OOM profile as the single-range stamp: 2.6M cells → ~917 MB / 5.3M allocs (+875 MB resident heap) materialized before the first write — now rejected up front by checkCellBudget. * feat(pivot): lark-sheets pivot reference 补 +pivot-list info 说明与落点覆盖校验 +pivot-list 返回 info（page_range/content_range/error_state 等）： 1) 判断目标单元格在透视表内(改配置 +pivot-update)还是区域外(改值 +cells-set)； 2) 透视表展开后会覆盖已有数据，落点强烈优先默认自动新建子表； 3) 创建后用 info.error_state / content_range 校验有没有覆盖/冲突。 * feat(sheets): add +formula-verify shortcut for verify_formula tool Wraps the new verify_formula read tool in a CLI shortcut so AI agents can run write-then-zero-error verification end-to-end: lark-cli sheets +formula-verify --url <url> Scans formulas + cell error states across one or more sub-sheets and returns a JSON status report (success / errors_found / partial). Aggregates all 7 Excel error categories (#REF! / #DIV/0! / #VALUE! / #NAME? / #NULL! / #NUM! / #N/A) plus compile failures into one envelope; the tool always reports every error in the scan window — callers needing a subset filter the returned error_summary client-side. The internal scan cap is hidden from callers; when it trips the response sets has_more=true and includes a warning_message asking the caller to narrow --range / split --sheet-id and continue. Flags follow the lark-sheets convention: - --url / --spreadsheet-token (XOR public) - --sheet-id / --sheet-name (repeat or comma-separate; mutually exclusive) - --range (repeatable A1) - --max-locations (default 20) - --exit-on-error (CI gate: status='errors_found' → exit 2 with failed_precondition) Generated artifacts (skills/lark-sheets/{SKILL.md, references/ lark-sheets-formula-verify.md}, shortcuts/sheets/data/flag-defs.json, shortcuts/sheets/flag_defs_gen.go) are mirrored from sheet-skill-spec generated/ via 'npm run sync:cli'. shortcuts.go registers FormulaVerify alongside the other lark_sheet_formula_verify skill shortcuts so +formula-verify is discoverable from 'lark-cli sheets --help'. Tests cover the dry-run wire shape (excel_id + sheet_ids/sheet_names/ ranges/max_locations packing), the read scope (invoke_read URL), the mutually-exclusive selector validation, the non-positive --max-locations guard, and the --exit-on-error status matrix (success/partial/errors_found/unknown). * feat(sheets): add +history-list / +history-revert / +history-revert-status shortcuts BE-1 + BE-2 (larksuite/cli lark-sheets) for spec sheet-history-revert. Three thin callTool wrappers over facade-agg history tools, following the existing sheets Validate/DryRun/Execute + --url/--spreadsheet-token(/--token) locator convention: - +history-list (read, history_list): passes the tool output through verbatim; facade-agg already does the minor_histories/4-field/RFC3339 transform. - +history-revert (write, history_revert): --history-version-id required, enforced at Validate stage with a typed *errs.ValidationError (no request on missing); returns the async receipt. - +history-revert-status (read, history_revert_status): polls in-progress / success / failure. Flags declared inline (not via *_gen.go) — flag_defs_gen.go / data/flag-defs.json are synced from sheet-skill-spec (BE-3) and must not be hand-edited. Notes: - history_revert / history_revert_status depend on facade-agg's downstream RPC wiring, a DEFERRED follow-up; the tools return a "not wired yet" guard today. These CLI wrappers are correct and go live when the backend follow-up lands. +history-list is fully functional now. - TestFlagDefsGen_MatchesJSON fails on baseline (pre-existing BE-3 gen/json drift); resolves once BE-3 sync:cli regenerates flag defs for these shortcuts. Validation: go build ./shortcuts/sheets/... PASS; new tests (TestHistoryShortcuts_DryRun, TestHistoryRevert_MissingVersionID) PASS. Spec source: active@2acd94a24ac3f835357a274a02344f78435bcc1c39ad0d695ce587f0cbddfb21 * chore(sheets): sync lark_sheet_history skill + flag defs from sheet-skill-spec (BE-3) Synced artifacts for the history shortcuts from ee/sheet-skill-spec (SSOT), landed surgically (history-only) to avoid regressing this branch's newer skills/lark-sheets content: - skills/lark-sheets/references/lark-sheets-history.md (new, mirrored). - skills/lark-sheets/SKILL.md: + Lark Sheet History references-table row only. - shortcuts/sheets/data/flag-defs.json: + 3 history shortcuts (additive; no existing entries touched). - shortcuts/sheets/flag_defs_gen.go: regenerated via go generate ./shortcuts/sheets/... (this also resolves the pre-existing flag-defs/gen drift — TestFlagDefsGen_MatchesJSON now passes). NOT a full mirror: the rest of skills/lark-sheets/ + flag-schemas.json on this branch (feat/lark-sheets-develop) are NEWER than the sheet-skill-spec worktree's canonical (e.g. /wiki/ URL support, schema_version 3). A wholesale sync:cli would have reverted them, so only the history delta is taken here. Full re-sync should happen once sheet-skill-spec canonical is realigned with this branch. Validation: go generate clean; go test ./shortcuts/sheets/ (TestFlagDefsGen_MatchesJSON, TestHistory*) PASS. Spec source: active@2acd94a24ac3f835357a274a02344f78435bcc1c39ad0d695ce587f0cbddfb21 * fix(sheets): +history-revert-status keys on --transaction-id, not version id BE-2 gap surfaced by PPE E2E: +history-revert-status sent history_version_id, but the facade-agg history_revert_status tool keys on transaction_id (the async receipt returned by +history-revert), so it returned "[40400] transaction_id is required". Give the status shortcut its own --transaction-id flag + input (excel_id + transaction_id); revert keeps --history-version-id. Tests updated. * fix(sheets): align history flag-defs with inline shortcuts (green TestFlagsFor) TestFlagsFor_EveryRegisteredCommandHasDefs was RED: generated flag-defs drifted from the hand-written history shortcuts. - +history-revert-status: flag-defs had --history-version-id; the BE-2 fix switched the shortcut to --transaction-id. Updated the entry to transaction-id. - +history-revert / -status --history-version-id were marked required="required", but the inline flags are cobra-optional (requiredness enforced in Validate). Set required="optional" to match. Regenerated flag_defs_gen.go. NOTE: canonical source is sheet-skill-spec (BE-3); apply the same change upstream or the next sync:cli will regress this. * chore(sheets): sync lark-sheets-history reference from spec (BE-2 transaction-id) Mirror the upstream BE-2 fix in canonical-spec/references/lark_sheet_history/ cli-reference.md: +history-revert-status now uses --transaction-id (taken from the async receipt returned by +history-revert), and +history-revert's --history-version-id flips required→optional (Validate enforces requiredness at runtime). This file is the only history-only delta from the upstream sheet-skill-spec sync; the rest of skills/lark-sheets/ stays on the cli's newer baseline (/wiki/ URL support, +cells-set-image / +float-image-create, etc.) to match commit 8ae516db's history-only mirror policy. Spec source companion change: feat/sheet-history-revert in ee/sheet-skill-spec, canonical-spec/{tool-shortcut-map.json,references/ lark_sheet_history/cli-reference.md}. * feat(sheets): +history-list --end-version for backward pagination Spec follow-up sheet-history-revert: thread the history_list pagination contract through the +history-list shortcut. - shortcuts/sheets/lark_sheet_history_list.go: + --end-version (int, optional). Mapped to the tool input's `end_version` only when explicitly set (so the server treats absence as "first page / latest"), via runtime.Changed / runtime.Int (matches the +formula-verify --max-locations precedent). + Tip: pass next_end_version from the response on the next call; capture exits the pagination loop when the server omits the field. - shortcuts/sheets/lark_sheet_history_test.go: + dry-run case asserting --end-version 12345 lands as input.end_version=12345 (post-JSON unmarshal float64). - skills/lark-sheets/references/lark-sheets-history.md: synced from ee/sheet-skill-spec (commit 39c6b61). Adds the "倒序分页" caveat row + --end-version flag + pagination Examples line. Drops the internal MajorHistory.Version implementation detail per spec follow-up. - shortcuts/sheets/data/flag-defs.json: synced from spec (+history-list +--end-version int optional). - shortcuts/sheets/flag_defs_gen.go: regenerated via `go generate ./shortcuts/sheets/...`. Companion changes: - ee/sheet-skill-spec MR !37: spec-tables + tool-schemas pagination contract (commits 09e8604, 39c6b61). - ee/sheet-facade-agg MR !1028: history_list tool plumbs end_version, emits next_end_version + has_more (omitted at earliest page), defaults PageSize=20 to datarpc. Validation: - go build ./shortcuts/sheets/... PASS - go test ./shortcuts/sheets/... PASS (sheets + backward) - TestHistoryShortcuts_DryRun (5 cases incl. new --end-version case): PASS - TestHistoryRevert_MissingRequiredFlag: PASS - TestFlagsFor_EveryRegisteredCommandHasDefs: PASS - TestFlagDefsGen_MatchesJSON: PASS * fix(sheets): make +history-revert --history-version-id cobra-required + revert max-cells default drift Two issues surfaced during MR !37 review: 1) +history-revert --history-version-id requiredness was set as "optional" in the spec table (BE-2 fix dc5fe0ea) so cobra wouldn't block before Validate. Per upstream review the flag should be required-by-cobra so the user gets the standard "required flag(s)" gate immediately and the runtime contract matches the JSON shape. - shortcuts/sheets/lark_sheet_history_revert.go: historyVersionIDFlag now sets Required: true. Validate keeps a trim/empty-string guard so '--history-version-id ""' still fails as a typed *errs.ValidationError (cobra accepts empty strings as "set"). - shortcuts/sheets/data/flag-defs.json: +history-revert --history-version-id required: optional -> required. - shortcuts/sheets/flag_defs_gen.go: regenerated. - shortcuts/sheets/lark_sheet_history_test.go: TestHistoryRevert_MissingRequiredFlag split into per-shortcut subtests; +history-revert asserts cobra's "required flag(s)" contract (raw err — the test rig calls cmd.Execute directly so it doesn't see the cmd dispatcher's typed envelope wrap); +history-revert-status keeps the typed *errs.ValidationError contract (its --transaction-id stays cobra-optional + Validate-enforced). 2) max-cells safety cap was accidentally rewritten from 200000 to 50000 by the last sync from sheet-skill-spec (the spec canonical side fell out of date — fixed separately on the spec MR follow-up). Restore desc: "Safety cap; default 200000" / default: "200000" so +cells-get / +csv-get keep the documented cap. Validation: - go test ./shortcuts/sheets/... PASS - TestHistoryRevert_MissingRequiredFlag (both subtests) PASS - TestHistoryShortcuts_DryRun (incl. +history-list pagination case) PASS - TestFlagsFor_EveryRegisteredCommandHasDefs PASS - TestFlagDefsGen_MatchesJSON PASS * fix(sheets): make +history-revert-status --transaction-id cobra-required (match +history-revert) Companion to commit 6ca35b06: same gating model now applies to both history receipts. - shortcuts/sheets/lark_sheet_history_revert.go: transactionIDFlag.Required=true. Validate keeps a trim/empty-string guard for '--transaction-id ""'. - shortcuts/sheets/data/flag-defs.json: +history-revert-status --transaction-id required: optional -> required (synced from sheet-skill-spec @9ca814d). - shortcuts/sheets/flag_defs_gen.go: regenerated. - shortcuts/sheets/lark_sheet_history_test.go: TestHistoryRevert_MissingRequiredFlag/+history-revert-status moved to the cobra "required flag(s)" text contract (the test rig invokes the shortcut via cmd.Execute, which sees the raw cobra error directly without the dispatcher's typed wrap). Drop now-unused `errors` and `errs` imports. Validation: - go test ./shortcuts/sheets/... PASS (sheets + backward) - TestFlagsFor_EveryRegisteredCommandHasDefs: PASS - TestFlagDefsGen_MatchesJSON: PASS - TestHistoryRevert_MissingRequiredFlag (both subtests): PASS * docs(sheets): sync history skill reference required badges from spec Companion to commit 9fa73312 (transaction-id) and 6ca35b06 (history-version-id): the two flag tables in skills/lark-sheets/references/lark-sheets-history.md still showed 'optional' even though the canonical contract — and shortcuts/sheets/data/ flag-defs.json — already moved to 'required'. The earlier syncs only picked up the data file from spec; the skill markdown drift slipped through. Pull in the spec-side regenerated reference (ee/sheet-skill-spec @9ca814d) so the human-readable doc matches the wire contract. * fix(sheets): lower cells-set --max-cells default to 50000 * docs(sheets): clarify workbook-import over read-then-recreate in skill * docs(sheets): bump lark-sheets skill version to 3.0.1 * docs(sheets): clarify number-vs-text typing and copy-to-range template guidance in references * docs(sheets): type by data nature, add pre-write reference column and chart/cond-format/filter rows - SKILL.md quick-reference: add a "read before acting" column pointing each intent at its reference doc; add chart / cond-format / filter rows. - Reframe number-vs-text decision to follow the data's nature (measure vs identifier), not whether the current task happens to sort/sum; a leaderboard/report "display only" use does not make a percentage text. - write-cells reference: mirror the same rule and the +cells-set fallback for layouts +table-put cannot express. * docs(sheets): tighten number-vs-text guidance and dedupe write-cells reference * Feat/lark sheets develop wzz (#1719) * feat(sheets): add +changeset-get shortcut for changeset review Wrap the get_changeset read tool: fetch the raw changeset (edit actions) between two versions to review whether an AI edit fulfilled the request. --start-revision required, --end-revision optional (defaults to latest), gap capped at 100. Adds flag-defs entry + regenerated gen, the ChangesetGet shortcut + tests, and skill docs. * feat(sheets): add +get-revision shortcut Return a spreadsheet's current document revision without pulling the full sub-sheet listing. +get-revision is a read-only derivative over get_workbook_structure (the lightest read — token only, no range) that projects the response down to the single revision field. Adds flag-defs entries and a unit test for the projection helper. * feat: 同步 spec 修改 * feat(sheets): rename +get-revision to +revision-get * feat: 移除 ppe 环境请求头 --------- Co-authored-by: wenzhuozhen <wenzhuozhen@bytedance.com> * docs(sheets): dedupe +changeset-get flag def and skill reference entry * feat(sheets): accept local_office_ token prefix for image parent_type The synthetic token prefix for imported office spreadsheets is being renamed from fake_office_ to local_office_. Accept either prefix when mapping a spreadsheet token to the drive media parent_type so image uploads keep working across the rename (main package and backward compat copy). * fix(sheets): replace undefined common.FlagErrorf with sheetsValidationForFlag changesetRevisions called common.FlagErrorf, which does not exist, breaking the build. Use sheetsValidationForFlag so the errors carry the offending flag param like the rest of the sheets validation paths. Also reword two doc comments in lark_sheet_history_revert.go that used '' for an empty shell string: gofmt (Go 1.19+) rewrites '' in doc comments to a curly quote, leaving the file permanently unformatted. * fix(sheets): satisfy errs-no-bare-wrap forbidigo and errorlint rules from main main introduced the errs-no-bare-wrap forbidigo rule and errorlint coverage that flag 27 issues in existing sheets code after the merge: - Replace direct *errs.ValidationError type assertions with errors.As in sheetsInputStatError and validateSheetMediaUploadFile so wrapped errors still match (errorlint). - Type the embedded flag-schemas.json parse failure as an InternalError with cause; it reaches the user directly via --print-schema. - Annotate genuine intermediate errors (recursive schema validator, batch sub-op raw type checks, A1 range/position parsers) with //nolint:forbidigo; every caller wraps them into typed flag validation errors. * docs: tighten formula verify workflow guidance * docs: align formula verify refs with file names * feat(sheets): let typed writes style blank cells past the data extent +workbook-create / +table-put apply cell_styles by writing them into the in-memory matrix, whose size was fixed to the data (cols × rows). A style range reaching past that extent was rejected as "outside the write range", so blank cells (reserved regions, decorative headers, empty borders) could not be styled on the typed --sheets path — only the untyped --values path padded for it. Pad the matrix down/right to cover every cell_styles range before applying (empty cells appended for the uncovered positions), mirroring the --values behavior. writeSheetData now derives the written width/range from the padded matrix; both dry-run previews and sheetCreateDims account for the style extent so the physical grid and the plan match Execute. Ranges above/left of the write anchor stay rejected (the matrix only grows down/right). * docs(sheets): warn that +csv-put silently coerces numeric-looking labels Add guidance that +csv-put numericizes date-like/ID-like columns whose values are all digits (12.10 becomes 12.1 losing the trailing zero, 001 becomes 1 losing the leading zero); recommend +table-put with dtypes=object/datetime64 or +cells-set + number_format="@". Also fix the batch-update example to use sheet_name instead of sheet_id. * docs(sheets): steer import-vs-append onto sheet-copy for existing workbooks * docs(sheets): warn that cells-clear --scope all is irreversibly destructive * docs(sheets): sync chart schema and labels guidance (#1716) * chore(sheets): update chart flag schema * docs(sheets): clarify chart labels field is presence-toggle, not value-toggle Synced from sheet-skill-spec. Chart labels (plotArea.plot.labels and per-series labels) are toggled by object existence — passing labels at all turns data labels on, even when value/category/series/percentage are all false (server falls back to showing value). Models repeatedly try `{ value: false, category: false, series: false }` to disable, which silently shows the value fallback. The reference doc now spells out both directions: pass labels to show, omit the whole labels field to hide. Also picks up earlier spec-side drift not yet propagated: - pivot-table reference: +pivot-list info return + overlap validation - flag-defs: cell-matrix fan-out cap default 200000 -> 50000 (#1578) * feat(sheets): drop pre-refactor aliases from `sheets --help` listing The refactored + commands have been the default for over a month. Hide the deprecated pre-refactor aliases from `sheets --help` via a custom cobra usage template that skips the deprecated group. Aliases stay registered and executable: their own `sheets <alias> --help` still shows the (→ +new-command) pointer, unknown-subcommand suggestions still span them, and execution still returns the _notice. * feat(sheets): let +csv-put fall back to piped stdin when --csv is omitted Agents routinely redirect a CSV into stdin but forget the `--csv -`, so `+csv-put ... < data.csv` failed its first try on a missing --csv and cost an extra round-trip (error, then --help, then retry). Relax --csv's cobra required-gate in the shortcut's PostMount and install a PreRunE that defaults an omitted --csv to "-" when stdin is a non-interactive pipe, so the standard stdin-resolution path reads it. The pipe guard keeps an interactive terminal from blocking on stdin, and a genuine miss (no piped data) still surfaces csvPutInput's typed "--csv is required" instead of cobra's bare "required flag(s) ... not set". Scoped entirely to the sheets domain — no changes to the shared runner or the flag schema. * feat(sheets): rework +rows-resize / +cols-resize to --height / --width 从上游 sheet-skill-spec 同步：+cols-resize 用 --width、+rows-resize 用 --height 直接给像素值， --type 变为可选（省略等价于 pixel）。--type standard/auto 走非像素模式，不能与像素 flag 同传； --type pixel 与 --width/--height 共存时视为等价形式。--size 已删除。 * docs(sheets): 更新 lark-sheets skill 版本至 3.0.2 将 SKILL.md 版本号从 3.0.1 升至 3.0.2，同步近期 sheets 命令改动（+rows-resize/+cols-resize 改 --height/--width、 +csv-put 支持 stdin 回退等）后的技能版本。 * feat(sheets): add --widths / --heights map form for per-column/row sizes 从上游 sheet-skill-spec 同步：+cols-resize --widths / +rows-resize --heights 接收 JSON map（键为单行列或闭区间，值为像素或 "standard"/"auto"），CLI 按起始位置排序后 展开为一次原子 batch_update 的多个 resize_range 操作，多列不同宽 / 多行不同高一次 调用完成，不再需要 +batch-update。map 形态与 --range/--width/--height/--type 互斥， 不可作为 +batch-update 子操作嵌入（batch_update 不支持嵌套）。列宽 < 20px 拒绝并提示 Excel 字符单位换算（px ≈ 字符数×8+16）；--print-schema --flag-name widths/heights 可查 schema。 * fix(sheets): sync flag input/enum fixes from sheet-skill-spec 上游修复 spec-table 的 Input/Enum 字符串惯例后重新生成：--widths/--heights 现在带 file/stdin 输入声明，+sheet-create --type 的枚举正确进入 flag defs 与文档。 * feat(sheets): add sheets-scoped flag ergonomics via PostMount Two recovery loops from the edit-eval traces burn agent round-trips: hallucinated flag names (--cols for --range) whose unknown-flag error only points at --help, and enum values imported from CSS/Excel vocabulary ("center" for the vertical alignment Lark spells "middle"). - unknown-flag errors now inline the full valid-flag list (semantic guesses aren't rankable by edit distance; kills the --help round trip) - enum values with an unambiguous canonical form (casing, known alias) are normalized in place and the call proceeds; edit-distance typos stay errors with a did-you-mean hint and are never auto-applied Both ride the existing PostMount composition (same pattern as withTokenAlias), so the common framework is untouched and no other domain's behavior shifts. * feat(sheets): make validation errors prescriptive for hot failure modes Driven by the edit-eval-extra-35Q reports: ~70% of lark-cli sheets errors were missing-required / JSON-shape / wrong-value classes whose messages said what broke but not how to fix it, pushing agents into --help / --print-schema probe loops. - composite JSON shape errors inline a compact skeleton auto-generated from the schema (e.g. --cells -> [[{"value": ...}]]) when the type mismatch is shallow container confusion - +batch-update: missing 'shortcut' shows the entry template; a disallowed shortcut inlines the full allow-list; exceeding the 100-op cap says how many batches to split into; sub-op translator failures append the shortcut's complete input-key contract - +table-put: dtypes/formats keys that miss every column call out the A1-letter habit and inline the declared column names; empty cells in a date-typed column name the three ways out - schema enum errors suggest across casing, vocabulary aliases, and edit distance * fix(common): steer rejected @file paths to stdin instead of cd The absolute-path rejection hint said "cd to the target directory first" - advice the lark-sheets skill explicitly tells agents not to follow (it pollutes the working directory). The stdin-contention hint also demonstrated @file with an absolute path, which would itself be rejected. - @file failures on stdin-capable flags now show the equivalent stdin invocation (--csv - < /tmp/x.csv) - the path error recommends a relative path or stdin, not cd - the stdin-contention example uses a relative @file path Message-text only; no control-flow change for any domain. * chore(sheets): suppress forbidigo on csv-put stdin pipe detection os.Stdin.Stat is intentional here - pipe detection needs the real process fd; IOStreams.In is a plain io.Reader without Stat. Clears the lint failure left by the stdin-fallback commit. * fix(sheets): pass spreadsheet token to changeset tool (#1839) * fix(sheets): hide bitable sheet creation (#1843) * fix(sheets): resolve revision wiki URLs * fix(sheets): reject overlapping resize ranges * fix(sheets): address remaining review feedback * fix(sheets): avoid credential scanner false positive * fix(sheets): import mislabeled .xls workbooks by sniffing content Local .xls files that are actually OOXML (an .xlsx exported or renamed to .xls) failed +workbook-import with a cryptic backend "xml_version_not_support" because the CLI trusted the file name extension. +workbook-import now sniffs the file's leading magic bytes (PK -> xlsx, OLE2 -> xls) and passes the true extension to the drive import core via a new optional ImportParams.FileExtension override, correcting both the file_extension and the staged media file name (the latter avoids the backend's "import file extension not match", code 1069910). A declared Excel file whose bytes match neither container is rejected locally with a prescriptive error instead of the opaque backend failure. The drive import core gains only the neutral FileExtension override (empty = infer from the file name, i.e. unchanged behavior for drive +import); all Excel sniffing/correction policy lives in the sheets shortcut. * fix(ci): keep semantic waiver fixture active * fix(sheets): close remaining safety gaps * fix(sheets): align history shortcuts with generated flags Use generated flag defs for history revert commands, enforce control-character validation, and sync the refreshed lark-sheets references from sheet-skill-spec. * fix(sheets): require confirmation for history revert * fix(sheets): require explicit csv input --------- Co-authored-by: xiongyuanwen-byted <xiongyuanwen@bytedance.com> Co-authored-by: wuyanchun.anunwu <wuyanchun.anunwu@bytedance.com> Co-authored-by: wenzhuozhen <wenzhuozhen@bytedance.com>
5013 lines
136 KiB
JSON
5013 lines
136 KiB
JSON
{
|
||
"+formula-verify": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string_slice",
|
||
"required": "optional",
|
||
"desc": "Sheet reference_id(s); repeat or comma-separate to scan multiple sheets. Omit to scan all visible sheets."
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string_slice",
|
||
"required": "optional",
|
||
"desc": "Sheet name(s); repeat or comma-separate to scan multiple sheets. Omit to scan all visible sheets."
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string_slice",
|
||
"required": "optional",
|
||
"desc": "Optional A1 ranges (e.g. `A1:Z200`); repeat or comma-separate for multiple ranges. Omit to scan each sheet's current_region."
|
||
},
|
||
{
|
||
"name": "max-locations",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Max locations / samples per error type; default 20.",
|
||
"default": "20"
|
||
},
|
||
{
|
||
"name": "exit-on-error",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "When status=errors_found, exit non-zero. Useful for CI gate after batch formula writes."
|
||
}
|
||
]
|
||
},
|
||
"+workbook-info": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+revision-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "title",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "New sheet title"
|
||
},
|
||
{
|
||
"name": "index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Insert position (0-based); appended to the end when omitted",
|
||
"default": "-1"
|
||
},
|
||
{
|
||
"name": "row-count",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Initial row count (default 200, max 50000)",
|
||
"default": "200"
|
||
},
|
||
{
|
||
"name": "col-count",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Initial column count (default 20, max 200)",
|
||
"default": "20"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "New sub-sheet type: sheet (spreadsheet); default sheet.",
|
||
"default": "sheet",
|
||
"enum": [
|
||
"sheet"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm high-risk write (exit code 10 without this flag)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-rename": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "title",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "New title"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-move": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Target position (0-based)"
|
||
},
|
||
{
|
||
"name": "source-index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Source position (0-based); optional for standalone calls — if omitted, the CLI runtime derives it from the current workbook index of `--sheet-id` / `--sheet-name`. Inside `+batch-update` it must be passed explicitly, since batch cannot issue a structure query mid-run to derive it",
|
||
"default": "-1"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-copy": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "title",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Copy title; auto-generated by the server when omitted"
|
||
},
|
||
{
|
||
"name": "index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Insert position for the copy (0-based); appended to the end when omitted",
|
||
"default": "-1"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-hide": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-unhide": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-set-tab-color": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "color",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Hex color like `#FF0000`; pass empty string `\"\"` to clear"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-hide-gridline": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sheet-show-gridline": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+workbook-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "title",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Spreadsheet title"
|
||
},
|
||
{
|
||
"name": "folder-token",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Target folder token; placed at the drive root when omitted"
|
||
},
|
||
{
|
||
"name": "values",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Untyped initial data as one 2D JSON array (`[[\"alice\",95]]`); values are written as-is with their type auto-detected (dates / numbers land as text — use --sheets to preserve types), through the same batched set_cell_range path as --sheets — pair with --styles for number formats, colors, merges, and row/col sizes",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "sheets",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Typed table payload as JSON (same shape as `+table-put`): top-level `{\"sheets\":[...]}`, with each array item a sub-sheet `{name, start_cell?, mode?, header?, allow_overwrite?, columns:[\"colA\",\"colB\",...], data:[[...]], dtypes?:{colA:pandasDtype, ...}, formats?:{colA:numberFormat, ...}}` — `name` and the outer `sheets` envelope are both required. Agents typically use `df_to_sheet(df, name)` from `scripts/sheets_df.py` to pack each DataFrame into one item, then wrap the list in `{\"sheets\":[...]}`. Mutually exclusive with --values. Creates the workbook, then writes typed type-faithful data (dates land as real dates, numbers keep precision).",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "styles",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Initial visual operations as JSON: top-level `{styles:[...]}`. Each item corresponds to one target sheet and must include `name`, plus at least one of `cell_styles` / `row_sizes` / `col_sizes` / `cell_merges`. `cell_styles` entries use +cells-set-style fields with a cell range; row/col sizes use dimension ranges plus type/size; merges use cell ranges plus optional merge_type. With --sheets, styles array length/order/name must match --sheets.sheets. With --values, pass exactly one styles item for the initial sheet (its name is ignored).",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+workbook-export": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "file-extension",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Export file format; `csv` mode requires `--sheet-id`",
|
||
"default": "xlsx",
|
||
"enum": [
|
||
"xlsx",
|
||
"csv"
|
||
]
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Required only in csv mode: which sheet to export as CSV. This is a `+workbook-export`-specific flag, unrelated to the common four-tuple sheet locator (this shortcut does not accept the common sheet locator)"
|
||
},
|
||
{
|
||
"name": "output-path",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Local save path. When omitted, **only the export task is triggered + polled, the file is NOT downloaded** (returns file_token / status so a later step can resume the download). Pass a concrete path (e.g. `./out.xlsx`) or a directory (`.` keeps the server-provided filename) to download. Note: the equivalent `lark-cli drive +export --doc-type sheet` uses three separate flags (`--output-dir` / `--file-name` / `--overwrite`) and defaults to downloading into the current directory; this wrapper collapses them into a single `--output-path` for ergonomics but defaults to no-download — fall back to `drive +export` if the split flag set fits better."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+workbook-import": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "file",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Local file path (.xlsx / .xls / .csv)"
|
||
},
|
||
{
|
||
"name": "folder-token",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Target folder token; imported to the cloud drive root when omitted"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Imported spreadsheet name; defaults to the local file name without its extension"
|
||
}
|
||
]
|
||
},
|
||
"+sheet-info": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "include",
|
||
"kind": "own",
|
||
"type": "string_slice",
|
||
"required": "optional",
|
||
"desc": "Comma-separated structure info categories to return",
|
||
"enum": [
|
||
"merges",
|
||
"row_heights",
|
||
"col_widths",
|
||
"hidden_rows",
|
||
"hidden_cols",
|
||
"groups",
|
||
"frozen"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Limit structure info to this A1 range; whole sheet when omitted"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-insert": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "inherit-style",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Style inheritance for the new row/column: `before` (from preceding) / `after` (from following) / `none` (default)",
|
||
"default": "none",
|
||
"enum": [
|
||
"before",
|
||
"after",
|
||
"none"
|
||
]
|
||
},
|
||
{
|
||
"name": "position",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Insert position (1-based row number like `3` or column letter like `C`); new rows/columns are inserted *before* this position"
|
||
},
|
||
{
|
||
"name": "count",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Number of rows/columns to insert (must be > 0)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Row/column closed range to delete; rows use 1-based numbers like `3:7` or `5` (single row), columns use letters like `C:F` or `C`"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); row/column deletion is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-hide": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Row/column closed range to hide; rows use 1-based numbers like `3:7`, columns use letters like `C:F`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-unhide": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Row/column closed range to unhide; rows use 1-based numbers like `3:7`, columns use letters like `C:F`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-freeze": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dimension",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Dimension (row or column)",
|
||
"enum": [
|
||
"row",
|
||
"column"
|
||
]
|
||
},
|
||
{
|
||
"name": "count",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Freeze the first N rows/columns; pass 0 to unfreeze"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-group": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "depth",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Nesting level for grouping; default 1",
|
||
"default": "1"
|
||
},
|
||
{
|
||
"name": "group-state",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Initial group expand state",
|
||
"default": "expand",
|
||
"enum": [
|
||
"expand",
|
||
"fold"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Row/column closed range to group; rows use 1-based numbers like `3:7`, columns use letters like `C:F`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-ungroup": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "depth",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Group nesting level to ungroup; default 1 (1 = outermost, larger = deeper)",
|
||
"default": "1"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Row/column closed range to ungroup; rows use 1-based numbers like `3:7`, columns use letters like `C:F`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dim-move": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Source row/column closed range to move; rows use 1-based numbers like `3:7`, columns use letters like `C:F`"
|
||
},
|
||
{
|
||
"name": "target",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Destination position (the moved rows/columns are placed *before* this position); rows use 1-based row number like `12`, columns use column letter like `H`. Must match the dimension of --source-range"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "A1 range, e.g. `A1:F10` (no sheet prefix — use `--sheet-id` / `--sheet-name` to select the sheet)"
|
||
},
|
||
{
|
||
"name": "include",
|
||
"kind": "own",
|
||
"type": "string_slice",
|
||
"required": "optional",
|
||
"desc": "Comma-separated info categories to include",
|
||
"enum": [
|
||
"value",
|
||
"formula",
|
||
"style",
|
||
"comment",
|
||
"data_validation"
|
||
]
|
||
},
|
||
{
|
||
"name": "max-chars",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Max output chars per call; default 500000 (safety cap). Large reads are usually better redirected to a file; only lower it (e.g. 25000) when you want results inline without triggering file offload, paging via has_more",
|
||
"default": "500000"
|
||
},
|
||
{
|
||
"name": "skip-hidden",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Skip hidden rows and columns; default `false`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dropdown-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target range in A1 notation, e.g. `A2:A100` (no sheet prefix — use `--sheet-id` / `--sheet-name` to select the sheet)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+csv-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "A1 range, e.g. `A1:F30` (no sheet prefix — use `--sheet-id` / `--sheet-name` to select the sheet)"
|
||
},
|
||
{
|
||
"name": "max-chars",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Max output chars per call; default 500000 (safety cap). Large reads are usually better redirected to a file; only lower it (e.g. 25000) when you want results inline without triggering file offload, paging via has_more",
|
||
"default": "500000"
|
||
},
|
||
{
|
||
"name": "include-row-prefix",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Whether to prefix each row with `[row=N]`; default `true`",
|
||
"default": "true"
|
||
},
|
||
{
|
||
"name": "skip-hidden",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Skip hidden rows and columns; default `false`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Print the request path and parameters without executing"
|
||
}
|
||
]
|
||
},
|
||
"+table-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Read only this sheet (by id); omit to read all sheets"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Read only this sheet (by name); omit to read all sheets"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "A1 range to read; omit to read each sheet's full used range (spans internal blank rows/columns, not just the A1 current region)"
|
||
},
|
||
{
|
||
"name": "no-header",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Treat the first row as data instead of a header (columns get positional names col1, col2, ...)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-search": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "find",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Text to find (interpreted as regex when `--regex` is set)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Search range (A1 notation); whole sheet when omitted"
|
||
},
|
||
{
|
||
"name": "match-case",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Case-sensitive match"
|
||
},
|
||
{
|
||
"name": "match-entire-cell",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Match the entire cell content"
|
||
},
|
||
{
|
||
"name": "regex",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Interpret `--find` as a regex pattern"
|
||
},
|
||
{
|
||
"name": "include-formulas",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Also search within formula text"
|
||
},
|
||
{
|
||
"name": "max-matches",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Safety cap; default 5000",
|
||
"default": "5000",
|
||
"hidden": true
|
||
},
|
||
{
|
||
"name": "offset",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Skip the first N matches (for pagination); default 0",
|
||
"default": "0"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-replace": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "find",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Text to find for replacement"
|
||
},
|
||
{
|
||
"name": "replacement",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Replacement text; pass empty string `\"\"` to delete matched content"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Replace range (A1 notation); whole sheet when omitted"
|
||
},
|
||
{
|
||
"name": "match-case",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Case-sensitive match"
|
||
},
|
||
{
|
||
"name": "match-entire-cell",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Match the entire cell content"
|
||
},
|
||
{
|
||
"name": "regex",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Interpret `--find` as a regex pattern"
|
||
},
|
||
{
|
||
"name": "include-formulas",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Also replace within formula text"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Required preflight: outputs `would_replace_count` for user confirmation before the actual replace"
|
||
}
|
||
]
|
||
},
|
||
"+cells-set": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Write range (A1 notation)"
|
||
},
|
||
{
|
||
"name": "cells",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON 2D array `[[{cell},...],...]`, dimensions must match `--range`; each cell may carry `value` / `formula` / `cell_styles` / `note` / `rich_text` (incl. `type=\"embed-image\"` in-cell image); run `--print-schema` for full fields",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "allow-overwrite",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Allow overwriting non-empty cells (default true); set false to error if any target cell is non-empty",
|
||
"default": "true"
|
||
},
|
||
{
|
||
"name": "max-cells",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Safety cap; default 50000",
|
||
"default": "50000",
|
||
"hidden": true
|
||
},
|
||
{
|
||
"name": "copy-to-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Copy-to range (A1 notation): replicate what --cells wrote into --range (values/formulas/styles, per the fields actually passed) to this range; formula refs auto-shift (C2=B2 -> C3=B3). Write a one-row/one-block template then fill a whole column/area. Supports full rows '3:6', full columns 'C:E', to-col-end 'D3:D', to-row-end 'D3:3', and comma-separated multiple targets like 'C1:D2,E5:F6'."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-set-style": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target range (A1 notation, e.g. `A1:B2`)"
|
||
},
|
||
{
|
||
"name": "background-color",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Background color (hex, e.g. `#ffffff`)"
|
||
},
|
||
{
|
||
"name": "font-color",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font color (hex, e.g. `#000000`)"
|
||
},
|
||
{
|
||
"name": "font-family",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font family name (e.g. `Arial`, `Microsoft YaHei`)"
|
||
},
|
||
{
|
||
"name": "font-size",
|
||
"kind": "own",
|
||
"type": "float64",
|
||
"required": "optional",
|
||
"desc": "Font size in px (e.g. 10, 12, 14)"
|
||
},
|
||
{
|
||
"name": "font-style",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font style",
|
||
"enum": [
|
||
"normal",
|
||
"italic"
|
||
]
|
||
},
|
||
{
|
||
"name": "font-weight",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font weight",
|
||
"enum": [
|
||
"normal",
|
||
"bold"
|
||
]
|
||
},
|
||
{
|
||
"name": "font-line",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font line style",
|
||
"enum": [
|
||
"none",
|
||
"underline",
|
||
"line-through"
|
||
]
|
||
},
|
||
{
|
||
"name": "horizontal-alignment",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Horizontal alignment",
|
||
"enum": [
|
||
"left",
|
||
"center",
|
||
"right"
|
||
]
|
||
},
|
||
{
|
||
"name": "vertical-alignment",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Vertical alignment",
|
||
"enum": [
|
||
"top",
|
||
"middle",
|
||
"bottom"
|
||
]
|
||
},
|
||
{
|
||
"name": "word-wrap",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Word-wrap strategy",
|
||
"enum": [
|
||
"overflow",
|
||
"auto-wrap",
|
||
"word-clip"
|
||
]
|
||
},
|
||
{
|
||
"name": "number-format",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Number format pattern (e.g. text `@`, number `0.00`, currency `$#,##0.00`, date `mm/dd/yyyy`)"
|
||
},
|
||
{
|
||
"name": "border-styles",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Border config JSON: `{ top: {style,color,weight}, bottom: ..., left: ..., right: ... }`; same shape for all 4 sides",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-set-image": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target cell (A1 notation; must be a single cell, e.g. `A1`; start and end must be identical)"
|
||
},
|
||
{
|
||
"name": "image",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Local image path (PNG / JPEG / JPG / GIF / BMP / JFIF / EXIF / TIFF / BPG / HEIC)"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Image file name (with extension); defaults to the basename of `--image`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dropdown-set": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target range (A1 notation, e.g. `A2:A100`)"
|
||
},
|
||
{
|
||
"name": "options",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Options as a JSON array, e.g. `[\"opt1\",\"opt2\"]`. Server enforces no item-count cap and no per-item length cap; values containing commas are accepted (they are escape-encoded on the wire). For very large lists prefer `--source-range`.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "colors",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Per-option pill colors, RGB hex array (e.g. `[\"#1FB6C1\",\"#F006C2\"]`). Length may be shorter than the source (`--options` items / `--source-range` cells) — extras cycle through a 10-color palette — but never longer (CLI Validate rejects: `--colors length (N) must not exceed dropdown source size (M)`). **Applies on its own**; ignored when `--highlight=false`.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Enable multi-select; default `false`"
|
||
},
|
||
{
|
||
"name": "highlight",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Pill-highlight switch. **Omitted = ON** (options cycle through a 10-color palette). Pass `--highlight=false` for a plain dropdown. Override colors via `--colors`."
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Source range for listFromRange dropdown (A1 + sheet prefix, e.g. `'Sheet1'!T1:T3`); maps to server `data_validation.range` and auto-sets `data_validation.type='listFromRange'`. XOR with `--options`: pass `--options` for an inline list (type=list), pass this for a range reference (type=listFromRange). `--colors` length rule unchanged (≤ source range cell count); `--highlight` / `--multiple` behave the same. When `--highlight` is on and the source covers more than 2000 cells, the server flags the dropdown as option-error (highlight + large source is an unsupported combo); CLI emits a stderr warning. Pass `--highlight=false` to suppress."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+csv-put": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "start-cell",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Top-left A1 anchor (e.g. `A1`, `B5`; no sheet prefix — use `--sheet-id` / `--sheet-name` to select the sheet); must be a single cell, range notation not accepted; the bottom-right is inferred from CSV row/column counts",
|
||
"default": "A1"
|
||
},
|
||
{
|
||
"name": "csv",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "RFC 4180 CSV text; values or formulas (a leading = is evaluated as a formula); no styles / comments / images (use +cells-set for those).",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "allow-overwrite",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Allow overwriting (default true); set false to error if any target cell is non-empty",
|
||
"default": "true"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "alias for --start-cell (parity with +csv-get / +cells-set, which locate with --range); a range like A1:H17 collapses to its top-left cell",
|
||
"hidden": true
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+table-put": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL to write into (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token to write into (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheets",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Typed table payload (pandas-DataFrame-shaped) as JSON: top-level `{\"sheets\":[...]}`, with each array item a sub-sheet `{name, start_cell?, mode?, header?, allow_overwrite?, columns:[\"colA\",\"colB\",...], data:[[...]], dtypes?:{colA:pandasDtype, ...}, formats?:{colA:numberFormat, ...}}` — `name` and the outer `sheets` envelope are both required. Agents typically use `df_to_sheet(df, name)` from `scripts/sheets_df.py` to pack each DataFrame into one item, then wrap the list in `{\"sheets\":[...]}`. `dtypes` values are pandas dtype strings (`int64`, `float64`, `Int64`, `bool`, `boolean`, `datetime64[ns]`, `object`, ...); the writer maps them to internal string/number/date/bool — omit `dtypes` and a column writes as text (good for raw CSV-shaped data). `formats[col]` is an Excel number_format string (e.g. `#,##0.00`, `0.0%`, `yyyy-mm`); when absent, date columns default to `yyyy-mm-dd` and string columns to text format (`@`).",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "styles",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Visual operations applied after the typed write, as JSON: top-level `{styles:[...]}`. Each item corresponds to one written sheet and must include `name`, plus at least one of `cell_styles` / `row_sizes` / `col_sizes` / `cell_merges`. `cell_styles` entries use +cells-set-style fields with a cell range; row/col sizes use dimension ranges plus type/size; merges use cell ranges plus optional merge_type. The styles array length/order/name must match the written sheets in --sheets.sheets. Run `+table-put --print-schema --flag-name styles` for the full cell_styles field schema.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-clear": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Range to clear (A1 notation)"
|
||
},
|
||
{
|
||
"name": "scope",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Clear scope: `content` (default, values only) / `formats` (formats only) / `all` (values and formats)",
|
||
"default": "content",
|
||
"enum": [
|
||
"content",
|
||
"formats",
|
||
"all"
|
||
]
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); clear is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-merge": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Range to merge / unmerge (A1 notation)"
|
||
},
|
||
{
|
||
"name": "merge-type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Merge direction (`+cells-merge` only)",
|
||
"default": "all",
|
||
"enum": [
|
||
"all",
|
||
"rows",
|
||
"columns"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-unmerge": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Range to merge / unmerge (A1 notation)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+rows-resize": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "height",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "xor",
|
||
"desc": "Uniform row height in pixels (e.g. 30 / 40 / 60; NOT points), used with `--range`. Passing --height implies pixel mode; --type may be omitted (or set to `pixel` — equivalent). For per-row heights use `--heights`",
|
||
"default": "0"
|
||
},
|
||
{
|
||
"name": "heights",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Per-row height map — set different heights for many rows in one atomic call. Keys: single row (`\"1\"`) or closed range (`\"2:20\"`); values: pixel height (e.g. 30 / 50), `\"auto\"` (fit content) or `\"standard\"` (reset to default). Units are pixels, NOT points. Mutually exclusive with `--range` / `--height` / `--type`",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sizing mode: `pixel` (requires `--height`) / `standard` (reset to default row height) / `auto` (fit content). Passing --height alone is the common form; `--type standard` / `--type auto` cannot be combined with `--height`",
|
||
"enum": [
|
||
"pixel",
|
||
"standard",
|
||
"auto"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Row closed range to resize; 1-based row numbers like `2:10` or `5` (single row). Required for the uniform form (with `--height` or `--type`); omit with the map form (`--heights`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cols-resize": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "width",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "xor",
|
||
"desc": "Uniform column width in pixels (e.g. 80 / 120 / 200; NOT Excel character units), used with `--range`. Passing --width implies pixel mode; --type may be omitted (or set to `pixel` — equivalent). For per-column widths use `--widths`",
|
||
"default": "0"
|
||
},
|
||
{
|
||
"name": "widths",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Per-column width map — set different widths for many columns in one atomic call. Keys: single column (`\"A\"`) or closed range (`\"C:E\"`); values: pixel width (e.g. 80 / 120 / 200) or `\"standard\"` (reset to default). Units are pixels, NOT Excel character units (px ≈ chars × 8 + 16). Mutually exclusive with `--range` / `--width` / `--type`",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sizing mode: `pixel` (requires `--width`) / `standard` (reset to default column width). Passing --width alone is the common form; `--type standard` cannot be combined with `--width`",
|
||
"enum": [
|
||
"pixel",
|
||
"standard"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Column closed range to resize; column letters like `A:E` or `C` (single column). Required for the uniform form (with `--width` or `--type`); omit with the map form (`--widths`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+range-move": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Source A1 range"
|
||
},
|
||
{
|
||
"name": "target-sheet-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Destination sub-sheet id; defaults to the same sheet as the source"
|
||
},
|
||
{
|
||
"name": "target-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Destination A1 range (anchor cell is enough; size inferred from the source)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+range-copy": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Source A1 range"
|
||
},
|
||
{
|
||
"name": "target-sheet-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Destination sub-sheet id; defaults to the same sheet as the source"
|
||
},
|
||
{
|
||
"name": "target-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Destination A1 range (anchor cell is enough; size inferred from the source)"
|
||
},
|
||
{
|
||
"name": "paste-type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Paste content type (`+range-copy` only)",
|
||
"default": "all",
|
||
"enum": [
|
||
"values",
|
||
"formulas",
|
||
"formats",
|
||
"all"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+range-fill": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Fill template range (seed cells for the series)"
|
||
},
|
||
{
|
||
"name": "target-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Destination fill range (A1 notation)"
|
||
},
|
||
{
|
||
"name": "series-type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Fill series type",
|
||
"default": "auto",
|
||
"enum": [
|
||
"auto",
|
||
"linear",
|
||
"growth",
|
||
"date",
|
||
"copy"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+range-sort": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Sort range (A1 notation; whether the header is included depends on `--has-header`)"
|
||
},
|
||
{
|
||
"name": "sort-keys",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON array: `[{\"column\":\"<col letter>\",\"ascending\":<bool>}, ...]`",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "has-header",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Treat the first row as a header and exclude from sort; default `false`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+batch-update": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator (independent from per-operation sheet locator)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator (independent from per-operation sheet locator)"
|
||
},
|
||
{
|
||
"name": "operations",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON array: [{\"shortcut\":\"+xxx-yyy\",\"input\":{...}}, ...]. shortcut uses CLI names; input is that shortcut's flag set — it includes the per-operation sheet locator (sheet_id or sheet_name) but not the spreadsheet token/url (pass that once at the top level via --url/--spreadsheet-token; +batch-update has no top-level --sheet-id). input keys are the shortcut's flags flattened into JSON (e.g. \"range\":\"A11:B12\"), not another nested layer. For basic flags use lark-cli sheets <shortcut> --help; for composite JSON flags use --print-schema --flag-name <flag>. Do not pass an explicit operation field. Strict transaction by default, pass --continue-on-error for soft batch; no nesting; executed serially.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "continue-on-error",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Continue with remaining operations when a sub-operation fails; default false (abort on first failure)"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm high-risk write (exit code 10 without this flag)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Print the request template for each sub-operation; no network side effects"
|
||
}
|
||
]
|
||
},
|
||
"+cells-batch-set-style": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target ranges as a JSON array (up to 100 items, e.g. `[\"Sheet1!A1:B2\",\"Sheet2!D1:D10\"]`, prefix written bare without quotes); each prefix must exactly match the sheet display name (case-sensitive), not the sheet reference_id; ranges may target different sheets; the same style is applied to every range",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "background-color",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Background color (hex, e.g. `#ffffff`)"
|
||
},
|
||
{
|
||
"name": "font-color",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font color (hex, e.g. `#000000`)"
|
||
},
|
||
{
|
||
"name": "font-family",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font family name (e.g. `Arial`, `Microsoft YaHei`)"
|
||
},
|
||
{
|
||
"name": "font-size",
|
||
"kind": "own",
|
||
"type": "float64",
|
||
"required": "optional",
|
||
"desc": "Font size in px (e.g. 10, 12, 14)"
|
||
},
|
||
{
|
||
"name": "font-style",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font style",
|
||
"enum": [
|
||
"normal",
|
||
"italic"
|
||
]
|
||
},
|
||
{
|
||
"name": "font-weight",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font weight",
|
||
"enum": [
|
||
"normal",
|
||
"bold"
|
||
]
|
||
},
|
||
{
|
||
"name": "font-line",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Font line style",
|
||
"enum": [
|
||
"none",
|
||
"underline",
|
||
"line-through"
|
||
]
|
||
},
|
||
{
|
||
"name": "horizontal-alignment",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Horizontal alignment",
|
||
"enum": [
|
||
"left",
|
||
"center",
|
||
"right"
|
||
]
|
||
},
|
||
{
|
||
"name": "vertical-alignment",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Vertical alignment",
|
||
"enum": [
|
||
"top",
|
||
"middle",
|
||
"bottom"
|
||
]
|
||
},
|
||
{
|
||
"name": "word-wrap",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Word-wrap strategy",
|
||
"enum": [
|
||
"overflow",
|
||
"auto-wrap",
|
||
"word-clip"
|
||
]
|
||
},
|
||
{
|
||
"name": "number-format",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Number format pattern (e.g. text `@`, number `0.00`, currency `$#,##0.00`, date `mm/dd/yyyy`)"
|
||
},
|
||
{
|
||
"name": "border-styles",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Border config JSON (same shape as in +cells-set-style)",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dropdown-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target ranges as a JSON array (up to 100 items, e.g. `[\"Sheet1!A2:A100\",\"Sheet1!C2:C100\"]`, prefix written bare without quotes); each item must include a sheet prefix; the prefix must exactly match the sheet display name (case-sensitive), not the sheet reference_id",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "options",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Options as a JSON array, e.g. `[\"opt1\",\"opt2\"]`. Server enforces no item-count cap and no per-item length cap; values containing commas are accepted (they are escape-encoded on the wire). For very large lists prefer `--source-range`.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "colors",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Per-option pill colors, RGB hex array (e.g. `[\"#1FB6C1\",\"#F006C2\"]`). Length may be shorter than the source (`--options` items / `--source-range` cells) — extras cycle through a 10-color palette — but never longer (CLI Validate rejects: `--colors length (N) must not exceed dropdown source size (M)`). **Applies on its own**; ignored when `--highlight=false`.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Enable multi-select"
|
||
},
|
||
{
|
||
"name": "highlight",
|
||
"kind": "own",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Pill-highlight switch. **Omitted = ON** (options cycle through a 10-color palette). Pass `--highlight=false` for a plain dropdown. Override colors via `--colors`."
|
||
},
|
||
{
|
||
"name": "source-range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Source range for listFromRange dropdown (A1 + sheet prefix, e.g. `'Sheet1'!T1:T3`); maps to server `data_validation.range` and auto-sets `data_validation.type='listFromRange'`. XOR with `--options`: pass `--options` for an inline list (type=list), pass this for a range reference (type=listFromRange). `--colors` length rule unchanged (≤ source range cell count); `--highlight` / `--multiple` behave the same. When `--highlight` is on and the source covers more than 2000 cells, the server flags the dropdown as option-error (highlight + large source is an unsupported combo); CLI emits a stderr warning. Pass `--highlight=false` to suppress."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+dropdown-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target ranges as a JSON array (up to 100 items, e.g. `[\"Sheet1!E2:E6\"]`, prefix written bare without quotes); each item must include a sheet prefix; the prefix must exactly match the sheet display name (case-sensitive), not the sheet reference_id",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm high-risk write (exit code 10 without this flag)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cells-batch-clear": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target ranges as a JSON array (up to 100 items, e.g. `[\"Sheet1!A2:Z1000\",\"Sheet2!A2:Z1000\"]`, prefix written bare without quotes); each prefix must exactly match the sheet display name (case-sensitive), not the sheet reference_id; ranges may target different sheets; the same scope is cleared from every range",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "scope",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Clear scope: `content` (default, values only) / `formats` (formats only) / `all` (values and formats)",
|
||
"default": "content",
|
||
"enum": [
|
||
"content",
|
||
"formats",
|
||
"all"
|
||
]
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); batch clear is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+chart-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "chart-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter to a single chart reference_id"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+chart-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Full chart config JSON. Top-level keys: `position` / `offset` / `size` / `snapshot` (no top-level `data`, no extra nested `properties`); chart data config lives under `snapshot.data` (`refs` / `headerMode` / `dim1` / `dim2`); must include at least one of `snapshot.data.dim1.serie.index` or `dim2.series[].index`, otherwise the server rejects it. Deeply nested — run `--print-schema --flag-name properties` for the full structure.",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": "Print the request template; no side effects"
|
||
}
|
||
]
|
||
},
|
||
"+chart-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "chart-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target chart reference_id"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Full or sufficiently complete chart config JSON (read back with `+chart-list` first, then patch)",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+chart-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "chart-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target chart reference_id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+pivot-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "pivot-table-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter by id"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+pivot-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON: {\"rows\":[...],\"columns\":[...],\"values\":[...],\"filters\":[...],\"show_row_grand_total\":true,\"show_col_grand_total\":true} (data source goes through --source; do not put source here)",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "target-position",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Top-left cell within the target sub-sheet (A1 notation, e.g. `A1`); maps to the top-level `target_position`, default `A1` (not sent when the value is A1). It and `--range` both express placement but map to different wire fields — avoid passing conflicting values for both.",
|
||
"default": "A1"
|
||
},
|
||
{
|
||
"name": "target-sheet-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Reference_id of the target sub-sheet where the pivot table will be placed (mutually exclusive with `--target-sheet-name`; takes priority when both given; when both omitted, a new sub-sheet is auto-created to host the pivot — recommended). Distinct from the data-source sheet, which lives inside --source as a 'Sheet'-prefixed A1 reference like 'Sheet1'!A1:D100."
|
||
},
|
||
{
|
||
"name": "target-sheet-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Name of the target sub-sheet where the pivot table will be placed (mutually exclusive with `--target-sheet-id`; when both omitted, a new sub-sheet is auto-created to host the pivot — recommended). Distinct from the data-source sheet, which lives inside --source as a 'Sheet'-prefixed A1 reference like 'Sheet1'!A1:D100."
|
||
},
|
||
{
|
||
"name": "source",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Pivot table source range (A1 notation; format `'SheetName'!StartCell:EndCell`, e.g. `'Sheet1'!A1:D100`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Pivot table top-left placement (single A1 value, e.g. `F1`; create only), maps to `properties.range`; placed at the top-left of the target sub-sheet (a newly created one by default) when omitted. It and `--target-position` both express placement but map to different wire fields — avoid passing conflicting values for both."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+pivot-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "pivot-table-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target pivot table id"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Full or sufficiently complete pivot config (read back with `+pivot-list --pivot-table-id <id>` first, then patch)",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+pivot-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "pivot-table-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target pivot table id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); delete is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cond-format-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "rule-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter by rule id"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cond-format-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Rule config JSON: `style` (required, applied on match), `attrs?` (rule-type-dependent params), `has_ref?`. `rule_type` and `ranges` are separate flags",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "rule-type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Conditional format rule type; takes precedence over the same-named field inside `--properties`",
|
||
"enum": [
|
||
"duplicateValues",
|
||
"uniqueValues",
|
||
"cellIs",
|
||
"containsText",
|
||
"timePeriod",
|
||
"containsBlanks",
|
||
"notContainsBlanks",
|
||
"dataBar",
|
||
"colorScale",
|
||
"rank",
|
||
"aboveAverage",
|
||
"expression",
|
||
"iconSet"
|
||
]
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "A1 ranges where the conditional format applies, as a JSON array (e.g. `[\"A1:A100\",\"C2:C50\"]`); takes precedence over the same-named field inside `--properties`",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cond-format-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "rule-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target rule id"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Rule config JSON, same shape as `+cond-format-create --properties`; update overwrites the entire rule",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "rule-type",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Conditional format rule type; takes precedence over the same-named field inside `--properties`",
|
||
"enum": [
|
||
"duplicateValues",
|
||
"uniqueValues",
|
||
"cellIs",
|
||
"containsText",
|
||
"timePeriod",
|
||
"containsBlanks",
|
||
"notContainsBlanks",
|
||
"dataBar",
|
||
"colorScale",
|
||
"rank",
|
||
"aboveAverage",
|
||
"expression",
|
||
"iconSet"
|
||
]
|
||
},
|
||
{
|
||
"name": "ranges",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "A1 ranges where the conditional format applies, as a JSON array (e.g. `[\"A1:A100\",\"C2:C50\"]`); takes precedence over the same-named field inside `--properties`",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+cond-format-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "rule-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target rule id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); delete is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Filter range (A1 notation, including header row, e.g. `A1:F1000`); do not duplicate the range field inside `--properties`"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter rule JSON: `rules` (per-column rule array), `filtered_columns?` (active column index hint). The flag is optional overall — if provided, `rules` must be non-empty; if omitted, an empty filter is created on `--range` (no column conditions). `range` is a separate flag (do not duplicate inside this JSON)",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Filter rule JSON: `rules` and `filtered_columns?`; update overwrites the entire rule set (pass `rules: []` to clear). `range` is a separate flag",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Range the filter applies to (A1 notation, e.g. `A1:F1000`); takes precedence over the same-named field inside `--properties`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); delete is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-view-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "view-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter by filter-view reference_id (returns the matching single view)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-view-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Filter-view rule JSON: `rules?` (per-column rule array), `filtered_columns?`. `range` and `view_name` are separate flags",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Range the filter view applies to (A1 notation, e.g. `A1:F1000`); takes precedence over the same-named field inside `--properties`; required on create and must cover the header row"
|
||
},
|
||
{
|
||
"name": "view-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter-view name; auto-assigned by the server when omitted; takes precedence over the same-named field inside `--properties`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-view-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "view-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target filter-view reference_id"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Filter-view rule JSON: `rules?`, `filtered_columns?`; update overwrites the entire rule set (read back with `+filter-view-list` first, then patch; pass `rules: []` to clear). `range` and `view_name` are separate flags",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "range",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Range the filter view applies to (A1 notation, e.g. `A1:F1000`); takes precedence over the same-named field inside `--properties`; omit to keep the current range on update"
|
||
},
|
||
{
|
||
"name": "view-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter-view name; auto-assigned by the server when omitted on create, kept unchanged when omitted on update; takes precedence over the same-named field inside `--properties`"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+filter-view-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "view-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target filter-view reference_id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm high-risk write (exit code 10 without this flag)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sparkline-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "group-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter by group_id"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sparkline-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON: `{config (shared style), sparklines (array of mini-charts)}`; run `--print-schema` for the full structure",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sparkline-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "group-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target group id"
|
||
},
|
||
{
|
||
"name": "properties",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "JSON: `{config, sparklines}`; read back with `+sparkline-list --group-id <id>` first, then patch; run `--print-schema` for the full structure",
|
||
"input": [
|
||
"file",
|
||
"stdin"
|
||
]
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+sparkline-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "group-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target group id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); delete is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+float-image-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "float-image-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Filter by id; lists all float images on the sheet when omitted"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+float-image-create": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "image-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Image name, including extension (e.g. `logo.png`)"
|
||
},
|
||
{
|
||
"name": "image-token",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Image file_token (XOR with `--image-uri`). Common source: `image_token` returned by `+float-image-list`"
|
||
},
|
||
{
|
||
"name": "image-uri",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Image URI handle returned by the upload flow (not a sheet object reference_id; XOR with `--image-token`); converted to file_token automatically"
|
||
},
|
||
{
|
||
"name": "position-row",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Row anchor of the image's top-left corner (0-based)"
|
||
},
|
||
{
|
||
"name": "position-col",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Column anchor of the image's top-left corner (column letter, e.g. `A` / `B`)"
|
||
},
|
||
{
|
||
"name": "size-width",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Image width in pixels"
|
||
},
|
||
{
|
||
"name": "size-height",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Image height in pixels"
|
||
},
|
||
{
|
||
"name": "offset-row",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Pixel offset within the anchor row, on top of `--position-row`"
|
||
},
|
||
{
|
||
"name": "offset-col",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Pixel offset within the anchor column, on top of `--position-col`"
|
||
},
|
||
{
|
||
"name": "z-index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Image z-index controlling stacking order"
|
||
},
|
||
{
|
||
"name": "image",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Local image path; the CLI uploads it as a sheet_image and uses the returned file_token (XOR with --image-token / --image-uri)"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+float-image-update": {
|
||
"risk": "write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "float-image-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target float image id"
|
||
},
|
||
{
|
||
"name": "image-name",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Image name, including extension (e.g. `logo.png`)"
|
||
},
|
||
{
|
||
"name": "image-token",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Optional image file_token; mutually exclusive with `--image-uri`; omit both to keep the current image. Common source: `image_token` returned by `+float-image-list`"
|
||
},
|
||
{
|
||
"name": "image-uri",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "optional",
|
||
"desc": "Optional image URI handle returned by the upload flow (not a sheet object reference_id); mutually exclusive with `--image-token`; omit both to keep the current image; converted to file_token automatically"
|
||
},
|
||
{
|
||
"name": "position-row",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Row anchor of the image's top-left corner (0-based)"
|
||
},
|
||
{
|
||
"name": "position-col",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Column anchor of the image's top-left corner (column letter, e.g. `A` / `B`)"
|
||
},
|
||
{
|
||
"name": "size-width",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Image width in pixels"
|
||
},
|
||
{
|
||
"name": "size-height",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Image height in pixels"
|
||
},
|
||
{
|
||
"name": "offset-row",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Pixel offset within the anchor row, on top of `--position-row`"
|
||
},
|
||
{
|
||
"name": "offset-col",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Pixel offset within the anchor column, on top of `--position-col`"
|
||
},
|
||
{
|
||
"name": "z-index",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Image z-index controlling stacking order"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+float-image-delete": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "sheet-id",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet reference_id (XOR with `--sheet-name`)"
|
||
},
|
||
{
|
||
"name": "sheet-name",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Sheet name (XOR with `--sheet-id`)"
|
||
},
|
||
{
|
||
"name": "float-image-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Target float image id"
|
||
},
|
||
{
|
||
"name": "yes",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "required",
|
||
"desc": "Confirm destructive write (exit code 10 without this flag); delete is irreversible"
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+history-list": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "end-version",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "Max version to query (descending pagination). Omit on the first call; pass next_end_version from the previous response."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+history-revert": {
|
||
"risk": "high-risk-write",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "history-version-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "History version to revert to (from +history-list)."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+history-revert-status": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet locator"
|
||
},
|
||
{
|
||
"name": "transaction-id",
|
||
"kind": "own",
|
||
"type": "string",
|
||
"required": "required",
|
||
"desc": "Async revert transaction id (from +history-revert)."
|
||
},
|
||
{
|
||
"name": "dry-run",
|
||
"kind": "system",
|
||
"type": "bool",
|
||
"required": "optional",
|
||
"desc": ""
|
||
}
|
||
]
|
||
},
|
||
"+changeset-get": {
|
||
"risk": "read",
|
||
"flags": [
|
||
{
|
||
"name": "url",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet URL (XOR with `--spreadsheet-token`)"
|
||
},
|
||
{
|
||
"name": "spreadsheet-token",
|
||
"kind": "public",
|
||
"type": "string",
|
||
"required": "xor",
|
||
"desc": "Spreadsheet token (XOR with `--url`)"
|
||
},
|
||
{
|
||
"name": "start-revision",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "required",
|
||
"desc": "Start version (CS revision); the before baseline for review (must be >= 1)"
|
||
},
|
||
{
|
||
"name": "end-revision",
|
||
"kind": "own",
|
||
"type": "int",
|
||
"required": "optional",
|
||
"desc": "End version (CS revision); defaults to the latest revision. Gap (end-start+1) must be <= 20",
|
||
"default": "-1"
|
||
}
|
||
]
|
||
}
|
||
}
|