mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
7e7f716a82
* feat(base): add base block shortcuts * fix(base): use block scopes for base block shortcuts * fix(base): split base block shortcut scopes * docs(base): consolidate base block help * docs(base): simplify block help wording * test(base): cover base block shortcut execution * feat(base): filter base block list by type * docs(base): clarify base block ids * docs(base): simplify docx block help * docs(base): refine base block agent help
44 lines
2.0 KiB
Go
44 lines
2.0 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package base
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/larksuite/cli/shortcuts/common"
|
|
)
|
|
|
|
var BaseBaseBlockList = common.Shortcut{
|
|
Service: "base",
|
|
Command: "+base-block-list",
|
|
Description: "List blocks in a base",
|
|
Risk: "read",
|
|
Scopes: []string{"base:block:read"},
|
|
AuthTypes: authTypes(),
|
|
Flags: []common.Flag{
|
|
baseTokenFlag(true),
|
|
{Name: "type", Desc: "filter by resource type", Enum: baseBlockTypeEnums},
|
|
{Name: "parent-id", Desc: "folder block id; when omitted, list all blocks"},
|
|
},
|
|
Tips: []string{
|
|
"Example: lark-cli base +base-block-list --base-token <base_token>",
|
|
"Example: lark-cli base +base-block-list --base-token <base_token> --type table",
|
|
"Example: lark-cli base +base-block-list --base-token <base_token> --parent-id <folder_block_id>",
|
|
`JQ crop: lark-cli base +base-block-list --base-token <base_token> | jq '.blocks[] | {type, name, block_id: .id, parent_id}'`,
|
|
`JQ crop docx: lark-cli base +base-block-list --base-token <base_token> --type docx | jq '.blocks[] | {name, docx_token}'`,
|
|
"Blocks are resources managed directly by the base, such as folder, table, docx, dashboard, and workflow.",
|
|
"For table, dashboard, and workflow blocks, returned id is the table-id, dashboard-id, or workflow-id used by the corresponding commands.",
|
|
"For docx blocks, use the returned docx_token with docx commands.",
|
|
"For folder blocks, pass the returned id as --parent-id when creating, listing, or moving blocks inside that folder.",
|
|
"This command returns the full backend list. It intentionally does not expose limit or offset.",
|
|
"Pass --type to list only one resource type.",
|
|
"Pass --parent-id to list only direct children of a folder.",
|
|
"Dashboard blocks are chart/widget blocks inside a dashboard; use +dashboard-block-* for those.",
|
|
},
|
|
DryRun: dryRunBaseBlockList,
|
|
Execute: func(ctx context.Context, runtime *common.RuntimeContext) error {
|
|
return executeBaseBlockList(runtime)
|
|
},
|
|
}
|