Skip to content

docs: clarify wiki base token resolution#982

Merged
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/base-wiki-fast-path
May 20, 2026
Merged

docs: clarify wiki base token resolution#982
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/base-wiki-fast-path

Conversation

@zgz2048
Copy link
Copy Markdown
Collaborator

@zgz2048 zgz2048 commented May 20, 2026

Summary

Clarify how agents should resolve a Wiki Base link before running lark-cli base +... commands. This keeps the guidance in the existing lark-base skill and avoids treating /wiki/{token} as a Base token.

Changes

  • Replace stale wiki resolution wording with lark-cli wiki +node-get.
  • Add a copyable BASE_TOKEN=... example in the existing Token and links section.
  • Point agents to the wiki node-get reference when the quick resolution path fails.

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark xxx command works as expected

Manual checks:

  • node scripts/skill-format-check/index.js
  • lark-cli wiki +node-get --as user --token "https://bytedance.larkoffice.com/wiki/A2xYw4PXuiPWuIkLASLchEU3nmc?table=tblqyKVKWysqfqLw&view=vewDJr0Zc2" --jq ".data | select(.obj_type == \"bitable\") | .obj_token"

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Updated Base skill usage guidance with clearer command naming conventions for base operations
    • Refined instructions for handling wiki links and Base token extraction
    • Improved error recovery guidance for invalid Base token scenarios
    • Updated examples and workflows for better clarity on wiki node resolution

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f03a2f45-90fe-4ebb-998f-b20ead0ca8db

📥 Commits

Reviewing files that changed from the base of the PR and between 7226955 and 381c85e.

📒 Files selected for processing (1)
  • skills/lark-base/SKILL.md

📝 Walkthrough

Walkthrough

This PR standardizes the Base skill documentation to clarify how users resolve Wiki links to Base tokens. Updates across the preface, pre-constraints, token/link table, and error recovery sections now consistently recommend using lark-cli wiki +node-get to fetch link metadata and extract obj_token when the resolved obj_type is bitable.

Changes

Wiki-to-Base Token Workflow Documentation

Layer / File(s) Summary
Wiki-to-base token resolution workflow documentation
skills/lark-base/SKILL.md
Standardizes guidance across the skill document: updates command naming to reference lark-cli wiki +node-get, clarifies pre-constraint rules for /wiki/{token} inputs with obj_type and obj_token extraction, replaces wiki link parsing logic in the token/link table with lark-cli wiki +node-get plus jq filtering, and updates error recovery procedures to use the new wiki +node-get approach for wiki-derived token resolution.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • larksuite/cli#374: Both PRs modify the same Base skill documentation sections for wiki-to-base token resolution; this PR refines and standardizes the routing logic across multiple guidance sections.

Suggested reviewers

  • kongenpei
  • liangshuo-1

Poem

🐰 A wiki link finds its way,
Through node-get, bright as day,
obj_token hops into sight,
Base commands hum just right,
Docs now gleam in tidy light.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: clarifying wiki base token resolution in the documentation.
Description check ✅ Passed The PR description includes all required template sections: Summary, Changes, Test Plan with checkboxes, and Related Issues. Content is complete and specific.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels May 20, 2026
@zgz2048 zgz2048 force-pushed the codex/base-wiki-fast-path branch 3 times, most recently from 456eeda to 7226955 Compare May 20, 2026 04:01
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/lark-base/SKILL.md`:
- Line 258: The table row is broken by unescaped pipe characters in the inline
command BASE_TOKEN="$(lark-cli wiki +node-get --as user --token
"<wiki_url_or_token>" --jq '.data | select(.obj_type == "bitable") |
.obj_token')", causing the markdown table to misparse; fix it by either escaping
the pipes inside the jq expression (e.g. replace "|" with "\|") or move the full
command out of the table into a fenced code block and update the table cell to
reference that code block (keep the note about not passing wiki_token directly
as --base-token and the link to lark-wiki-node-get.md).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 027e20bf-1133-40af-ade2-d091ae2ef303

📥 Commits

Reviewing files that changed from the base of the PR and between d793790 and 7226955.

📒 Files selected for processing (1)
  • skills/lark-base/SKILL.md

Comment thread skills/lark-base/SKILL.md Outdated
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 20, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@381c85e6916691114e8092bb159d58efda5263fc

🧩 Skill update

npx skills add zgz2048/cli#codex/base-wiki-fast-path -y -g

@zgz2048 zgz2048 changed the title docs: add wiki base fast path docs: clarify wiki base token resolution May 20, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.58%. Comparing base (3354494) to head (381c85e).
⚠️ Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #982      +/-   ##
==========================================
+ Coverage   66.96%   67.58%   +0.62%     
==========================================
  Files         568      575       +7     
  Lines       53323    54269     +946     
==========================================
+ Hits        35709    36679     +970     
+ Misses      14649    14548     -101     
- Partials     2965     3042      +77     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kongenpei
kongenpei previously approved these changes May 20, 2026
@zgz2048 zgz2048 merged commit 0c4eadd into larksuite:main May 20, 2026
19 checks passed
@liangshuo-1 liangshuo-1 mentioned this pull request May 20, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants