@yandy0725/pi-lark 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/README.zh.md +30 -0
- package/package.json +36 -0
- package/skills/lark-approval/SKILL.md +56 -0
- package/skills/lark-approval/references/lark-approval-initiate.md +196 -0
- package/skills/lark-approval/references/lark-approval-instance-form-control-parameters.md +606 -0
- package/skills/lark-approval/references/lark-approval-instance-value-sourcing.md +108 -0
- package/skills/lark-apps/SKILL.md +78 -0
- package/skills/lark-apps/references/lark-apps-access-scope-get.md +28 -0
- package/skills/lark-apps/references/lark-apps-access-scope-set.md +40 -0
- package/skills/lark-apps/references/lark-apps-cloud-dev.md +120 -0
- package/skills/lark-apps/references/lark-apps-create.md +40 -0
- package/skills/lark-apps/references/lark-apps-db-env-create.md +31 -0
- package/skills/lark-apps/references/lark-apps-db-execute.md +40 -0
- package/skills/lark-apps/references/lark-apps-db-table-get.md +29 -0
- package/skills/lark-apps/references/lark-apps-db-table-list.md +31 -0
- package/skills/lark-apps/references/lark-apps-env-pull.md +35 -0
- package/skills/lark-apps/references/lark-apps-git-credential.md +37 -0
- package/skills/lark-apps/references/lark-apps-html-publish.md +57 -0
- package/skills/lark-apps/references/lark-apps-init.md +37 -0
- package/skills/lark-apps/references/lark-apps-list.md +37 -0
- package/skills/lark-apps/references/lark-apps-local-dev.md +76 -0
- package/skills/lark-apps/references/lark-apps-release-create.md +30 -0
- package/skills/lark-apps/references/lark-apps-release-get.md +28 -0
- package/skills/lark-apps/references/lark-apps-release-list.md +31 -0
- package/skills/lark-apps/references/lark-apps-session-messages-list.md +53 -0
- package/skills/lark-apps/references/lark-apps-update.md +30 -0
- package/skills/lark-attendance/SKILL.md +57 -0
- package/skills/lark-base/SKILL.md +157 -0
- package/skills/lark-base/references/dashboard-block-data-config.md +350 -0
- package/skills/lark-base/references/formula-field-guide.md +737 -0
- package/skills/lark-base/references/lark-base-cell-value.md +153 -0
- package/skills/lark-base/references/lark-base-dashboard-block-get-data.md +717 -0
- package/skills/lark-base/references/lark-base-dashboard.md +238 -0
- package/skills/lark-base/references/lark-base-data-analysis-sop.md +210 -0
- package/skills/lark-base/references/lark-base-data-query-guide.md +61 -0
- package/skills/lark-base/references/lark-base-data-query.md +452 -0
- package/skills/lark-base/references/lark-base-field-create.md +103 -0
- package/skills/lark-base/references/lark-base-field-json.md +489 -0
- package/skills/lark-base/references/lark-base-field-update.md +171 -0
- package/skills/lark-base/references/lark-base-form-detail.md +71 -0
- package/skills/lark-base/references/lark-base-form-questions-create.md +118 -0
- package/skills/lark-base/references/lark-base-form-questions-update.md +92 -0
- package/skills/lark-base/references/lark-base-form-submit.md +170 -0
- package/skills/lark-base/references/lark-base-record-batch-create.md +57 -0
- package/skills/lark-base/references/lark-base-record-batch-update.md +52 -0
- package/skills/lark-base/references/lark-base-record-history-list.md +43 -0
- package/skills/lark-base/references/lark-base-record-upsert.md +63 -0
- package/skills/lark-base/references/lark-base-role-guide.md +65 -0
- package/skills/lark-base/references/lark-base-view-set-filter.md +189 -0
- package/skills/lark-base/references/lark-base-workflow-guide.md +830 -0
- package/skills/lark-base/references/lark-base-workflow-schema.md +1071 -0
- package/skills/lark-base/references/lookup-field-guide.md +512 -0
- package/skills/lark-base/references/role-config.md +549 -0
- package/skills/lark-calendar/SKILL.md +137 -0
- package/skills/lark-calendar/references/lark-calendar-agenda.md +78 -0
- package/skills/lark-calendar/references/lark-calendar-create.md +106 -0
- package/skills/lark-calendar/references/lark-calendar-freebusy.md +124 -0
- package/skills/lark-calendar/references/lark-calendar-meeting.md +40 -0
- package/skills/lark-calendar/references/lark-calendar-room-find.md +113 -0
- package/skills/lark-calendar/references/lark-calendar-rsvp.md +42 -0
- package/skills/lark-calendar/references/lark-calendar-schedule-meeting.md +265 -0
- package/skills/lark-calendar/references/lark-calendar-search-event.md +29 -0
- package/skills/lark-calendar/references/lark-calendar-suggestion.md +125 -0
- package/skills/lark-calendar/references/lark-calendar-update.md +105 -0
- package/skills/lark-contact/SKILL.md +59 -0
- package/skills/lark-contact/references/lark-contact-get-user.md +19 -0
- package/skills/lark-contact/references/lark-contact-search-user.md +124 -0
- package/skills/lark-doc/SKILL.md +79 -0
- package/skills/lark-doc/references/lark-doc-create.md +79 -0
- package/skills/lark-doc/references/lark-doc-fetch.md +138 -0
- package/skills/lark-doc/references/lark-doc-md.md +76 -0
- package/skills/lark-doc/references/lark-doc-media-download.md +50 -0
- package/skills/lark-doc/references/lark-doc-media-insert.md +114 -0
- package/skills/lark-doc/references/lark-doc-media-preview.md +41 -0
- package/skills/lark-doc/references/lark-doc-resource-cover.md +70 -0
- package/skills/lark-doc/references/lark-doc-update.md +259 -0
- package/skills/lark-doc/references/lark-doc-whiteboard.md +154 -0
- package/skills/lark-doc/references/lark-doc-xml.md +181 -0
- package/skills/lark-doc/references/style/lark-doc-create-workflow.md +59 -0
- package/skills/lark-doc/references/style/lark-doc-style.md +86 -0
- package/skills/lark-doc/references/style/lark-doc-update-workflow.md +55 -0
- package/skills/lark-drive/SKILL.md +215 -0
- package/skills/lark-drive/references/lark-drive-add-comment.md +193 -0
- package/skills/lark-drive/references/lark-drive-apply-permission.md +77 -0
- package/skills/lark-drive/references/lark-drive-comment-location.md +193 -0
- package/skills/lark-drive/references/lark-drive-comments-guide.md +72 -0
- package/skills/lark-drive/references/lark-drive-cover.md +79 -0
- package/skills/lark-drive/references/lark-drive-create-folder.md +73 -0
- package/skills/lark-drive/references/lark-drive-create-shortcut.md +103 -0
- package/skills/lark-drive/references/lark-drive-delete.md +79 -0
- package/skills/lark-drive/references/lark-drive-download.md +31 -0
- package/skills/lark-drive/references/lark-drive-export-download.md +50 -0
- package/skills/lark-drive/references/lark-drive-export.md +145 -0
- package/skills/lark-drive/references/lark-drive-files-list.md +158 -0
- package/skills/lark-drive/references/lark-drive-import.md +170 -0
- package/skills/lark-drive/references/lark-drive-inspect.md +50 -0
- package/skills/lark-drive/references/lark-drive-member-add.md +66 -0
- package/skills/lark-drive/references/lark-drive-move.md +120 -0
- package/skills/lark-drive/references/lark-drive-permission-guide.md +41 -0
- package/skills/lark-drive/references/lark-drive-preview.md +87 -0
- package/skills/lark-drive/references/lark-drive-pull.md +137 -0
- package/skills/lark-drive/references/lark-drive-push.md +162 -0
- package/skills/lark-drive/references/lark-drive-reactions.md +113 -0
- package/skills/lark-drive/references/lark-drive-search.md +269 -0
- package/skills/lark-drive/references/lark-drive-secure-label.md +52 -0
- package/skills/lark-drive/references/lark-drive-status.md +137 -0
- package/skills/lark-drive/references/lark-drive-task-result.md +302 -0
- package/skills/lark-drive/references/lark-drive-upload.md +101 -0
- package/skills/lark-drive/references/lark-drive-version-delete.md +38 -0
- package/skills/lark-drive/references/lark-drive-version-get.md +71 -0
- package/skills/lark-drive/references/lark-drive-version-history.md +73 -0
- package/skills/lark-drive/references/lark-drive-version-revert.md +35 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize-analysis.md +249 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize-discovery.md +253 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize-execution.md +200 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize-planning.md +336 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize-rollback.md +308 -0
- package/skills/lark-drive/references/lark-drive-workflow-knowledge-organize.md +226 -0
- package/skills/lark-drive/references/lark-drive-workflow-permission-governance-commands.md +168 -0
- package/skills/lark-drive/references/lark-drive-workflow-permission-governance-outputs.md +424 -0
- package/skills/lark-drive/references/lark-drive-workflow-permission-governance.md +207 -0
- package/skills/lark-drive/references/lark-drive-workflow.md +130 -0
- package/skills/lark-event/SKILL.md +154 -0
- package/skills/lark-event/references/lark-event-im.md +87 -0
- package/skills/lark-event/references/lark-event-minutes.md +54 -0
- package/skills/lark-event/references/lark-event-task.md +78 -0
- package/skills/lark-event/references/lark-event-vc.md +94 -0
- package/skills/lark-event/references/lark-event-whiteboard.md +67 -0
- package/skills/lark-im/SKILL.md +247 -0
- package/skills/lark-im/references/lark-im-card-action-reply.md +175 -0
- package/skills/lark-im/references/lark-im-chat-create.md +162 -0
- package/skills/lark-im/references/lark-im-chat-identity.md +55 -0
- package/skills/lark-im/references/lark-im-chat-list.md +166 -0
- package/skills/lark-im/references/lark-im-chat-messages-list.md +157 -0
- package/skills/lark-im/references/lark-im-chat-search.md +142 -0
- package/skills/lark-im/references/lark-im-chat-update.md +84 -0
- package/skills/lark-im/references/lark-im-feed-group-list-item.md +68 -0
- package/skills/lark-im/references/lark-im-feed-group-list.md +65 -0
- package/skills/lark-im/references/lark-im-feed-group-query-item.md +44 -0
- package/skills/lark-im/references/lark-im-feed-groups.md +452 -0
- package/skills/lark-im/references/lark-im-feed-shortcut-create.md +97 -0
- package/skills/lark-im/references/lark-im-feed-shortcut-list.md +103 -0
- package/skills/lark-im/references/lark-im-feed-shortcut-remove.md +48 -0
- package/skills/lark-im/references/lark-im-flag-cancel.md +67 -0
- package/skills/lark-im/references/lark-im-flag-create.md +67 -0
- package/skills/lark-im/references/lark-im-flag-list.md +100 -0
- package/skills/lark-im/references/lark-im-message-enrichment.md +54 -0
- package/skills/lark-im/references/lark-im-messages-mget.md +99 -0
- package/skills/lark-im/references/lark-im-messages-reply.md +267 -0
- package/skills/lark-im/references/lark-im-messages-resources-download.md +94 -0
- package/skills/lark-im/references/lark-im-messages-search.md +234 -0
- package/skills/lark-im/references/lark-im-messages-send.md +267 -0
- package/skills/lark-im/references/lark-im-reactions.md +299 -0
- package/skills/lark-im/references/lark-im-threads-messages-list.md +115 -0
- package/skills/lark-mail/SKILL.md +287 -0
- package/skills/lark-mail/assets/templates/job-application--resume.html +33 -0
- package/skills/lark-mail/assets/templates/newsletter--weekly-brief.html +50 -0
- package/skills/lark-mail/assets/templates/research--market-report.html +256 -0
- package/skills/lark-mail/assets/templates/weekly--personal-report.html +43 -0
- package/skills/lark-mail/assets/templates/weekly--team-report.html +9 -0
- package/skills/lark-mail/references/lark-mail-calendar-invite.md +36 -0
- package/skills/lark-mail/references/lark-mail-decline-receipt.md +115 -0
- package/skills/lark-mail/references/lark-mail-draft-create.md +127 -0
- package/skills/lark-mail/references/lark-mail-draft-edit.md +404 -0
- package/skills/lark-mail/references/lark-mail-forward.md +239 -0
- package/skills/lark-mail/references/lark-mail-html.md +333 -0
- package/skills/lark-mail/references/lark-mail-lint-html.md +243 -0
- package/skills/lark-mail/references/lark-mail-message.md +233 -0
- package/skills/lark-mail/references/lark-mail-messages.md +108 -0
- package/skills/lark-mail/references/lark-mail-recall.md +66 -0
- package/skills/lark-mail/references/lark-mail-recipient-search.md +59 -0
- package/skills/lark-mail/references/lark-mail-reply-all.md +213 -0
- package/skills/lark-mail/references/lark-mail-reply.md +249 -0
- package/skills/lark-mail/references/lark-mail-rules.md +31 -0
- package/skills/lark-mail/references/lark-mail-send-as.md +44 -0
- package/skills/lark-mail/references/lark-mail-send-receipt.md +120 -0
- package/skills/lark-mail/references/lark-mail-send-status.md +46 -0
- package/skills/lark-mail/references/lark-mail-send.md +222 -0
- package/skills/lark-mail/references/lark-mail-share-to-chat.md +87 -0
- package/skills/lark-mail/references/lark-mail-signature.md +98 -0
- package/skills/lark-mail/references/lark-mail-template-create.md +129 -0
- package/skills/lark-mail/references/lark-mail-template-update.md +150 -0
- package/skills/lark-mail/references/lark-mail-template.md +54 -0
- package/skills/lark-mail/references/lark-mail-thread.md +111 -0
- package/skills/lark-mail/references/lark-mail-triage.md +131 -0
- package/skills/lark-mail/references/lark-mail-watch.md +94 -0
- package/skills/lark-markdown/SKILL.md +69 -0
- package/skills/lark-markdown/references/lark-markdown-create.md +94 -0
- package/skills/lark-markdown/references/lark-markdown-diff.md +156 -0
- package/skills/lark-markdown/references/lark-markdown-fetch.md +79 -0
- package/skills/lark-markdown/references/lark-markdown-overwrite.md +85 -0
- package/skills/lark-markdown/references/lark-markdown-patch.md +160 -0
- package/skills/lark-minutes/SKILL.md +192 -0
- package/skills/lark-minutes/references/lark-minutes-detail.md +62 -0
- package/skills/lark-minutes/references/lark-minutes-download.md +137 -0
- package/skills/lark-minutes/references/lark-minutes-search.md +204 -0
- package/skills/lark-minutes/references/lark-minutes-speaker-replace.md +107 -0
- package/skills/lark-minutes/references/lark-minutes-summary.md +122 -0
- package/skills/lark-minutes/references/lark-minutes-todo.md +138 -0
- package/skills/lark-minutes/references/lark-minutes-update.md +41 -0
- package/skills/lark-minutes/references/lark-minutes-upload.md +104 -0
- package/skills/lark-note/SKILL.md +94 -0
- package/skills/lark-note/references/lark-note-detail.md +26 -0
- package/skills/lark-note/references/lark-note-transcript.md +23 -0
- package/skills/lark-okr/SKILL.md +115 -0
- package/skills/lark-okr/references/lark-okr-batch-create.md +106 -0
- package/skills/lark-okr/references/lark-okr-contentblock.md +359 -0
- package/skills/lark-okr/references/lark-okr-cycle-detail.md +84 -0
- package/skills/lark-okr/references/lark-okr-cycle-list.md +90 -0
- package/skills/lark-okr/references/lark-okr-entities.md +329 -0
- package/skills/lark-okr/references/lark-okr-image-upload.md +116 -0
- package/skills/lark-okr/references/lark-okr-indicator-update.md +80 -0
- package/skills/lark-okr/references/lark-okr-progress-create.md +81 -0
- package/skills/lark-okr/references/lark-okr-progress-delete.md +47 -0
- package/skills/lark-okr/references/lark-okr-progress-get.md +62 -0
- package/skills/lark-okr/references/lark-okr-progress-list.md +80 -0
- package/skills/lark-okr/references/lark-okr-progress-update.md +81 -0
- package/skills/lark-okr/references/lark-okr-reorder.md +81 -0
- package/skills/lark-okr/references/lark-okr-weight.md +96 -0
- package/skills/lark-openapi-explorer/SKILL.md +153 -0
- package/skills/lark-shared/SKILL.md +168 -0
- package/skills/lark-shared/references/lark-wiki-token-routing.md +42 -0
- package/skills/lark-sheets/SKILL.md +165 -0
- package/skills/lark-sheets/references/lark-sheets-batch-update.md +191 -0
- package/skills/lark-sheets/references/lark-sheets-chart.md +330 -0
- package/skills/lark-sheets/references/lark-sheets-conditional-format.md +179 -0
- package/skills/lark-sheets/references/lark-sheets-core-operations.md +103 -0
- package/skills/lark-sheets/references/lark-sheets-filter-view.md +137 -0
- package/skills/lark-sheets/references/lark-sheets-filter.md +130 -0
- package/skills/lark-sheets/references/lark-sheets-float-image.md +159 -0
- package/skills/lark-sheets/references/lark-sheets-formula-translation.md +267 -0
- package/skills/lark-sheets/references/lark-sheets-pivot-table.md +166 -0
- package/skills/lark-sheets/references/lark-sheets-range-operations.md +267 -0
- package/skills/lark-sheets/references/lark-sheets-read-data.md +235 -0
- package/skills/lark-sheets/references/lark-sheets-search-replace.md +111 -0
- package/skills/lark-sheets/references/lark-sheets-sheet-structure.md +212 -0
- package/skills/lark-sheets/references/lark-sheets-sparkline.md +149 -0
- package/skills/lark-sheets/references/lark-sheets-visual-standards.md +205 -0
- package/skills/lark-sheets/references/lark-sheets-workbook.md +395 -0
- package/skills/lark-sheets/references/lark-sheets-write-cells.md +565 -0
- package/skills/lark-sheets/scripts/sheets_df.py +32 -0
- package/skills/lark-skill-maker/SKILL.md +85 -0
- package/skills/lark-slides/SKILL.md +293 -0
- package/skills/lark-slides/assets/templates/administration--all_hands_meeting.xml +1999 -0
- package/skills/lark-slides/assets/templates/administration--annual_gala.xml +1160 -0
- package/skills/lark-slides/assets/templates/administration--company_intro.xml +1376 -0
- package/skills/lark-slides/assets/templates/administration--corporate_culture.xml +1765 -0
- package/skills/lark-slides/assets/templates/hr--employee_training.xml +912 -0
- package/skills/lark-slides/assets/templates/hr--employee_training_workshop.xml +1504 -0
- package/skills/lark-slides/assets/templates/hr--onboarding.xml +933 -0
- package/skills/lark-slides/assets/templates/marketing--brand_communication.xml +1367 -0
- package/skills/lark-slides/assets/templates/marketing--brand_logo_design.xml +1347 -0
- package/skills/lark-slides/assets/templates/marketing--brand_operations_plan.xml +1309 -0
- package/skills/lark-slides/assets/templates/marketing--business_plan.xml +1646 -0
- package/skills/lark-slides/assets/templates/marketing--marketing_plan.xml +1469 -0
- package/skills/lark-slides/assets/templates/marketing--marketing_strategy.xml +1484 -0
- package/skills/lark-slides/assets/templates/marketing--product_whitepaper.xml +1455 -0
- package/skills/lark-slides/assets/templates/marketing--roadshow_business_plan.xml +1506 -0
- package/skills/lark-slides/assets/templates/misc--book_sharing.xml +1338 -0
- package/skills/lark-slides/assets/templates/misc--club_event_plan.xml +4885 -0
- package/skills/lark-slides/assets/templates/misc--student_career_plan.xml +1854 -0
- package/skills/lark-slides/assets/templates/office--dark_general.xml +3763 -0
- package/skills/lark-slides/assets/templates/office--dept_annual_report.xml +1192 -0
- package/skills/lark-slides/assets/templates/office--light_general.xml +3378 -0
- package/skills/lark-slides/assets/templates/office--project_kickoff.xml +3152 -0
- package/skills/lark-slides/assets/templates/office--quarterly_review.xml +1253 -0
- package/skills/lark-slides/assets/templates/office--work_report.xml +1099 -0
- package/skills/lark-slides/assets/templates/office--work_summary.xml +4420 -0
- package/skills/lark-slides/assets/templates/office--work_summary_report.xml +1523 -0
- package/skills/lark-slides/assets/templates/operations--brand_logo_design.xml +1347 -0
- package/skills/lark-slides/assets/templates/operations--brand_operations_plan.xml +1309 -0
- package/skills/lark-slides/assets/templates/operations--marketing_plan.xml +1469 -0
- package/skills/lark-slides/assets/templates/operations--product_promotion.xml +687 -0
- package/skills/lark-slides/assets/templates/personal--experience_sharing.xml +2242 -0
- package/skills/lark-slides/assets/templates/personal--personal_resume.xml +2047 -0
- package/skills/lark-slides/assets/templates/personal--promotion_defense.xml +1099 -0
- package/skills/lark-slides/assets/templates/personal--promotion_report.xml +1039 -0
- package/skills/lark-slides/assets/templates/personal--self_intro.xml +696 -0
- package/skills/lark-slides/assets/templates/personal--teaching_sharing.xml +3013 -0
- package/skills/lark-slides/assets/templates/product--business_case_analysis.xml +1341 -0
- package/skills/lark-slides/assets/templates/product--market_analysis.xml +898 -0
- package/skills/lark-slides/assets/templates/product--product_analysis.xml +1537 -0
- package/skills/lark-slides/assets/templates/product--product_intro.xml +2838 -0
- package/skills/lark-slides/assets/templates/product--product_promotion.xml +687 -0
- package/skills/lark-slides/assets/templates/product--product_promotion_2.xml +687 -0
- package/skills/lark-slides/references/asset-planning.md +124 -0
- package/skills/lark-slides/references/examples.md +261 -0
- package/skills/lark-slides/references/iconpark-index.json +41901 -0
- package/skills/lark-slides/references/iconpark.md +46 -0
- package/skills/lark-slides/references/lark-slides-create.md +137 -0
- package/skills/lark-slides/references/lark-slides-edit-workflows.md +144 -0
- package/skills/lark-slides/references/lark-slides-media-upload.md +128 -0
- package/skills/lark-slides/references/lark-slides-replace-pages.md +95 -0
- package/skills/lark-slides/references/lark-slides-replace-slide.md +240 -0
- package/skills/lark-slides/references/lark-slides-screenshot.md +94 -0
- package/skills/lark-slides/references/lark-slides-whiteboard.md +330 -0
- package/skills/lark-slides/references/lark-slides-xml-presentation-slide-create.md +220 -0
- package/skills/lark-slides/references/lark-slides-xml-presentation-slide-delete.md +123 -0
- package/skills/lark-slides/references/lark-slides-xml-presentation-slide-get.md +110 -0
- package/skills/lark-slides/references/lark-slides-xml-presentation-slide-replace.md +187 -0
- package/skills/lark-slides/references/lark-slides-xml-presentations-get.md +98 -0
- package/skills/lark-slides/references/planning-layer.md +219 -0
- package/skills/lark-slides/references/slide-templates.md +201 -0
- package/skills/lark-slides/references/slides_demo.xml +226 -0
- package/skills/lark-slides/references/slides_xml_schema_definition.xml +3049 -0
- package/skills/lark-slides/references/template-catalog.md +463 -0
- package/skills/lark-slides/references/template-index.json +1853 -0
- package/skills/lark-slides/references/troubleshooting.md +63 -0
- package/skills/lark-slides/references/validation-checklist.md +110 -0
- package/skills/lark-slides/references/visual-planning.md +254 -0
- package/skills/lark-slides/references/xml-format-guide.md +369 -0
- package/skills/lark-slides/references/xml-schema-quick-ref.md +245 -0
- package/skills/lark-slides/scripts/iconpark_tool.py +362 -0
- package/skills/lark-slides/scripts/iconpark_tool_test.py +177 -0
- package/skills/lark-slides/scripts/template_tool.py +970 -0
- package/skills/lark-slides/scripts/template_tool_test.py +177 -0
- package/skills/lark-slides/scripts/xml_text_overlap_lint.py +367 -0
- package/skills/lark-slides/scripts/xml_text_overlap_lint_test.py +263 -0
- package/skills/lark-task/SKILL.md +167 -0
- package/skills/lark-task/references/lark-task-assign.md +38 -0
- package/skills/lark-task/references/lark-task-comment.md +28 -0
- package/skills/lark-task/references/lark-task-complete.md +27 -0
- package/skills/lark-task/references/lark-task-create.md +57 -0
- package/skills/lark-task/references/lark-task-followers.md +35 -0
- package/skills/lark-task/references/lark-task-get-my-tasks.md +61 -0
- package/skills/lark-task/references/lark-task-get-related-tasks.md +53 -0
- package/skills/lark-task/references/lark-task-reminder.md +36 -0
- package/skills/lark-task/references/lark-task-reopen.md +27 -0
- package/skills/lark-task/references/lark-task-search.md +41 -0
- package/skills/lark-task/references/lark-task-set-ancestor.md +32 -0
- package/skills/lark-task/references/lark-task-tasklist-create.md +35 -0
- package/skills/lark-task/references/lark-task-tasklist-members.md +36 -0
- package/skills/lark-task/references/lark-task-tasklist-search.md +38 -0
- package/skills/lark-task/references/lark-task-tasklist-task-add.md +38 -0
- package/skills/lark-task/references/lark-task-update.md +37 -0
- package/skills/lark-task/references/lark-task-upload-attachment.md +59 -0
- package/skills/lark-vc/SKILL.md +202 -0
- package/skills/lark-vc/references/lark-vc-detail.md +44 -0
- package/skills/lark-vc/references/lark-vc-recording.md +154 -0
- package/skills/lark-vc/references/lark-vc-search.md +163 -0
- package/skills/lark-vc/references/vc-domain-boundaries.md +188 -0
- package/skills/lark-vc-agent/SKILL.md +169 -0
- package/skills/lark-vc-agent/references/lark-vc-agent-meeting-events.md +287 -0
- package/skills/lark-vc-agent/references/lark-vc-agent-meeting-join.md +141 -0
- package/skills/lark-vc-agent/references/lark-vc-agent-meeting-leave.md +105 -0
- package/skills/lark-vc-agent/references/lark-vc-agent-meeting-list-active.md +91 -0
- package/skills/lark-whiteboard/SKILL.md +47 -0
- package/skills/lark-whiteboard/elements/connectors.md +102 -0
- package/skills/lark-whiteboard/elements/content.md +40 -0
- package/skills/lark-whiteboard/elements/image.md +80 -0
- package/skills/lark-whiteboard/elements/layout.md +374 -0
- package/skills/lark-whiteboard/elements/schema.md +357 -0
- package/skills/lark-whiteboard/elements/style.md +318 -0
- package/skills/lark-whiteboard/elements/typography.md +73 -0
- package/skills/lark-whiteboard/references/lark-whiteboard-query.md +60 -0
- package/skills/lark-whiteboard/references/lark-whiteboard-update.md +122 -0
- package/skills/lark-whiteboard/references/lark-whiteboard-workflow.md +94 -0
- package/skills/lark-whiteboard/routes/dsl.md +107 -0
- package/skills/lark-whiteboard/routes/mermaid.md +27 -0
- package/skills/lark-whiteboard/routes/svg-edit.md +85 -0
- package/skills/lark-whiteboard/routes/svg.md +54 -0
- package/skills/lark-whiteboard/scenes/architecture.md +433 -0
- package/skills/lark-whiteboard/scenes/bar-chart.md +187 -0
- package/skills/lark-whiteboard/scenes/comparison.md +135 -0
- package/skills/lark-whiteboard/scenes/fishbone.md +238 -0
- package/skills/lark-whiteboard/scenes/flowchart.md +185 -0
- package/skills/lark-whiteboard/scenes/flywheel.md +195 -0
- package/skills/lark-whiteboard/scenes/funnel.md +101 -0
- package/skills/lark-whiteboard/scenes/line-chart.md +214 -0
- package/skills/lark-whiteboard/scenes/mermaid.md +130 -0
- package/skills/lark-whiteboard/scenes/milestone.md +139 -0
- package/skills/lark-whiteboard/scenes/organization.md +173 -0
- package/skills/lark-whiteboard/scenes/photo-showcase.md +126 -0
- package/skills/lark-whiteboard/scenes/pyramid.md +99 -0
- package/skills/lark-whiteboard/scenes/swimlane.md +371 -0
- package/skills/lark-whiteboard/scenes/treemap.md +216 -0
- package/skills/lark-wiki/SKILL.md +110 -0
- package/skills/lark-wiki/references/lark-wiki-delete-space.md +205 -0
- package/skills/lark-wiki/references/lark-wiki-member-add.md +67 -0
- package/skills/lark-wiki/references/lark-wiki-member-list.md +76 -0
- package/skills/lark-wiki/references/lark-wiki-member-remove.md +61 -0
- package/skills/lark-wiki/references/lark-wiki-move.md +183 -0
- package/skills/lark-wiki/references/lark-wiki-node-copy.md +72 -0
- package/skills/lark-wiki/references/lark-wiki-node-create.md +127 -0
- package/skills/lark-wiki/references/lark-wiki-node-delete.md +62 -0
- package/skills/lark-wiki/references/lark-wiki-node-get.md +57 -0
- package/skills/lark-wiki/references/lark-wiki-node-list.md +88 -0
- package/skills/lark-wiki/references/lark-wiki-space-create.md +46 -0
- package/skills/lark-wiki/references/lark-wiki-space-list.md +68 -0
- package/skills/lark-workflow-meeting-summary/SKILL.md +122 -0
- package/skills/lark-workflow-standup-report/SKILL.md +122 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# okr +cycle-list
|
|
2
|
+
|
|
3
|
+
> **前置条件:** 先阅读 [`lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
|
4
|
+
|
|
5
|
+
列出指定用户的 OKR 周期,支持可选的时间范围过滤。
|
|
6
|
+
|
|
7
|
+
## 推荐命令
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# 列出用户的所有周期
|
|
11
|
+
lark-cli okr +cycle-list --user-id "ou_xxx"
|
|
12
|
+
|
|
13
|
+
# 使用特定的用户 ID 类型列出周期
|
|
14
|
+
lark-cli okr +cycle-list --user-id "xxx" --user-id-type user_id
|
|
15
|
+
|
|
16
|
+
# 列出时间范围内的周期(例如 2025-01 到 2025-06)
|
|
17
|
+
lark-cli okr +cycle-list --user-id "ou_xxx" --time-range "2025-01--2025-06"
|
|
18
|
+
|
|
19
|
+
# 预览 API 调用而不实际执行
|
|
20
|
+
lark-cli okr +cycle-list --user-id "ou_xxx" --dry-run
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 参数
|
|
24
|
+
|
|
25
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
26
|
+
|------------------|----|-----------|------------------------------------------------------------------|
|
|
27
|
+
| `--user-id` | 是 | — | OKR 所有者的用户 ID |
|
|
28
|
+
| `--user-id-type` | 否 | `open_id` | 用户 ID 类型:`open_id` \| `union_id` \| `user_id` |
|
|
29
|
+
| `--time-range` | 否 | — | 按时间范围过滤周期。格式:`YYYY-MM--YYYY-MM`(例如 `2025-01--2025-06`)。留空获取所有周期。 |
|
|
30
|
+
| `--dry-run` | 否 | — | 预览 API 调用而不实际执行。 |
|
|
31
|
+
| `--format` | 否 | `json` | 输出格式。 |
|
|
32
|
+
|
|
33
|
+
## 工作流程
|
|
34
|
+
|
|
35
|
+
1. 获取目标用户的 `open_id`(或其他 ID 类型)。如果用户说"我的 OKR 周期",先通过 `lark-cli contact +get-user` 获取当前用户的
|
|
36
|
+
ID。
|
|
37
|
+
2. 执行 `lark-cli okr +cycle-list --user-id "ou_xxx"`,可选择使用 `--time-range`。
|
|
38
|
+
3. 报告结果:找到的周期数量、每个周期的 ID、开始/结束时间和状态。
|
|
39
|
+
|
|
40
|
+
## 输出
|
|
41
|
+
|
|
42
|
+
返回 JSON:
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"cycles": [
|
|
47
|
+
{
|
|
48
|
+
"id": "1234567890123456789",
|
|
49
|
+
"create_time": "2025-01-01 00:00:00",
|
|
50
|
+
"update_time": "2025-01-01 00:00:00",
|
|
51
|
+
"tenant_cycle_id": "789",
|
|
52
|
+
"owner": {
|
|
53
|
+
"owner_type": "user",
|
|
54
|
+
"user_id": "ou_xxx"
|
|
55
|
+
},
|
|
56
|
+
"start_time": "2025-01-01 00:00:00",
|
|
57
|
+
"end_time": "2025-06-30 00:00:00",
|
|
58
|
+
"cycle_status": "normal",
|
|
59
|
+
"score": 0
|
|
60
|
+
}
|
|
61
|
+
],
|
|
62
|
+
"total": 1
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
在这个周期信息中,这些字段值得关注:
|
|
67
|
+
|
|
68
|
+
- `id` 是这个周期的 ID,你通常需要用它在之后使用 `okr +cycle-detail` 获取 OKR 内容详情
|
|
69
|
+
- `start_time` `end_time` 是周期的起止时间,总是从某个月1日开始,直到此月或之后某月的最后一日结束。
|
|
70
|
+
- 在 OKR 系统中,我们只关注这个时间的年月部分,如 “2025-01-01开始,2025-06-30结束” 的周期被称作 “2025 年 1-6 月” 周期,而
|
|
71
|
+
“2025-01-01开始,2025-01-31结束” 的周期被称作 “2025 年 1 月”周期。
|
|
72
|
+
- 如果一个周期从某年1月1日开始,某年12月31日结束,则它是这一年的年度周期,如 “2025-01-01开始,2025-12-31结束” 的周期就是
|
|
73
|
+
“2025 年” 的年度周期
|
|
74
|
+
- `cycle_status` 为周期状态值,参见下文。
|
|
75
|
+
|
|
76
|
+
### 周期状态值
|
|
77
|
+
|
|
78
|
+
| 值 | 说明 |
|
|
79
|
+
|-----------|----------|
|
|
80
|
+
| `default` | 默认状态 (0) |
|
|
81
|
+
| `normal` | 生效 (1) |
|
|
82
|
+
| `invalid` | 失效 (2) |
|
|
83
|
+
| `hidden` | 隐藏 (3) |
|
|
84
|
+
|
|
85
|
+
在 OKR 系统中,default/normal 状态下的周期当前正常生效,invalid 状态下的周期已失效但通常仍然可以填写,hidden 状态下的周期隐藏不可见。
|
|
86
|
+
|
|
87
|
+
## 参考
|
|
88
|
+
|
|
89
|
+
- [lark-okr](../SKILL.md) -- 所有 OKR 命令
|
|
90
|
+
- [lark-shared](../../lark-shared/SKILL.md) -- 认证和全局参数
|
|
@@ -0,0 +1,329 @@
|
|
|
1
|
+
# OKR 实体定义
|
|
2
|
+
|
|
3
|
+
本文档描述飞书 OKR API (`/open-apis/okr/v2`) 中涉及的核心实体及其字段定义。
|
|
4
|
+
|
|
5
|
+
## 实体关系概览
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Cycle (用户周期)
|
|
9
|
+
└── Objective (目标)
|
|
10
|
+
├── KeyResult (关键结果)
|
|
11
|
+
│ └── Indicator (指标)
|
|
12
|
+
│ └── list<Progress> (进展记录列表)
|
|
13
|
+
└── Indicator (指标)
|
|
14
|
+
└── list<Progress> (进展记录列表)
|
|
15
|
+
|
|
16
|
+
Alignment (对齐关系): Objective ↔ Objective
|
|
17
|
+
Category (分类): Objective 的分组标签
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Owner (所有者)
|
|
23
|
+
|
|
24
|
+
所有者标识 OKR 实体的归属,目前仅支持用户类型。
|
|
25
|
+
|
|
26
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
27
|
+
|--------------|----------|----|-----------------------------------------------|
|
|
28
|
+
| `owner_type` | `string` | 是 | 所有者类型,通常为 `"user"`。 |
|
|
29
|
+
| `user_id` | `string` | 否 | 员工 ID,类型由请求参数 `user_id_type` 决定(默认 `open_id`) |
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Cycle (用户周期)
|
|
34
|
+
|
|
35
|
+
用户周期是 OKR 的顶层容器,代表一个时间段内的所有目标与关键结果。
|
|
36
|
+
|
|
37
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
38
|
+
|-------------------|-----------|----|--------------------------------------------|
|
|
39
|
+
| `id` | `string` | 是 | 用户周期 ID |
|
|
40
|
+
| `create_time` | `string` | 是 | 创建时间 |
|
|
41
|
+
| `update_time` | `string` | 是 | 更新时间 |
|
|
42
|
+
| `tenant_cycle_id` | `string` | 是 | 租户周期 ID(同一周期在不同用户下有不同的用户周期 ID,但租户周期 ID 相同) |
|
|
43
|
+
| `owner` | `Owner` | 是 | 所有者 |
|
|
44
|
+
| `start_time` | `string` | 是 | 周期开始时间。总是从某月1日开始 |
|
|
45
|
+
| `end_time` | `string` | 是 | 周期结束时间。到某月最后一日结束 |
|
|
46
|
+
| `cycle_status` | `integer` | 否 | 周期状态,见下表 |
|
|
47
|
+
| `score` | `number` | 否 | 周期分数,范围 [0, 1],支持一位小数 |
|
|
48
|
+
|
|
49
|
+
### 常用术语
|
|
50
|
+
|
|
51
|
+
- **当前周期**: 指周期的 start_time/end_time
|
|
52
|
+
指周期的 start_time / end_time 所在的时间段与当前时间重叠的周期(即: start_time <= 当前时间 且 end_time >= 当前时间)。 注意:时间重叠是判断当前周期的首要且必须的硬性条件,绝对不能仅仅根据 cycle_status == 1 去判断。 如果有多个符合时间重叠标准的周期,再在这些包含当前时间的周期中过滤,保留周期状态为 default (0) 或 normal (1) 的周期。如果仍然有多个,则选择其中较新的一个。当用户提及“上一个周期”,“下一个周期”一类的表述时,通常是以当前周期为准计算。
|
|
53
|
+
- **所有者**: 绝大多数所有者都是用户,少部分租户启用了“团队OKR”功能,所有者可能是部门。用户身份下,只能编辑所有者为当前用户的
|
|
54
|
+
OKR。
|
|
55
|
+
|
|
56
|
+
### 周期状态 (cycle_status)
|
|
57
|
+
|
|
58
|
+
| 值 | 常量名 | 说明 |
|
|
59
|
+
|---|-----------|-------------|
|
|
60
|
+
| 0 | `default` | 默认状态 |
|
|
61
|
+
| 1 | `normal` | 生效中 |
|
|
62
|
+
| 2 | `invalid` | 已失效(通常仍可填写) |
|
|
63
|
+
| 3 | `hidden` | 已隐藏(不可见) |
|
|
64
|
+
|
|
65
|
+
> **SHORTCUT:** `okr +cycle-list` [lark-okr-cycle-list.md](lark-okr-cycle-list.md) 获取用户的周期列表,可按时间筛选
|
|
66
|
+
>
|
|
67
|
+
> **API:** `cycles.list`
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Objective (目标)
|
|
72
|
+
|
|
73
|
+
目标是 OKR 中的 "O",属于某个用户周期,可包含多个关键结果。
|
|
74
|
+
|
|
75
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
76
|
+
|---------------|----------------|----|---------------------------------------------------------|
|
|
77
|
+
| `id` | `string` | 是 | 目标 ID |
|
|
78
|
+
| `create_time` | `string` | 是 | 创建时间,毫秒时间戳,shortcut 会将其解析为日期时间 |
|
|
79
|
+
| `update_time` | `string` | 是 | 更新时间,毫秒时间戳,shortcut 会将其解析为日期时间 |
|
|
80
|
+
| `owner` | `Owner` | 是 | 所有者 |
|
|
81
|
+
| `cycle_id` | `string` | 是 | 所属用户周期 ID |
|
|
82
|
+
| `position` | `integer` | 是 | 排序序号,从 1 开始,范围 [1, 100] |
|
|
83
|
+
| `content` | `ContentBlock` | 否 | 目标内容(富文本),见 [ContentBlock 定义](lark-okr-contentblock.md) |
|
|
84
|
+
| `score` | `number` | 否 | 目标分数,范围 [0, 1],支持一位小数 |
|
|
85
|
+
| `notes` | `ContentBlock` | 否 | 目标备注(富文本),见 [ContentBlock 定义](lark-okr-contentblock.md) |
|
|
86
|
+
| `weight` | `number` | 否 | 目标权重,范围 [0, 1],支持三位小数 |
|
|
87
|
+
| `deadline` | `string` | 否 | 截止时间,毫秒时间戳,shortcut 会将其解析为日期时间 |
|
|
88
|
+
| `category_id` | `string` | 否 | 所属分类 ID |
|
|
89
|
+
|
|
90
|
+
> **SHORTCUT:**
|
|
91
|
+
> - `okr +cycle-detail` [lark-okr-cycle-detail.md](lark-okr-cycle-detail.md) 获取某个用户周期下的全部目标和关键结果。时间相关的字段会以日期时间格式解析
|
|
92
|
+
>
|
|
93
|
+
> **API:**
|
|
94
|
+
> - `cycle.objectives.list` — 获取周期下的目标列表
|
|
95
|
+
> - `objectives.get` — 获取单个目标
|
|
96
|
+
> - `cycle.objectives.create` — 创建目标
|
|
97
|
+
> - `objectives.delete` — 删除目标
|
|
98
|
+
> - `cycles.objectives_position` — 更新周期下的目标排序
|
|
99
|
+
> - `cycles.objectives_weight` — 更新周期下的目标权重
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## KeyResult (关键结果)
|
|
104
|
+
|
|
105
|
+
关键结果是 OKR 中的 "KR",属于某个目标,描述目标的可衡量成果。
|
|
106
|
+
|
|
107
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
108
|
+
|----------------|----------------|----|-----------------------------------------------------------|
|
|
109
|
+
| `id` | `string` | 是 | 关键结果 ID |
|
|
110
|
+
| `create_time` | `string` | 是 | 创建时间,毫秒时间戳 |
|
|
111
|
+
| `update_time` | `string` | 是 | 修改时间,毫秒时间戳 |
|
|
112
|
+
| `owner` | `Owner` | 是 | 所有者 |
|
|
113
|
+
| `objective_id` | `string` | 是 | 所属目标 ID |
|
|
114
|
+
| `position` | `integer` | 是 | 排序序号,从 1 开始,范围 [1, 100] |
|
|
115
|
+
| `content` | `ContentBlock` | 否 | 关键结果内容(富文本),见 [ContentBlock 定义](lark-okr-contentblock.md) |
|
|
116
|
+
| `score` | `number` | 否 | 关键结果分数,范围 [0, 1],支持一位小数 |
|
|
117
|
+
| `weight` | `number` | 否 | 权重,范围 [0, 1],支持三位小数 |
|
|
118
|
+
| `deadline` | `string` | 否 | 截止时间,毫秒时间戳 |
|
|
119
|
+
|
|
120
|
+
> **API:**
|
|
121
|
+
> - `objective.key_results.list` — 获取目标下的关键结果列表
|
|
122
|
+
> - `key_results.get` — 获取单个关键结果
|
|
123
|
+
> - `key_results.patch` — 更新关键结果
|
|
124
|
+
> - `key_results.delete` — 删除关键结果
|
|
125
|
+
> - `objectives.key_results_position` — 更新目标下的关键结果排序
|
|
126
|
+
> - `objectives.key_results_weight` — 更新目标下的关键结果权重
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Progress (进展记录)
|
|
131
|
+
|
|
132
|
+
进展记录挂载在目标(Objective)或关键结果(Key Result)上,用于记录阶段性进展内容与进度百分比。每条进展记录包含富文本内容和可选的进度率。
|
|
133
|
+
|
|
134
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
135
|
+
|-----------------|----------------|----|---------------------------------------------------------|
|
|
136
|
+
| `progress_id` | `string` | 是 | 进展记录 ID(int64,正整数) |
|
|
137
|
+
| `modify_time` | `string` | 是 | 最后修改时间,毫秒时间戳,shortcut 会将其解析为日期时间 |
|
|
138
|
+
| `content` | `ContentBlock` | 否 | 进展内容(富文本),见 [ContentBlock 定义](lark-okr-contentblock.md) |
|
|
139
|
+
| `progress_rate` | `ProgressRate` | 否 | 进度率,包含百分比和状态 |
|
|
140
|
+
|
|
141
|
+
### ProgressRate (进度率)
|
|
142
|
+
|
|
143
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
144
|
+
|-----------|----------|----|------------------------------------------------------------------------------------------------------------------------------|
|
|
145
|
+
| `percent` | `number` | 否 | 进度百分比,范围 [-99999999999, 99999999999]。百分比的取值通常在 0-100,但允许超过此范围,以表示超额完成或负增长等情况。挂载的目标或关键结果的量化指标不使用百分比单位时,以这个字段更新当前值。系统内最多保留两位小数 |
|
|
146
|
+
| `status` | `string` | 否 | 进度状态,shortcut 返回可读字符串,见下表 |
|
|
147
|
+
|
|
148
|
+
### 进度状态 (progress_rate.status)
|
|
149
|
+
|
|
150
|
+
| 值 | 常量名 | 说明 |
|
|
151
|
+
|-----------|-----|-------|
|
|
152
|
+
| `normal` | 正常 | 进展正常 |
|
|
153
|
+
| `overdue` | 逾期 | 进展逾期 |
|
|
154
|
+
| `done` | 已完成 | 进展已完成 |
|
|
155
|
+
|
|
156
|
+
### 创建进展记录时的参数
|
|
157
|
+
|
|
158
|
+
创建进展记录时,除了 `content` 外,还需要指定这条进展记录挂载的对应目标或关键结果:
|
|
159
|
+
|
|
160
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
161
|
+
|-----------------|----------------|----|---------------------------------------------------------|
|
|
162
|
+
| `content` | `ContentBlock` | 是 | 进展内容(富文本),见 [ContentBlock 定义](lark-okr-contentblock.md) |
|
|
163
|
+
| `target_id` | `string` | 是 | 目标 ID 或关键结果 ID |
|
|
164
|
+
| `target_type` | `integer` | 是 | 目标类型:`2`=目标(Objective),`3`=关键结果(KeyResult) |
|
|
165
|
+
| `progress_rate` | `ProgressRate` | 否 | 进度率,可设置 `percent` 和 `status` |
|
|
166
|
+
| `source_title` | `string` | 否 | 来源标题,用于在 OKR 界面中显示进展来源 |
|
|
167
|
+
| `source_url` | `string` | 否 | 来源 URL,用于在 OKR 界面中显示进展来源链接 |
|
|
168
|
+
|
|
169
|
+
> **SHORTCUT:**
|
|
170
|
+
> - `okr +progress-get` [lark-okr-progress-get.md](lark-okr-progress-get.md) 获取单条进展记录
|
|
171
|
+
> - `okr +progress-create` [lark-okr-progress-create.md](lark-okr-progress-create.md) 为目标或关键结果创建进展记录
|
|
172
|
+
> - `okr +progress-update` [lark-okr-progress-update.md](lark-okr-progress-update.md) 更新进展记录内容
|
|
173
|
+
> - `okr +progress-delete` [lark-okr-progress-delete.md](lark-okr-progress-delete.md) 删除进展记录
|
|
174
|
+
> - `okr +progress-list` [lark-okr-progress-list.md](lark-okr-progress-list.md) 获取目标/关键结果下的进展记录
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Indicator (指标)
|
|
178
|
+
|
|
179
|
+
指标是目标和关键结果的量化度量,可独立挂载在 Objective 或 KeyResult 上。
|
|
180
|
+
|
|
181
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
182
|
+
|--------------------------------|-----------------|----|------------------------------------|
|
|
183
|
+
| `id` | `string` | 是 | 指标 ID |
|
|
184
|
+
| `create_time` | `string` | 是 | 创建时间,毫秒时间戳 |
|
|
185
|
+
| `update_time` | `string` | 是 | 更新时间,毫秒时间戳 |
|
|
186
|
+
| `owner` | `Owner` | 是 | 所有者 |
|
|
187
|
+
| `entity_type` | `integer` | 是 | 所属实体类型:`2`=目标,`3`=关键结果 |
|
|
188
|
+
| `entity_id` | `string` | 是 | 所属实体 ID |
|
|
189
|
+
| `indicator_status` | `integer` | 是 | 指标状态,见下表 |
|
|
190
|
+
| `status_calculate_type` | `integer` | 是 | 状态计算方式,见下表 |
|
|
191
|
+
| `start_value` | `number` | 否 | 起始值,范围 [-99999999999, 99999999999] |
|
|
192
|
+
| `target_value` | `number` | 否 | 目标值,范围 [-99999999999, 99999999999] |
|
|
193
|
+
| `current_value` | `number` | 否 | 当前值,范围 [-99999999999, 99999999999] |
|
|
194
|
+
| `current_value_calculate_type` | `integer` | 否 | 当前值计算方式,见下表 |
|
|
195
|
+
| `unit` | `IndicatorUnit` | 否 | 指标单位 |
|
|
196
|
+
|
|
197
|
+
### 修改指南
|
|
198
|
+
|
|
199
|
+
- **进度值**: 一般指 `current_value`,单位未提及时通常用百分制计算。
|
|
200
|
+
- 当用户要求量化的更新 OKR 进度时,一般指的就是修改对应 OKR 的 Indicator。
|
|
201
|
+
- OKR 在未设置量化指标时,Indicator 的内容为空。如果用户未做特别说明,更新进度时可以默认将进度以百分制设置(初始值0,目标值100,unit
|
|
202
|
+
参见下文设置为 0/PERCENT)
|
|
203
|
+
|
|
204
|
+
### 指标状态 (indicator_status)
|
|
205
|
+
|
|
206
|
+
| 值 | 说明 |
|
|
207
|
+
|----|-----|
|
|
208
|
+
| -1 | 未定义 |
|
|
209
|
+
| 0 | 正常 |
|
|
210
|
+
| 1 | 有风险 |
|
|
211
|
+
| 2 | 已延期 |
|
|
212
|
+
|
|
213
|
+
### 状态计算方式 (status_calculate_type)
|
|
214
|
+
|
|
215
|
+
| 值 | 说明 | 适用范围 |
|
|
216
|
+
|---|-----------------|---------|
|
|
217
|
+
| 0 | 手动更新 | 目标、关键结果 |
|
|
218
|
+
| 1 | 基于进度和当前时间自动更新 | 目标、关键结果 |
|
|
219
|
+
| 2 | 基于风险最高的关键结果状态更新 | 仅目标 |
|
|
220
|
+
|
|
221
|
+
### 当前值计算方式 (current_value_calculate_type)
|
|
222
|
+
|
|
223
|
+
| 值 | 说明 | 适用范围 |
|
|
224
|
+
|---|---------------|---------|
|
|
225
|
+
| 0 | 手动更新 | 目标、关键结果 |
|
|
226
|
+
| 1 | 基于关键结果进度自动更新 | 仅目标 |
|
|
227
|
+
| 2 | 基于拆解的关键结果进度更新 | 仅关键结果 |
|
|
228
|
+
|
|
229
|
+
### IndicatorUnit (指标单位)
|
|
230
|
+
|
|
231
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
232
|
+
|--------------|-----------|----|-----------------------------------------------------------------------------|
|
|
233
|
+
| `unit_type` | `integer` | 是 | 单位类型:`0`=公共,`1`=自定义 |
|
|
234
|
+
| `unit_value` | `string` | 是 | 单位值。公共类型可选:`PERCENT`(百分比)、`NONE`(无单位)、`YUAN`(元)、`DOLLAR`(美元);自定义类型字符长度不超过 5 |
|
|
235
|
+
|
|
236
|
+
> **API:**
|
|
237
|
+
> - `key_result.indicators.list` — 获取关键结果的指标
|
|
238
|
+
> - `objective.indicators.list` — 获取目标的指标
|
|
239
|
+
> - `indicators.patch` — 更新指标
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## Alignment (对齐关系)
|
|
244
|
+
|
|
245
|
+
对齐关系描述两个目标之间的上下对齐。
|
|
246
|
+
|
|
247
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
248
|
+
|--------------------|-----------|----|-----------------------|
|
|
249
|
+
| `id` | `string` | 是 | 对齐 ID |
|
|
250
|
+
| `create_time` | `string` | 是 | 创建时间,毫秒时间戳 |
|
|
251
|
+
| `update_time` | `string` | 是 | 更新时间,毫秒时间戳 |
|
|
252
|
+
| `from_owner` | `Owner` | 是 | 发起对齐的所有者 |
|
|
253
|
+
| `to_owner` | `Owner` | 是 | 被对齐的所有者 |
|
|
254
|
+
| `from_entity_type` | `integer` | 是 | 发起对齐的实体类型,固定为 `2`(目标) |
|
|
255
|
+
| `from_entity_id` | `string` | 是 | 发起对齐的实体 ID |
|
|
256
|
+
| `to_entity_type` | `integer` | 是 | 被对齐的实体类型,固定为 `2`(目标) |
|
|
257
|
+
| `to_entity_id` | `string` | 是 | 被对齐的实体 ID |
|
|
258
|
+
|
|
259
|
+
> **API:**
|
|
260
|
+
> - `alignments.get` — 获取对齐关系
|
|
261
|
+
> - `alignments.delete` — 删除对齐关系
|
|
262
|
+
> - `objective.alignments.list` — 批量获取目标下的对齐关系
|
|
263
|
+
> - `objective.alignments.create` — 创建对齐关系
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## Category (分类)
|
|
268
|
+
|
|
269
|
+
分类用于对目标进行分组标记(如"个人 OKR"、"团队 OKR"、"承诺 OKR")等。具体的分类根据租户设置而定。
|
|
270
|
+
|
|
271
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
272
|
+
|-----------------|----------------|----|-------------------------------------------------------------|
|
|
273
|
+
| `id` | `string` | 是 | 分类 ID |
|
|
274
|
+
| `create_time` | `string` | 是 | 创建时间,毫秒时间戳 |
|
|
275
|
+
| `update_time` | `string` | 是 | 更新时间,毫秒时间戳 |
|
|
276
|
+
| `category_type` | `string` | 是 | 分类类型:`"person"`=个人,`"team"`=团队 |
|
|
277
|
+
| `enabled` | `boolean` | 是 | 是否启用 |
|
|
278
|
+
| `color` | `string` | 是 | 颜色标识:`blue`、`purple`、`wathet`、`turquoise`、`indigo`、`orange` |
|
|
279
|
+
| `name` | `CategoryName` | 是 | 多语言名称 |
|
|
280
|
+
|
|
281
|
+
### CategoryName (分类名称)
|
|
282
|
+
|
|
283
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
284
|
+
|------|----------|----|-----|
|
|
285
|
+
| `zh` | `string` | 否 | 中文名 |
|
|
286
|
+
| `en` | `string` | 否 | 英文名 |
|
|
287
|
+
| `ja` | `string` | 否 | 日文名 |
|
|
288
|
+
|
|
289
|
+
> **API:** `categories.list` — 批量获取租户设置的分类列表
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## 通用请求参数
|
|
294
|
+
|
|
295
|
+
以下参数在多数 OKR API 中通用:
|
|
296
|
+
|
|
297
|
+
| 参数 | 位置 | 必填 | 默认值 | 说明 |
|
|
298
|
+
|----------------------|---------|----|------------------------|--------------------------------------------------|
|
|
299
|
+
| `user_id_type` | `query` | 否 | `"open_id"` | 用户 ID 类型:`open_id` \| `union_id` \| `user_id` |
|
|
300
|
+
| `department_id_type` | `query` | 否 | `"open_department_id"` | 部门 ID 类型:`open_department_id` \| `department_id` |
|
|
301
|
+
| `page_size` | `query` | 否 | `10` | 分页大小,最大 100 |
|
|
302
|
+
| `page_token` | `query` | 否 | `""` | 分页键,首页传空串 |
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
## 权限 Scope 说明
|
|
307
|
+
|
|
308
|
+
| Scope | 权限类型 | 说明 |
|
|
309
|
+
|--------------------------------|------|--------------|
|
|
310
|
+
| `okr:okr.content:readonly` | 读 | 读取 OKR 内容 |
|
|
311
|
+
| `okr:okr.content:writeonly` | 写 | 写入/删除 OKR 内容 |
|
|
312
|
+
| `okr:okr.period:readonly` | 读 | 读取 OKR 周期 |
|
|
313
|
+
| `okr:okr.progress:readonly` | 读 | 读取进展记录 |
|
|
314
|
+
| `okr:okr.progress:writeonly` | 写 | 创建/更新进展记录 |
|
|
315
|
+
| `okr:okr.progress:delete` | 写 | 删除进展记录 |
|
|
316
|
+
| `okr:okr.progress.file:upload` | 写 | 上传进展记录图片附件 |
|
|
317
|
+
| `okr:okr.setting:read` | 读 | 读取 OKR 设置 |
|
|
318
|
+
|
|
319
|
+
所有 OKR API 均支持 `user` 和 `tenant`(应用)两种 access token 类型。
|
|
320
|
+
|
|
321
|
+
## 参考
|
|
322
|
+
|
|
323
|
+
- [OKR ContentBlock 富文本格式](lark-okr-contentblock.md) — content/notes 字段的富文本结构定义
|
|
324
|
+
- [okr +cycle-list](lark-okr-cycle-list.md) — 列出用户 OKR 周期
|
|
325
|
+
- [okr +cycle-detail](lark-okr-cycle-detail.md) — 获取周期下的目标与关键结果
|
|
326
|
+
- [okr +progress-get](lark-okr-progress-get.md) — 获取进展记录
|
|
327
|
+
- [okr +progress-create](lark-okr-progress-create.md) — 创建进展记录
|
|
328
|
+
- [okr +progress-update](lark-okr-progress-update.md) — 更新进展记录
|
|
329
|
+
- [okr +progress-delete](lark-okr-progress-delete.md) — 删除进展记录
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# okr +upload-image
|
|
2
|
+
|
|
3
|
+
> **前置条件:** 先阅读 [`lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
|
4
|
+
|
|
5
|
+
上传本地图片,用于 OKR 进展记录的富文本内容。
|
|
6
|
+
|
|
7
|
+
## 推荐命令
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# 上传图片用于目标的进展记录
|
|
11
|
+
lark-cli okr +upload-image \
|
|
12
|
+
--file ./progress_screenshot.png \
|
|
13
|
+
--target-id 1234567890123456789 \
|
|
14
|
+
--target-type objective
|
|
15
|
+
|
|
16
|
+
# 上传图片用于关键结果的进展记录
|
|
17
|
+
lark-cli okr +upload-image \
|
|
18
|
+
--file ./chart.jpg \
|
|
19
|
+
--target-id 9876543210987654321 \
|
|
20
|
+
--target-type key_result
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 参数
|
|
24
|
+
|
|
25
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
26
|
+
|-----------------|----|-----|---------------------------------------|
|
|
27
|
+
| `--file` | 是 | — | 本地图片路径。**必须使用相对路径**(如 `./photo.png`)。 |
|
|
28
|
+
| `--target-id` | 是 | — | 目标 ID 或关键结果 ID(int64 类型,正整数) |
|
|
29
|
+
| `--target-type` | 是 | — | 目标类型:`objective` \| `key_result` |
|
|
30
|
+
| `--dry-run` | 否 | — | 预览 API 调用而不实际执行。 |
|
|
31
|
+
|
|
32
|
+
## 工作流程
|
|
33
|
+
|
|
34
|
+
1. 使用 `+cycle-list` 和 `+cycle-detail` 获取目标或关键结果的 ID。
|
|
35
|
+
2. 准备本地图片文件,确保格式受支持。
|
|
36
|
+
3. 执行 `lark-cli okr +upload-image --file ./image.png --target-id "..." --target-type objective`。
|
|
37
|
+
4. 获取返回的 `file_token`,用于构建 ContentBlock 中的图片内容。
|
|
38
|
+
|
|
39
|
+
## 输出
|
|
40
|
+
|
|
41
|
+
返回 JSON:
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"file_token": "example-file-token",
|
|
46
|
+
"url": "https://example.larksuite.com/download?file_token=example-file-token",
|
|
47
|
+
"file_name": "screenshot.png",
|
|
48
|
+
"size": 102400
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
其中:
|
|
53
|
+
|
|
54
|
+
- `file_token` — 用于在 ContentBlock 的 `ContentGallery` 中引用图片
|
|
55
|
+
- `url` — 图片的访问 URL
|
|
56
|
+
- `file_name` — 上传的文件名
|
|
57
|
+
- `size` — 文件大小(字节)
|
|
58
|
+
|
|
59
|
+
## 在进展记录中使用上传的图片
|
|
60
|
+
|
|
61
|
+
上传图片后,将返回的 `file_token` 用于构建 ContentBlock 的图库块:
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"blocks": [
|
|
66
|
+
{
|
|
67
|
+
"block_element_type": "paragraph",
|
|
68
|
+
"paragraph": {
|
|
69
|
+
"elements": [
|
|
70
|
+
{
|
|
71
|
+
"paragraph_element_type": "textRun",
|
|
72
|
+
"text_run": {
|
|
73
|
+
"text": "本周进展截图:"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
]
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"block_element_type": "gallery",
|
|
81
|
+
"gallery": {
|
|
82
|
+
"images": [
|
|
83
|
+
{
|
|
84
|
+
"file_token": "example-file-token",
|
|
85
|
+
"width": 800,
|
|
86
|
+
"height": 600
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
然后在创建或更新进展记录时使用此 ContentBlock:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
lark-cli okr +progress-create \
|
|
99
|
+
--content @content_with_image.json \
|
|
100
|
+
--target-id 1234567890123456789 \
|
|
101
|
+
--target-type objective
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## 安全限制
|
|
105
|
+
|
|
106
|
+
- `--file` 参数**必须使用相对路径**(如 `./photo.png` 或 `images/photo.png`),不支持绝对路径
|
|
107
|
+
- 图片文件必须存在于当前工作目录或其子目录中
|
|
108
|
+
- 不支持符号链接指向目录外的文件
|
|
109
|
+
|
|
110
|
+
## 参考
|
|
111
|
+
|
|
112
|
+
- [lark-okr](../SKILL.md) -- 所有 OKR 命令(shortcut 和 API 接口)
|
|
113
|
+
- [ContentBlock 格式](lark-okr-contentblock.md) -- 进展内容使用的富文本格式,包含图片块的使用说明
|
|
114
|
+
- [lark-okr-progress-create](lark-okr-progress-create.md) -- 创建进展记录
|
|
115
|
+
- [lark-okr-progress-update](lark-okr-progress-update.md) -- 更新进展记录
|
|
116
|
+
- [lark-shared](../../lark-shared/SKILL.md) -- 认证和全局参数
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# okr +indicator-update
|
|
2
|
+
|
|
3
|
+
> **前置条件:** 先阅读 [`lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
|
4
|
+
|
|
5
|
+
直接更新目标(Objective)或关键结果(Key Result)的指标当前值,无需手动查询指标 ID。
|
|
6
|
+
|
|
7
|
+
> **查询指标:** 如需查看指标详情,请使用原生 API:
|
|
8
|
+
> - 目标指标:`lark-cli okr objective.indicators list --objective-id <id>`
|
|
9
|
+
> - KR 指标:`lark-cli okr key_result.indicators list --key-result-id <id>`
|
|
10
|
+
|
|
11
|
+
## 推荐命令
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# 更新 Objective 的指标值
|
|
15
|
+
lark-cli okr +indicator-update \
|
|
16
|
+
--level objective \
|
|
17
|
+
--id 7000000000000000001 \
|
|
18
|
+
--value 75.5 \
|
|
19
|
+
--as user
|
|
20
|
+
|
|
21
|
+
# 更新 Key Result 的指标值
|
|
22
|
+
lark-cli okr +indicator-update \
|
|
23
|
+
--level key-result \
|
|
24
|
+
--id 7000000000000000002 \
|
|
25
|
+
--value 100 \
|
|
26
|
+
--as user
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## 参数
|
|
30
|
+
|
|
31
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
32
|
+
|------------|----|--------|--------------------------------------------------------------------|
|
|
33
|
+
| `--level` | 是 | — | 操作层级:`objective`(更新目标指标)\| `key-result`(更新 KR 指标) |
|
|
34
|
+
| `--id` | 是 | — | 目标 ID 或 KR ID(int64 类型) |
|
|
35
|
+
| `--value` | 是 | — | 新的指标当前值(数字,范围:-99999999999 到 99999999999) |
|
|
36
|
+
| `--dry-run`| 否 | — | 预览 API 调用而不实际执行 |
|
|
37
|
+
| `--format` | 否 | `json` | 输出格式 |
|
|
38
|
+
|
|
39
|
+
## 工作流程
|
|
40
|
+
|
|
41
|
+
1. 使用 `+cycle-list` 和 `+cycle-detail` 获取目标 ID 或 KR ID。
|
|
42
|
+
2. 如需查看当前指标值,使用 `objective.indicators list` 或 `key_result.indicators list` 查询。
|
|
43
|
+
3. 执行 `+indicator-update` 指定层级、ID 和新值。
|
|
44
|
+
4. 命令自动查询指标 ID 并更新当前值。
|
|
45
|
+
|
|
46
|
+
## 输出
|
|
47
|
+
|
|
48
|
+
### JSON 格式
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"ok": true,
|
|
53
|
+
"data": {
|
|
54
|
+
"indicator_id": "7000000000000000003",
|
|
55
|
+
"current_value": 75.5,
|
|
56
|
+
"level": "objective",
|
|
57
|
+
"target_id": "7000000000000000001"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 字段说明
|
|
63
|
+
|
|
64
|
+
| 字段 | 类型 | 说明 |
|
|
65
|
+
|----------------|--------|------------------------|
|
|
66
|
+
| `indicator_id` | string | 被更新的指标 ID |
|
|
67
|
+
| `current_value`| number | 更新后的指标当前值 |
|
|
68
|
+
| `level` | string | 操作层级:`objective` / `key-result` |
|
|
69
|
+
| `target_id` | string | 目标或 KR 的 ID |
|
|
70
|
+
|
|
71
|
+
## 注意事项
|
|
72
|
+
- 仅更新 `current_value` 字段,`unit`、`start_value`、`target_value` 等其他字段保持不变
|
|
73
|
+
- 若需要这些字段进行修改,使用原生接口 indicators.patch
|
|
74
|
+
- 指标的 `current_value_calculate_type` 必须为「手动更新」才能通过此命令修改。
|
|
75
|
+
|
|
76
|
+
## 参考
|
|
77
|
+
|
|
78
|
+
- [OKR 指标更新 API](https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=patch&project=okr&resource=okr.indicator&version=v2)
|
|
79
|
+
- [`lark-okr-progress-create.md`](./lark-okr-progress-create.md) — 创建进度记录
|
|
80
|
+
- [`lark-okr-cycle-detail.md`](./lark-okr-cycle-detail.md) — 查询周期详情获取 ID
|