skills/larksuite__cli
1
0
Fork 0
mirror of https://github.com/larksuite/cli.git synced 2026-09-14 18:42:53 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
docs/fetch-comment-help-contract
larksuite__cli/affordance/docs.md
T
zhangheng.023 70ccaf4f85 docs: document docs +fetch comment contract 
Add a Tips section to the docs +fetch affordance covering three
implicit contracts implemented in #2341 but never surfaced outside
shortcuts/doc and the skill reference: comments are always included
in the response with no flag to disable it, XML marks commented
content inline via a comment-refs attribute, and markdown/im-markdown
surface comments only through reference_map.comments.

Sync the golden affordance test that previously pinned +fetch to an
empty Tips list.
2026-08-18 17:04:19 +08:00

2.4 KiB
Raw Permalink Blame History

docs

skill: lark-doc

+create

Create a new Lark document from DocxXML or Markdown, optionally in a folder or Wiki node.

Tips

  • Match --doc-format to --content: XML is the default for rich DocxXML; use --doc-format markdown for Markdown input.
  • Before authoring --content, read the matching XML or Markdown guide under Related skills when available, unless already read. For XML, use only documented DocxXML tags.
  • For multiline --content, prefer @file or - (stdin) to avoid shell-escaping damage.

Skills

  • lark-doc/references/lark-doc-create-workflow.md
  • lark-doc/references/lark-doc-create.md
  • lark-doc/references/lark-doc-xml.md
  • lark-doc/references/lark-doc-md.md

+fetch

Read an entire Lark document, or limit the result to an outline, section, block range, or keyword match.

Tips

  • Comments are always included in the response with no flag to disable it; expect reference_map.comments regardless of --doc-format.
  • --doc-format xml marks commented content inline via a comment-refs attribute; markdown/im-markdown carry no inline ref — comments there live only in reference_map.comments.

Skills

  • lark-doc/references/lark-doc-fetch.md

+update

Apply targeted text or block edits, append content, or deliberately replace an entire Lark document.

Tips

  • Prefer str_replace or block_* commands for targeted edits. Use overwrite only when replacing the entire document is intended; it can discard unrelated rich content.
  • Before a block_* edit, fetch the target with lark-cli docs +fetch --detail with-ids and a narrow --scope; refetch after structural changes before reusing block IDs.
  • Before authoring --content, read the matching XML or Markdown guide under Related skills when available, unless already read. For XML, use only documented DocxXML tags.
  • Match --doc-format to --content; for multiline content, prefer @file or - (stdin).

Skills

  • lark-doc/references/lark-doc-update.md
  • lark-doc/references/lark-doc-xml.md
  • lark-doc/references/lark-doc-md.md

+history-list

Skills

  • lark-doc/references/lark-doc-history.md

+history-revert

Prerequisites

Skills

  • lark-doc/references/lark-doc-history.md

+history-revert-status

Prerequisites

Skills

  • lark-doc/references/lark-doc-history.md
Reference in New Issue View Git Blame Copy Permalink