lark-doc

Original：🇨🇳 Chinese

Translated

Lark Cloud Docs: Create and edit Lark documents. Create documents from Markdown, retrieve document content, update documents (append/overwrite/replace/insert/delete), upload and download images and files in documents, and search cloud space documents. Use this when users need to create or edit Lark documents, read document content, insert images into documents, or search cloud space documents; if users want to locate cloud space objects such as spreadsheets and reports by name or keyword, prioritize using the docs +search feature of this skill for resource discovery.

3.6kinstalls

Sourcelarksuite/cli

Added on2026-03-28

NPX Install

npx skill4agent add larksuite/cli lark-doc

SKILL.md Content (Chinese)

View Translation Comparison →

docs (v1)

CRITICAL — MUST use the Read tool to read
../lark-shared/SKILL.md
before starting, which contains authentication and permission handling

Core Concepts

Document Types and Tokens

In the Lark Open Platform, different types of documents have different URL formats and token handling methods. When performing document operations (such as adding comments, downloading files, etc.), you must first obtain the correct

file_token

.

URL Formats and Token Handling

URL Format	Example	Token Type	Handling Method
`/docx/`	`https://example.larksuite.com/docx/doxcnxxxxxxxxx`	`file_token`	Use the token in the URL path directly as the `file_token`
`/doc/`	`https://example.larksuite.com/doc/doccnxxxxxxxxx`	`file_token`	Use the token in the URL path directly as the `file_token`
`/wiki/`	`https://example.larksuite.com/wiki/wikcnxxxxxxxxx`	`wiki_token`	⚠️ Cannot be used directly, you need to query to obtain the real `obj_token` first
`/sheets/`	`https://example.larksuite.com/sheets/shtcnxxxxxxxxx`	`file_token`	Use the token in the URL path directly as the `file_token`
`/drive/folder/`	`https://example.larksuite.com/drive/folder/fldcnxxxx`	`folder_token`	Use the token in the URL path as the folder token

Special Handling of Wiki Links (Critical!)

Knowledge base links (

/wiki/TOKEN

) may correspond to different document types such as cloud documents, spreadsheets, base tables, etc. Do not assume that the token in the URL is the file_token directly; you must first query the actual type and real token.

Processing Flow

Use
wiki.spaces.get_node
to query node information

bash

lark-cli wiki spaces get_node --params '{"token":"wiki_token"}'

Extract key information from the returned results
- ```
node.obj_type
```
  : Document type (docx/doc/sheet/bitable/slides/file/mindnote)
- ```
node.obj_token
```
  : Real document token (used for subsequent operations)
- ```
node.title
```
  : Document title

Use the corresponding API based on
obj_type

obj_type	Description	API to Use
`docx`	New version cloud document	`drive file.comments.` , `docx.`
`doc`	Old version cloud document	`drive file.comments.*`
`sheet`	Spreadsheet	`sheets.*`
`bitable`	Base table	`bitable.*`
`slides`	Slides	`drive.*`
`file`	File	`drive.*`
`mindnote`	Mind map	`drive.*`

Query Example

bash

# Query wiki node
lark-cli wiki spaces get_node --params '{"token":"wiki_token"}'

Return result example:

json

{
   "node": {
      "obj_type": "docx",
      "obj_token": "xxxx",
      "title": "Title",
      "node_type": "origin",
      "space_id": "12345678910"
   }
}

Resource Relationships

Wiki Space
└── Wiki Node
    ├── obj_type: docx (New version document)
    │   └── obj_token (Real document token)
    ├── obj_type: doc (Old version document)
    │   └── obj_token (Real document token)
    ├── obj_type: sheet (Spreadsheet)
    │   └── obj_token (Real document token)
    ├── obj_type: bitable (Base table)
    │   └── obj_token (Real document token)
    └── obj_type: file/slides/mindnote
        └── obj_token (Real document token)

Drive Folder
└── File (File/Document)
    └── file_token (Use directly)

Important Note: Whiteboard Editing

⚠️ The lark-doc skill cannot directly edit existing whiteboard content, but
docs +update
can create new blank whiteboards

Scenario 1: Obtained document content and whiteboard token via docs +fetch

If the user has pulled the document content via

docs +fetch

and the document already contains a whiteboard (the returned markdown includes the

<whiteboard token="xxx"/>

tag), guide the user to:

Record the whiteboard token
Check
```
../lark-whiteboard/SKILL.md
```
to learn how to edit whiteboard content

Scenario 2: Just created a whiteboard and need to edit it

If the user just created a blank whiteboard via

docs +update

and needs to edit it: Step 1: Create using blank whiteboard syntax

Directly pass

<whiteboard type="blank"></whiteboard>

in

--markdown

When multiple blank whiteboards are needed, repeat multiple whiteboard tags in the same
```
--markdown
```
Step 2: Record the token from the response
After
```
docs +update
```
succeeds, read the response field
```
data.board_tokens
```
```
data.board_tokens
```
is a list of tokens for the newly created whiteboards; use these tokens directly for subsequent editing Step 3: Guide to editing
Record the token of the whiteboard to be edited
Check
```
../lark-whiteboard/SKILL.md
```
to learn how to edit whiteboard content

Notes

Existing whiteboard content cannot be directly edited via lark-doc's
```
docs +update
```
Specialized
```
../lark-whiteboard/SKILL.md
```
is required for editing whiteboards

Quick Decision

When users say "find a spreadsheet", "search for spreadsheets by name", "find reports", or "recently opened spreadsheets", first use
```
lark-cli docs +search
```
for resource discovery.
```
docs +search
```
does not only search documents/Wiki; the results will directly return cloud space objects such as
```
SHEET
```
.
After obtaining the spreadsheet URL/token, switch to
```
lark-sheets
```
for operations such as internal reading, filtering, and writing.

Supplementary Notes

In addition to searching documents/Wiki,

docs +search

also serves as a resource discovery entry for "locating cloud space objects first, then switching back to the corresponding business skill for operations"; when users verbally mention "spreadsheets/reports", start here first.

Shortcuts (Recommended for Priority Use)

Shortcuts are advanced encapsulations of common operations (

lark-cli docs +<verb> [flags]

). Prioritize using operations with Shortcuts.

Shortcut	Description
`+search`	Search Lark docs, Wiki, and spreadsheet files (Search v2: doc_wiki/search)
`+create`	Create a Lark document
`+fetch`	Fetch Lark document content
`+update`	Update a Lark document
`+media-insert`	Insert a local image or file at the end of a Lark document (4-step orchestration + auto-rollback)
`+media-download`	Download document media or whiteboard thumbnail (auto-detects extension)
`+whiteboard-update`	Update an existing whiteboard in lark document with whiteboard dsl. Such DSL input from stdin. refer to lark-whiteboard skill for more details.