@lark-project/meegle 0.0.13 → 0.0.15

package/LICENSE

@@ -1,11 +1,21 @@
-Copyright (c) 2023 Lark Technologies Pte. Ltd.
+MIT License
 
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+Copyright (c) 2026 Lark Technologies Pte. Ltd.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
-INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
-EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
-CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
-DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
-ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,393 +1,436 @@
 # Meegle CLI
 
-> **DEV** — 当前处于开发预览阶段，API 和命令可能发生变更。
+> **DEV** — Currently in developer preview. APIs and commands may change.
 
-飞书项目（Meegle）命令行工具。在终端中管理工作项、查看排期、搜索数据，无需打开浏览器。
+Command-line tool for [Meegle](https://meegle.com?utm_source=github&utm_medium=readme&utm_campaign=meegle_cli) ([Lark Project](https://project.feishu.cn?utm_source=github&utm_medium=readme&utm_campaign=meegle_cli)). Manage work items, schedules, and data from your terminal — no browser needed.
 
-## 安装
+## Installation
 
 ```bash
 npm install -g @lark-project/meegle
 ```
 
-要求 Node.js >= 18。
+Requires Node.js >= 16.
 
-## 快速开始
+## Quick Start
 
 ```bash
-# 1. 登录
+# 1. Log in
 meegle auth login
 
-# 2. 查看本周待办
+# 2. View this week's to-dos
 meegle mywork todo --action this_week --page-num 1
 
-# 3. 查看帮助
+# 3. View help
 meegle --help
 meegle workitem --help
 
-# 4. 查看命令参数详情
+# 4. Inspect command parameters
 meegle inspect workitem.create
 ```
 
-## 命令一览
+## Commands
 
-### workitem — 工作项域
+### workitem — Work Items
 
-| 命令 | 说明 |
-|------|------|
-| `workitem create` | 创建工作项 |
-| `workitem get` | 查看工作项概况 |
-| `workitem update` | 修改工作项字段 |
-| `workitem query` | 使用 MQL 搜索工作项 |
-| `workitem list-op-records` | 查看操作记录 |
-| `workitem meta-types` | 查看工作项类型列表 |
-| `workitem meta-create-fields` | 查看创建时可用字段 |
-| `workitem meta-fields` | 查看字段配置 |
-| `workitem meta-roles` | 查看角色配置 |
+| Command | Description |
+|---------|-------------|
+| `workitem create` | Create a work item |
+| `workitem get` | View work item details |
+| `workitem update` | Update work item fields |
+| `workitem query` | Search work items using MQL |
+| `workitem list-op-records` | View operation records |
+| `workitem meta-types` | List work item types |
+| `workitem meta-create-fields` | List fields available at creation |
+| `workitem meta-fields` | List field configurations |
+| `workitem meta-roles` | List role configurations |
 
-### workflow — 工作流域
+### workflow — Workflow
 
-| 命令 | 说明 |
-|------|------|
-| `workflow transition` | 流转或回滚节点 |
-| `workflow get-node` | 查看节点详情 |
-| `workflow update-node` | 修改节点 |
-| `workflow meta-node-fields` | 查看节点字段配置 |
-| `workflow list-state-transitions` | 查看可流转状态 |
-| `workflow list-state-required` | 查看流转必填信息 |
+| Command | Description |
+|---------|-------------|
+| `workflow transition` | Transition or rollback a node |
+| `workflow transition-state` | Transition a state-flow state |
+| `workflow get-node` | View node details |
+| `workflow update-node` | Update a node |
+| `workflow meta-node-fields` | List node field configurations |
+| `workflow list-state-transitions` | List available state transitions |
+| `workflow list-state-required` | List required fields for transitions |
 
-### subtask — 子任务
+### subtask — Subtasks
 
-| 命令 | 说明 |
-|------|------|
-| `subtask update` | 创建/修改/完成/回滚子任务 |
+| Command | Description |
+|---------|-------------|
+| `subtask update` | Create / update / complete / rollback subtasks |
 
-### comment — 评论域
+### comment — Comments
 
-| 命令 | 说明 |
-|------|------|
-| `comment add` | 添加评论 |
-| `comment list` | 查看评论列表 |
+| Command | Description |
+|---------|-------------|
+| `comment add` | Add a comment |
+| `comment list` | List comments |
 
-### workhour — 工时域
+### workhour — Work Hours
 
-| 命令 | 说明 |
-|------|------|
-| `workhour list-records` | 查看工时登记记录 |
-| `workhour list-schedule` | 查看人员排期 |
+| Command | Description |
+|---------|-------------|
+| `workhour list-records` | List work hour records |
+| `workhour list-schedule` | View team member schedules |
 
-### relation — 关系域
+### relation — Relations
 
-| 命令 | 说明 |
-|------|------|
-| `relation list` | 查看关联的工作项 |
-| `relation meta-definitions` | 查看关联关系定义 |
+| Command | Description |
+|---------|-------------|
+| `relation list` | List related work items |
+| `relation meta-definitions` | List relation type definitions |
 
-### mywork — 工作台域
+### mywork — My Work
 
-| 命令 | 说明 |
-|------|------|
-| `mywork todo` | 查看我的待办/已办 |
+| Command | Description |
+|---------|-------------|
+| `mywork todo` | View my to-dos / completed items |
 
-### view — 视图域
+### view — Views
 
-| 命令 | 说明 |
-|------|------|
-| `view create-fixed` | 创建固定视图 |
-| `view get` | 查看视图详情 |
-| `view update-fixed` | 更新固定视图 |
-| `view search` | 按名称搜索视图 |
+| Command | Description |
+|---------|-------------|
+| `view create-fixed` | Create a fixed view |
+| `view get` | View details of a view |
+| `view update-fixed` | Update a fixed view |
+| `view search` | Search views by name |
 
-### chart — 度量域
+### chart — Charts
 
-| 命令 | 说明 |
-|------|------|
-| `chart get` | 查看图表详情 |
-| `chart list` | 查看视图下的图表列表 |
+| Command | Description |
+|---------|-------------|
+| `chart get` | View chart details |
+| `chart list` | List charts under a view |
 
-### team / user — 人员域
+### team / user — People
 
-| 命令 | 说明 |
-|------|------|
-| `team list` | 查看空间下的团队列表 |
-| `team list-members` | 查看团队成员 |
-| `user search` | 搜索用户信息 |
+| Command | Description |
+|---------|-------------|
+| `team list` | List teams in a project |
+| `team list-members` | List team members |
+| `user me` | View current logged-in user information |
+| `user search` | Search user information |
 
-### project — 空间域
+### project — Projects
 
-| 命令 | 说明 |
-|------|------|
-| `project search` | 搜索空间信息 |
+| Command | Description |
+|---------|-------------|
+| `project search` | Search projects |
 
-### 其他命令
+### auth — Authentication
 
-| 命令 | 说明 |
-|------|------|
-| `inspect [command]` | 查看命令参数详情 |
+| Command | Description |
+|---------|-------------|
+| `auth login` | Log in (browser or `--device-code`) |
+| `auth logout` | Log out |
+| `auth status` | View login status |
 
-## 常用示例
+### config — Configuration
 
-### 查看待办
+| Command | Description |
+|---------|-------------|
+| `config init` | Initialize configuration |
+| `config show` | Show current configuration |
+| `config set` | Set a configuration value |
+| `config get` | Get a configuration value |
+| `config profile create\|list\|use\|current\|delete` | Manage configuration profiles |
+
+### Other Commands
+
+| Command | Description |
+|---------|-------------|
+| `inspect [command]` | Inspect command parameters |
+| `completion bash\|zsh\|fish` | Generate shell completion script |
+| `completion install` | Auto-install shell completion |
+
+## Common Examples
+
+### To-dos
 
 ```bash
-# 本周待办
+# This week's to-dos
 meegle mywork todo --action this_week --page-num 1
 
-# 已办事项
+# Completed items
 meegle mywork todo --action done --page-num 1
 
-# 逾期事项
+# Overdue items
 meegle mywork todo --action overdue --page-num 1
 ```
 
-### 查询工作项
+### Querying Work Items
 
 ```bash
-# 查看工作项概况
+# View work item details
 meegle workitem get --work-item-id 12345
 
-# 查看工作项的节点详情
+# View workflow node details
 meegle workflow get-node --work-item-id 12345 --need-sub-task
 ```
 
-### 创建工作项
+### Creating Work Items
 
 ```bash
-# 使用 --set 设置字段
+# Use --set to set fields
 meegle workitem create --project-key PROJ --work-item-type story \
-  --set name=优化登录流程 \
+  --set name="Optimize login flow" \
   --set priority=P1
 
-# 复杂字段传 JSON 值
+# Pass JSON values for complex fields
 meegle workitem create --project-key PROJ --work-item-type story \
-  --set name=排期任务 \
+  --set name="Scheduled task" \
   --set schedule='[1722182400000,1722355199999]'
 ```
 
-### 修改字段
+### Updating Fields
 
 ```bash
-# 修改工作项名称
+# Update work item name
 meegle workitem update --work-item-id 12345 \
-  --set name=新标题
+  --set name="New title"
 
-# 同时修改多个字段
+# Update multiple fields at once
 meegle workitem update --work-item-id 12345 \
-  --set name=新标题 \
+  --set name="New title" \
   --set priority=P0
 ```
 
-### MQL 搜索
+### MQL Search
 
 ```bash
-# 查询空间下的 P0 需求
+# Query P0 stories in a project
 meegle workitem query --project-key PROJ \
-  --mql "SELECT \`name\`, \`priority\` FROM \`空间名\`.\`需求\` WHERE \`priority\` = 'P0'"
+  --mql "SELECT \`name\`, \`priority\` FROM \`ProjectName\`.\`Story\` WHERE \`priority\` = 'P0'"
 ```
 
-### 查看排期
+### Viewing Schedules
 
 ```bash
-# 查看团队成员排期
+# View team member schedules
 meegle workhour list-schedule --project-key PROJ \
   --start-time 2026-03-01 --end-time 2026-03-31 \
-  --user-keys "张三,李四,王五"
+  --user-keys "Alice,Bob,Charlie"
 ```
 
-### 查看用户信息
+### Searching Users
 
 ```bash
-meegle user search --user-keys "张三,李四" --project-key PROJ
+meegle user search --user-keys "Alice,Bob" --project-key PROJ
 ```
 
-## 参数传递
+## Parameter Passing
 
-### 基本 flag
+### Basic Flags
 
-每个命令的参数通过 `--flag-name` 传递：
+Each command takes parameters via `--flag-name`:
 
 ```bash
 meegle workitem get --work-item-id 12345 --project-key PROJ
 ```
 
-### --set key=value（写入命令）
+### --set key=value (Write Commands)
 
-`workitem create`、`workitem update`、`workflow update-node`、`subtask update` 支持 `--set` 简便设置字段：
+`workitem create`, `workitem update`, `workflow update-node`, and `subtask update` support `--set` for convenient field assignment:
 
 ```bash
---set name=标题              # 字符串
---set points=5               # 数字
---set is_urgent=true         # 布尔
---set schedule='[1,2]'       # JSON 数组
---set role='{"role":"RD"}'   # JSON 对象
+--set name="Title"              # String
+--set points=5                  # Number
+--set is_urgent=true            # Boolean
+--set schedule='[1,2]'          # JSON array
+--set role='{"role":"RD"}'      # JSON object
 ```
 
-`--set` 可重复使用，一次设置多个字段。
+`--set` can be repeated to set multiple fields at once.
 
-### --params JSON（兜底）
+### --params JSON (Fallback)
 
-所有命令都支持 `--params` 传入完整 JSON 参数：
+All commands support `--params` to pass a full JSON parameter body:
 
 ```bash
 meegle workitem create --project-key PROJ --work-item-type story \
-  --params '{"fields":[{"field_key":"name","field_value":"标题"}]}'
+  --params '{"fields":[{"field_key":"name","field_value":"Title"}]}'
 ```
 
-### 优先级
+### Priority
 
-当 `--set`、`--params` 和普通 flag 同时使用时：
+When `--set`, `--params`, and regular flags are used together:
 
-1. `--set` 覆盖 `--params` 中同名字段
-2. 普通 flag（如 `--project-key`）覆盖 `--params` 中同名顶层 key
+1. `--set` overrides fields with the same name in `--params`
+2. Regular flags (e.g. `--project-key`) override top-level keys in `--params`
 
-### 数组参数
+### Array Parameters
 
-多个值用逗号分隔：
+Separate multiple values with commas:
 
 ```bash
---user-keys "张三,李四,王五"
+--user-keys "Alice,Bob,Charlie"
 --field-keys "name,status,priority"
 ```
 
-### 布尔参数
+### Boolean Parameters
 
-直接加 flag 即为 true，不加即为 false：
+Add the flag to set `true`; omit it for `false`:
 
 ```bash
 meegle workflow get-node --work-item-id 12345 --need-sub-task
 ```
 
-## 输出格式
+## Global Flags
+
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--format` | `-o` | Output format: `json` (default), `table`, `ndjson`, `yaml`, `markdown`, `raw` |
+| `--select` | | Field projection with dot paths |
+| `--set` | | Set nested parameters (repeatable) |
+| `--params` | `-P` | Full JSON parameter body |
+| `--dry-run` | | Render request without executing |
+| `--verbose` | `-v` | Verbose output |
+| `--profile` | | Use a specific configuration profile |
+
+## Output Formats
 
 ```bash
-# JSON（默认）
+# JSON (default)
 meegle workitem get --work-item-id 12345
 
-# 选取输出属性（支持 dot path）
+# Select output properties (supports dot paths)
 meegle workitem get --work-item-id 12345 --select "id,name,status"
 meegle mywork todo --action done --page-num 1 --select "list.work_item_info.work_item_name"
 
-# NDJSON（适合管道处理）
-meegle mywork todo --action this_week --page-num 1 --format ndjson
+# NDJSON (suitable for piping)
+meegle mywork todo --action this_week --page-num 1 -o ndjson
+
+# Table
+meegle mywork todo --action this_week --page-num 1 -o table
+
+# YAML
+meegle workitem get --work-item-id 12345 -o yaml
+
+# Markdown table
+meegle mywork todo --action this_week --page-num 1 -o markdown
 
-# 表格
-meegle mywork todo --action this_week --page-num 1 --format table
+# Dry run (preview request without sending)
+meegle workitem create --project-key PROJ --work-item-type story --set name="Test" --dry-run
 ```
 
-### --select dot path
+### --select Dot Paths
 
-`--select` 支持用 `.` 访问嵌套属性，遇到数组时自动穿透：
+`--select` supports `.` notation for nested properties, automatically traversing arrays:
 
 ```bash
-# 从嵌套结构中提取字段
+# Extract fields from nested structures
 --select "list.work_item_info.work_item_name,list.state_info.end_state_key_name"
 
-# 混合顶层和嵌套
+# Mix top-level and nested
 --select "total,list.work_item_info.work_item_name"
 ```
 
-## 命令内省
+## Command Introspection
 
-使用 `inspect` 查看命令的完整参数信息：
+Use `inspect` to view full parameter information for a command:
 
 ```bash
-# 列出所有命令
+# List all commands
 meegle inspect
 
-# 查看特定命令的参数详情
+# View parameters for a specific command
 meegle inspect workitem.create
 ```
 
-## 认证
+## Authentication
 
-### 浏览器登录（默认）
+### Browser Login (Default)
 
 ```bash
 meegle auth login
 ```
 
-自动打开浏览器完成 OAuth 授权。如果浏览器未打开，终端会显示授权地址，手动复制即可。
+Automatically opens the browser for OAuth authorization. If the browser doesn't open, the terminal displays the authorization URL for manual copying.
 
-### Device Code 登录（无浏览器环境）
+### Device Code Login (No Browser)
 
 ```bash
 meegle auth login --device-code
 ```
 
-终端显示二维码和授权码，使用手机扫码授权。适用于 SSH 远程服务器等无浏览器环境。
+The terminal displays a QR code and authorization code. Scan with your phone to authorize. Ideal for SSH remote servers and other headless environments.
 
-### 其他认证命令
+### Other Auth Commands
 
 ```bash
-# 查看登录状态
+# Check login status
 meegle auth status
 
-# 登出
+# Log out
 meegle auth logout
 ```
 
-## 配置
+## Configuration
 
-### 配置文件
+### Config File
 
-配置存储在 `~/.meegle/config.json`：
+Configuration is stored in `~/.meegle/config.json`:
 
 ```bash
-# 初始化配置
+# Initialize config
 meegle config init
 
-# 查看当前配置
+# View current config
 meegle config show
 
-# 修改单个配置项
+# Set a config value
 meegle config set host project.feishu.cn
 
-# 查看单个配置项
+# Get a config value
 meegle config get host
 ```
 
-主要配置项：
+Main config options:
 
-| 字段 | 说明 | 示例 |
-|------|------|------|
-| `host` | 站点域名 | `project.feishu.cn`、`meegle.com` |
+| Field | Description | Examples |
+|-------|-------------|----------|
+| `host` | Site domain | `project.feishu.cn`, `meegle.com` |
 
-### 多环境 Profile
+### Multi-Environment Profiles
 
-支持管理多个环境配置（不同站点、不同账号），每个 profile 独立存储 host 和认证信息。
+Manage multiple environment configurations (different sites, different accounts). Each profile stores its own host and auth credentials independently.
 
 ```bash
-# 创建新环境（交互式引导 host 选择 + 登录）
+# Create a new profile (interactive host selection + login)
 meegle config profile create staging
 
-# 查看所有环境
+# List all profiles
 meegle config profile list
 
-# 切换默认环境
+# Switch default profile
 meegle config profile use staging
 
-# 查看当前环境
+# View current profile
 meegle config profile current
 
-# 临时使用其他环境（不改变默认）
+# Temporarily use another profile (without changing default)
 meegle mywork todo --action this_week --page-num 1 --profile staging
 
-# 删除环境
+# Delete a profile
 meegle config profile delete staging
 ```
 
-## 常见问题
+## FAQ
 
-### 命令列表为空
+### Empty Command List
 
-CLI 启动时会从服务端获取可用命令列表。如果网络不通或未登录，动态命令不会注册。请先确保已登录：
+The CLI fetches available commands from the server at startup. If the network is unreachable or you're not logged in, dynamic commands won't be registered. Make sure you're logged in first:
 
 ```bash
 meegle auth login
 ```
 
-命令列表会自动缓存，过期后在后台静默刷新，不影响使用。
+The command list is cached automatically and refreshed silently in the background when expired.
 
 ## License
 
-[ISC](LICENSE) © Lark Technologies Pte. Ltd.
+MIT © Lark Technologies Pte. Ltd.

package/README.zh-CN.md

@@ -0,0 +1,436 @@
+# Meegle CLI
+
+> **DEV** — 当前处于开发预览阶段，API 和命令可能发生变更。
+
+飞书项目（[Meegle](https://meegle.com?utm_source=github&utm_medium=readme&utm_campaign=meegle_cli) / [Lark Project](https://project.feishu.cn?utm_source=github&utm_medium=readme&utm_campaign=meegle_cli)）命令行工具。在终端中管理工作项、查看排期、搜索数据，无需打开浏览器。
+
+## 安装
+
+```bash
+npm install -g @lark-project/meegle
+```
+
+要求 Node.js >= 16。
+
+## 快速开始
+
+```bash
+# 1. 登录
+meegle auth login
+
+# 2. 查看本周待办
+meegle mywork todo --action this_week --page-num 1
+
+# 3. 查看帮助
+meegle --help
+meegle workitem --help
+
+# 4. 查看命令参数详情
+meegle inspect workitem.create
+```
+
+## 命令一览
+
+### workitem — 工作项域
+
+| 命令 | 说明 |
+|------|------|
+| `workitem create` | 创建工作项 |
+| `workitem get` | 查看工作项概况 |
+| `workitem update` | 修改工作项字段 |
+| `workitem query` | 使用 MQL 搜索工作项 |
+| `workitem list-op-records` | 查看操作记录 |
+| `workitem meta-types` | 查看工作项类型列表 |
+| `workitem meta-create-fields` | 查看创建时可用字段 |
+| `workitem meta-fields` | 查看字段配置 |
+| `workitem meta-roles` | 查看角色配置 |
+
+### workflow — 工作流域
+
+| 命令 | 说明 |
+|------|------|
+| `workflow transition` | 流转或回滚节点 |
+| `workflow transition-state` | 流转状态流状态 |
+| `workflow get-node` | 查看节点详情 |
+| `workflow update-node` | 修改节点 |
+| `workflow meta-node-fields` | 查看节点字段配置 |
+| `workflow list-state-transitions` | 查看可流转状态 |
+| `workflow list-state-required` | 查看流转必填信息 |
+
+### subtask — 子任务
+
+| 命令 | 说明 |
+|------|------|
+| `subtask update` | 创建/修改/完成/回滚子任务 |
+
+### comment — 评论域
+
+| 命令 | 说明 |
+|------|------|
+| `comment add` | 添加评论 |
+| `comment list` | 查看评论列表 |
+
+### workhour — 工时域
+
+| 命令 | 说明 |
+|------|------|
+| `workhour list-records` | 查看工时登记记录 |
+| `workhour list-schedule` | 查看人员排期 |
+
+### relation — 关系域
+
+| 命令 | 说明 |
+|------|------|
+| `relation list` | 查看关联的工作项 |
+| `relation meta-definitions` | 查看关联关系定义 |
+
+### mywork — 工作台域
+
+| 命令 | 说明 |
+|------|------|
+| `mywork todo` | 查看我的待办/已办 |
+
+### view — 视图域
+
+| 命令 | 说明 |
+|------|------|
+| `view create-fixed` | 创建固定视图 |
+| `view get` | 查看视图详情 |
+| `view update-fixed` | 更新固定视图 |
+| `view search` | 按名称搜索视图 |
+
+### chart — 度量域
+
+| 命令 | 说明 |
+|------|------|
+| `chart get` | 查看图表详情 |
+| `chart list` | 查看视图下的图表列表 |
+
+### team / user — 人员域
+
+| 命令 | 说明 |
+|------|------|
+| `team list` | 查看空间下的团队列表 |
+| `team list-members` | 查看团队成员 |
+| `user me` | 查看当前登录用户信息 |
+| `user search` | 搜索用户信息 |
+
+### project — 空间域
+
+| 命令 | 说明 |
+|------|------|
+| `project search` | 搜索空间信息 |
+
+### auth — 认证域
+
+| 命令 | 说明 |
+|------|------|
+| `auth login` | 登录（浏览器或 `--device-code`） |
+| `auth logout` | 登出 |
+| `auth status` | 查看登录状态 |
+
+### config — 配置域
+
+| 命令 | 说明 |
+|------|------|
+| `config init` | 初始化配置 |
+| `config show` | 查看当前配置 |
+| `config set` | 设置配置项 |
+| `config get` | 读取配置项 |
+| `config profile create\|list\|use\|current\|delete` | 管理多环境 profile |
+
+### 其他命令
+
+| 命令 | 说明 |
+|------|------|
+| `inspect [command]` | 查看命令参数详情 |
+| `completion bash\|zsh\|fish` | 生成 Shell 补全脚本 |
+| `completion install` | 自动安装 Shell 补全 |
+
+## 常用示例
+
+### 查看待办
+
+```bash
+# 本周待办
+meegle mywork todo --action this_week --page-num 1
+
+# 已办事项
+meegle mywork todo --action done --page-num 1
+
+# 逾期事项
+meegle mywork todo --action overdue --page-num 1
+```
+
+### 查询工作项
+
+```bash
+# 查看工作项概况
+meegle workitem get --work-item-id 12345
+
+# 查看工作项的节点详情
+meegle workflow get-node --work-item-id 12345 --need-sub-task
+```
+
+### 创建工作项
+
+```bash
+# 使用 --set 设置字段
+meegle workitem create --project-key PROJ --work-item-type story \
+  --set name=优化登录流程 \
+  --set priority=P1
+
+# 复杂字段传 JSON 值
+meegle workitem create --project-key PROJ --work-item-type story \
+  --set name=排期任务 \
+  --set schedule='[1722182400000,1722355199999]'
+```
+
+### 修改字段
+
+```bash
+# 修改工作项名称
+meegle workitem update --work-item-id 12345 \
+  --set name=新标题
+
+# 同时修改多个字段
+meegle workitem update --work-item-id 12345 \
+  --set name=新标题 \
+  --set priority=P0
+```
+
+### MQL 搜索
+
+```bash
+# 查询空间下的 P0 需求
+meegle workitem query --project-key PROJ \
+  --mql "SELECT \`name\`, \`priority\` FROM \`空间名\`.\`需求\` WHERE \`priority\` = 'P0'"
+```
+
+### 查看排期
+
+```bash
+# 查看团队成员排期
+meegle workhour list-schedule --project-key PROJ \
+  --start-time 2026-03-01 --end-time 2026-03-31 \
+  --user-keys "张三,李四,王五"
+```
+
+### 查看用户信息
+
+```bash
+meegle user search --user-keys "张三,李四" --project-key PROJ
+```
+
+## 参数传递
+
+### 基本 flag
+
+每个命令的参数通过 `--flag-name` 传递：
+
+```bash
+meegle workitem get --work-item-id 12345 --project-key PROJ
+```
+
+### --set key=value（写入命令）
+
+`workitem create`、`workitem update`、`workflow update-node`、`subtask update` 支持 `--set` 简便设置字段：
+
+```bash
+--set name=标题              # 字符串
+--set points=5               # 数字
+--set is_urgent=true         # 布尔
+--set schedule='[1,2]'       # JSON 数组
+--set role='{"role":"RD"}'   # JSON 对象
+```
+
+`--set` 可重复使用，一次设置多个字段。
+
+### --params JSON（兜底）
+
+所有命令都支持 `--params` 传入完整 JSON 参数：
+
+```bash
+meegle workitem create --project-key PROJ --work-item-type story \
+  --params '{"fields":[{"field_key":"name","field_value":"标题"}]}'
+```
+
+### 优先级
+
+当 `--set`、`--params` 和普通 flag 同时使用时：
+
+1. `--set` 覆盖 `--params` 中同名字段
+2. 普通 flag（如 `--project-key`）覆盖 `--params` 中同名顶层 key
+
+### 数组参数
+
+多个值用逗号分隔：
+
+```bash
+--user-keys "张三,李四,王五"
+--field-keys "name,status,priority"
+```
+
+### 布尔参数
+
+直接加 flag 即为 true，不加即为 false：
+
+```bash
+meegle workflow get-node --work-item-id 12345 --need-sub-task
+```
+
+## 全局 Flag
+
+| Flag | 缩写 | 说明 |
+|------|------|------|
+| `--format` | `-o` | 输出格式：`json`（默认）、`table`、`ndjson`、`yaml`、`markdown`、`raw` |
+| `--select` | | 字段投影（支持 dot path） |
+| `--set` | | 设置嵌套参数（可重复） |
+| `--params` | `-P` | 完整 JSON 参数体 |
+| `--dry-run` | | 只渲染请求，不实际执行 |
+| `--verbose` | `-v` | 详细输出 |
+| `--profile` | | 指定配置 profile |
+
+## 输出格式
+
+```bash
+# JSON（默认）
+meegle workitem get --work-item-id 12345
+
+# 选取输出属性（支持 dot path）
+meegle workitem get --work-item-id 12345 --select "id,name,status"
+meegle mywork todo --action done --page-num 1 --select "list.work_item_info.work_item_name"
+
+# NDJSON（适合管道处理）
+meegle mywork todo --action this_week --page-num 1 -o ndjson
+
+# 表格
+meegle mywork todo --action this_week --page-num 1 -o table
+
+# YAML
+meegle workitem get --work-item-id 12345 -o yaml
+
+# Markdown 表格
+meegle mywork todo --action this_week --page-num 1 -o markdown
+
+# Dry run（预览请求，不实际发送）
+meegle workitem create --project-key PROJ --work-item-type story --set name="测试" --dry-run
+```
+
+### --select dot path
+
+`--select` 支持用 `.` 访问嵌套属性，遇到数组时自动穿透：
+
+```bash
+# 从嵌套结构中提取字段
+--select "list.work_item_info.work_item_name,list.state_info.end_state_key_name"
+
+# 混合顶层和嵌套
+--select "total,list.work_item_info.work_item_name"
+```
+
+## 命令内省
+
+使用 `inspect` 查看命令的完整参数信息：
+
+```bash
+# 列出所有命令
+meegle inspect
+
+# 查看特定命令的参数详情
+meegle inspect workitem.create
+```
+
+## 认证
+
+### 浏览器登录（默认）
+
+```bash
+meegle auth login
+```
+
+自动打开浏览器完成 OAuth 授权。如果浏览器未打开，终端会显示授权地址，手动复制即可。
+
+### Device Code 登录（无浏览器环境）
+
+```bash
+meegle auth login --device-code
+```
+
+终端显示二维码和授权码，使用手机扫码授权。适用于 SSH 远程服务器等无浏览器环境。
+
+### 其他认证命令
+
+```bash
+# 查看登录状态
+meegle auth status
+
+# 登出
+meegle auth logout
+```
+
+## 配置
+
+### 配置文件
+
+配置存储在 `~/.meegle/config.json`：
+
+```bash
+# 初始化配置
+meegle config init
+
+# 查看当前配置
+meegle config show
+
+# 修改单个配置项
+meegle config set host project.feishu.cn
+
+# 查看单个配置项
+meegle config get host
+```
+
+主要配置项：
+
+| 字段 | 说明 | 示例 |
+|------|------|------|
+| `host` | 站点域名 | `project.feishu.cn`、`meegle.com` |
+
+### 多环境 Profile
+
+支持管理多个环境配置（不同站点、不同账号），每个 profile 独立存储 host 和认证信息。
+
+```bash
+# 创建新环境（交互式引导 host 选择 + 登录）
+meegle config profile create staging
+
+# 查看所有环境
+meegle config profile list
+
+# 切换默认环境
+meegle config profile use staging
+
+# 查看当前环境
+meegle config profile current
+
+# 临时使用其他环境（不改变默认）
+meegle mywork todo --action this_week --page-num 1 --profile staging
+
+# 删除环境
+meegle config profile delete staging
+```
+
+## 常见问题
+
+### 命令列表为空
+
+CLI 启动时会从服务端获取可用命令列表。如果网络不通或未登录，动态命令不会注册。请先确保已登录：
+
+```bash
+meegle auth login
+```
+
+命令列表会自动缓存，过期后在后台静默刷新，不影响使用。
+
+## License
+
+MIT © Lark Technologies Pte. Ltd.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@lark-project/meegle",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Agent-First CLI for Meegle (Lark Project)",
-  "license": "ISC",
+  "license": "MIT",
   "bin": {
     "meegle": "bin/meegle.js"
   },
@@ -22,11 +22,15 @@
     "bin/meegle.js",
     "bin/meegle-*",
     "README.md",
+    "README.zh-CN.md",
     "LICENSE"
   ],
   "publishConfig": {
     "tag": "beta"
   },
+  "scripts": {
+    "prepublishOnly": "cp ../../README.md ./README.md && cp ../../README.zh-CN.md ./README.zh-CN.md && cp ../../LICENSE ./LICENSE"
+  },
   "keywords": [
     "meegle",
     "lark-project",