lansenger-cli 0.1.0__tar.gz

lansenger_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lansenger PM Team
+
+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.

lansenger_cli-0.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: lansenger-cli
+Version: 0.1.0
+Summary: CLI for Lansenger (蓝信) — send messages, manage groups, staff, departments, calendars, todos, and more
+Author: Lansenger PM Team
+License-Expression: MIT
+Keywords: lansenger,蓝信,cli,chatbot,messaging,enterprise-chat
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: lansenger-sdk>=1.0.1
+Requires-Dist: typer>=0.9
+Requires-Dist: rich>=13
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file

lansenger_cli-0.1.0/README.md

@@ -0,0 +1,288 @@
+# Lansenger CLI
+
+蓝信（Lansenger）命令行工具 — 在终端直接调用蓝信开放平台 API，发送消息、管理群组、查询人员/部门、操作日程与待办等。
+
+## 安装
+
+```bash
+pip install lansenger-cli
+```
+
+或从源码安装：
+
+```bash
+pip install -e .
+```
+
+需要 Python ≥ 3.10。
+
+## 快速开始
+
+### 1. 配置凭证
+
+通过 `config set` 命令保存 app 凭证（存储在 `~/.lansenger/sdk_state.json`，密钥脱敏显示）：
+
+```bash
+lansenger config set app_id YOUR_APP_ID
+lansenger config set app_secret YOUR_APP_SECRET
+```
+
+也可以通过环境变量配置（适合 CI/CD 或临时使用）：
+
+```bash
+export LANSENGER_APP_ID=YOUR_APP_ID
+export LANSENGER_APP_SECRET=YOUR_APP_SECRET
+```
+
+可选：设置私有部署网关地址和 OAuth2 passport 地址：
+
+```bash
+lansenger config set api_gateway_url https://your-gateway.example.com/open/apigw
+lansenger config set passport_url https://your-passport.example.com
+```
+
+### 2. 查看配置
+
+```bash
+lansenger config show
+```
+
+### 3. 健康检查
+
+验证凭证是否正确、能否成功获取 app token：
+
+```bash
+lansenger health check
+```
+
+## 命令总览
+
+| 命令组 | 说明 | 子命令 |
+|--------|------|--------|
+| `config` | 管理凭证配置 | `set`, `show`, `clear` |
+| `message` | 发送与管理消息 | `send-text`, `send-markdown`, `send-file`, `send-image-url`, `send-link-card`, `send-app-articles`, `send-app-card`, `update-dynamic-card`, `revoke`, `query-groups` |
+| `group` | 管理群组 | `create`, `info`, `members`, `list`, `check`, `update`, `update-members` |
+| `staff` | 查询人员信息 | `basic-info`, `detail`, `ancestors`, `id-mapping`, `org-extra-fields`, `search`, `org-info` |
+| `department` | 查询部门信息 | `detail`, `children`, `staffs` |
+| `calendar` | 日程操作 | `primary`, `create-schedule`, `fetch-schedule`, `delete-schedule`, `list-schedules`, `attendees`, `add-attendees`, `delete-attendees` |
+| `todo` | 待办任务管理 | `create`, `update`, `update-status`, `delete`, `list`, `fetch-by-source`, `fetch-by-id`, `status-counts`, `executor-status`, `add-executors`, `delete-executors`, `executor-list` |
+| `oauth` | OAuth2 用户认证 | `authorize-url`, `exchange-code`, `refresh-token`, `user-info`, `parse-callback`, `validate-state` |
+| `callback` | 回调事件解析 | `parse-payload`, `verify-signature`, `event-types` |
+| `media` | 媒体文件操作 | `upload`, `download`, `download-to-file` |
+| `streaming` | 流式消息（AI 场景） | `create`, `fetch` |
+| `health` | 连接健康检查 | `check` |
+
+## 常用示例
+
+### 发送消息
+
+```bash
+# 发送文本消息
+lansenger message send-text chat123 "Hello World"
+
+# 发送 Markdown 消息
+lansenger message send-markdown chat123 "**Bold** text"
+
+# 发送文件
+lansenger message send-file chat123 /path/to/file.pdf
+
+# 发送带图片 URL 的消息
+lansenger message send-image-url chat123 https://example.com/photo.jpg
+
+# 发送链接卡片
+lansenger message send-link-card chat123 "公告标题" https://example.com --desc "点击查看详情"
+
+# 发送应用卡片
+lansenger message send-app-card chat123 "卡片标题" --content "正文内容" --card-link https://example.com
+
+# 发送多条图文（appArticles）
+lansenger message send-app-articles chat123 '{"title":"文章1","url":"https://a.com"}' '{"title":"文章2","url":"https://b.com"}'
+
+# 群内发送并 @all
+lansenger message send-text group123 "全员通知" --group --mention-all
+
+# 群内 @指定人
+lansenger message send-text group123 "请查看" --group --mention staff001 --mention staff002
+
+# 撤回消息
+lansenger message revoke msg001 msg002
+```
+
+### 群组管理
+
+```bash
+# 创建群组
+lansenger group create "项目群" org001 --staff staff001 --staff staff002
+
+# 查看群信息
+lansenger group info group123
+
+# 查看群成员
+lansenger group members group123
+
+# 查看群列表
+lansenger group list --user-token YOUR_USER_TOKEN
+
+# 检查用户是否在群内
+lansenger group check group123 --staff-id staff001
+
+# 更新群信息
+lansenger group update group123 --name "新名称" --desc "新描述"
+
+# 添加/移除成员
+lansenger group update-members group123 --add staff003 --remove staff001
+```
+
+### 人员查询
+
+```bash
+# 查看人员基本信息
+lansenger staff basic-info staff001
+
+# 查看人员详细信息
+lansenger staff detail staff001
+
+# 搜索人员
+lansenger staff search 张三
+
+# 手机号/邮箱映射 staff ID
+lansenger staff id-mapping org001 phone 13800138000
+
+# 查看组织信息
+lansenger staff org-info org001
+```
+
+### 部门查询
+
+```bash
+# 查看部门详情
+lansenger department detail dept001
+
+# 查看子部门
+lansenger department children dept001
+
+# 查看部门内人员
+lansenger department staffs dept001
+```
+
+### 日程操作
+
+```bash
+# 获取主日历
+lansenger calendar primary --user-token YOUR_USER_TOKEN
+
+# 创建日程
+lansenger calendar create-schedule cal001 "周会" \
+  '{"dateTime":"2026-01-01T09:00:00","timeZone":"Asia/Shanghai"}' \
+  '{"dateTime":"2026-01-01T10:00:00","timeZone":"Asia/Shanghai"}' \
+  '[{"staffId":"staff001"}]' \
+  --desc "每周例会"
+
+# 查看日程列表
+lansenger calendar list-schedules cal001 1735689600 1735776000 --user-token YOUR_TOKEN
+```
+
+### 待办任务
+
+```bash
+# 创建待办
+lansenger todo create "审批文档" https://app.com/doc https://app.com/doc \
+  "staff001,staff002" org001 --desc "请审批" --type 2
+
+# 更新待办状态（11=待阅, 12=已阅, 21=待办, 22=已办）
+lansenger todo update-status task001 22 org001
+
+# 查看待办列表
+lansenger todo list org001 --status 21,22
+
+# 删除待办
+lansenger todo delete task001 org001
+```
+
+### OAuth2 用户认证
+
+```bash
+# 生成授权 URL
+lansenger oauth authorize-url https://yourapp.com/callback --scope basic_userinfor
+
+# 交换 code 获取 user token
+lansenger oauth exchange-code AUTH_CODE --redirect-uri https://yourapp.com/callback
+
+# 刷新 user token
+lansenger oauth refresh-token YOUR_REFRESH_TOKEN
+
+# 获取用户信息
+lansenger oauth user-info YOUR_USER_TOKEN
+```
+
+### 回调事件
+
+```bash
+# 查看所有回调事件类型
+lansenger callback event-types
+
+# 解析回调数据
+lansenger callback parse-payload ENCRYPTED_DATA --encoding-key YOUR_KEY
+
+# 验证签名
+lansenger callback verify-signature TIMESTAMP NONCE SIGNATURE ENCODING_KEY
+```
+
+### 媒体文件
+
+```bash
+# 上传文件
+lansenger media upload /path/to/file.pdf --media-type 3
+
+# 下载媒体文件到本地
+lansenger media download-to-file MEDIA_ID --output /path/to/save.pdf
+```
+
+### 流式消息
+
+```bash
+# 创建流式消息（用于 AI agent 渐进式输出）
+lansenger streaming create user123 single stream-session-001
+
+# 获取流式消息状态
+lansenger streaming fetch MSG_ID
+```
+
+## 全局选项
+
+| 选项 | 说明 |
+|------|------|
+| `--json` / `-j` | 输出原始 JSON 格式而非 rich 表格 |
+
+```bash
+# JSON 格式输出（便于脚本处理）
+lansenger -j staff basic-info staff001
+```
+
+## Shell 自动补全
+
+typer 内置补全支持：
+
+```bash
+# 安装补全
+lansenger --install-completion
+
+# 查看补全脚本
+lansenger --show-completion
+```
+
+支持 bash、zsh、fish 等主流 shell。
+
+## 凭证安全
+
+- 凭证存储在 `~/.lansenger/sdk_state.json`，文件权限 0600
+- `config show` 命令对 `app_id` 和 `app_secret` 脱敏显示（`***`）
+- 也支持环境变量 `LANSENGER_APP_ID` / `LANSENGER_APP_SECRET`，适合 CI/CD 场景
+
+## 与 SDK 的关系
+
+本 CLI 基于 [lansenger-sdk](https://github.com/lansenger-pm/lansenger-skills-official) 的 `LansengerSyncClient` 实现，覆盖 SDK 全部同步 API，不修改 SDK 代码。
+
+## 许可证
+
+MIT License

lansenger_cli-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lansenger-cli"
+version = "0.1.0"
+description = "CLI for Lansenger (蓝信) — send messages, manage groups, staff, departments, calendars, todos, and more"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Lansenger PM Team" },
+]
+keywords = ["lansenger", "蓝信", "cli", "chatbot", "messaging", "enterprise-chat"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications :: Chat",
+]
+
+dependencies = [
+    "lansenger-sdk>=1.0.1",
+    "typer>=0.9",
+    "rich>=13",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7",
+]
+
+[project.scripts]
+lansenger = "lansenger_cli.main:app"
+
+[tool.setuptools.packages.find]
+where = ["src"]

lansenger_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lansenger_cli-0.1.0/src/lansenger_cli/commands/calendar.py

@@ -0,0 +1,154 @@
+import typer
+import json
+from typing import List
+
+from lansenger_cli.utils import get_client, output_result, output_list
+
+app = typer.Typer(help="Calendar and schedule operations")
+
+
+@app.command("primary")
+def fetch_primary_calendar(
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    result = client.fetch_primary_calendar(user_token=user_token, user_id=user_id)
+    output_result(result, fields=[
+        "calendar_id", "summary", "description", "permissions", "role",
+    ], title="Primary Calendar")
+
+
+@app.command("create-schedule")
+def create_schedule(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    summary: str = typer.Argument(help="Schedule summary/title"),
+    start_time: str = typer.Argument(help="Start time as JSON: '{\"dateTime\":\"2026-01-01T09:00:00\",\"timeZone\":\"Asia/Shanghai\"}'"),
+    end_time: str = typer.Argument(help="End time as JSON"),
+    attendees: str = typer.Argument(help="Attendees as JSON list: '[{\"staffId\":\"xxx\"}]'"),
+    description: str = typer.Option("", "--desc", "-d", help="Schedule description"),
+    all_day: str = typer.Option("no", "--all-day", help="yes or no"),
+    repeat_type: str = typer.Option("no", "--repeat", help="Repeat type: no, daily, weekly, monthly, yearly"),
+    reminder_type: str = typer.Option("yes", "--reminder", help="Reminder type: yes or no"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    start_time_dict = json.loads(start_time)
+    end_time_dict = json.loads(end_time)
+    attendees_list = json.loads(attendees)
+    result = client.create_schedule(
+        calendar_id=calendar_id, summary=summary,
+        start_time=start_time_dict, end_time=end_time_dict,
+        attendees=attendees_list, description=description,
+        all_day=all_day, repeat_type=repeat_type,
+        reminder_type=reminder_type,
+        user_token=user_token, user_id=user_id,
+    )
+    output_result(result, fields=["schedule_id"], title="Create Schedule Result")
+
+
+@app.command("fetch-schedule")
+def fetch_schedule(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    schedule_id: str = typer.Argument(help="Schedule ID"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    result = client.fetch_schedule(
+        calendar_id=calendar_id, schedule_id=schedule_id,
+        user_token=user_token, user_id=user_id,
+    )
+    output_result(result, fields=[
+        "schedule_id", "summary", "description", "all_day",
+        "start_time", "end_time", "creator", "rsvp_status",
+    ], title="Schedule Info")
+
+
+@app.command("delete-schedule")
+def delete_schedule(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    schedule_id: str = typer.Argument(help="Schedule ID"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    result = client.delete_schedule(
+        calendar_id=calendar_id, schedule_id=schedule_id,
+        user_token=user_token, user_id=user_id,
+    )
+    output_result(result, fields=["schedule_id"], title="Delete Schedule Result")
+
+
+@app.command("list-schedules")
+def fetch_schedule_list(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    start_time: int = typer.Argument(help="Start time (unix timestamp)"),
+    end_time: int = typer.Argument(help="End time (unix timestamp)"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    result = client.fetch_schedule_list(
+        calendar_id=calendar_id, start_time=start_time, end_time=end_time,
+        user_token=user_token, user_id=user_id,
+    )
+    if result.success and result.schedule_list:
+        output_list(result.schedule_list, columns=["Schedule ID", "Summary"], row_mapper=lambda s: [
+            getattr(s, "schedule_id", ""), getattr(s, "summary", ""),
+        ])
+    else:
+        output_result(result, title="Schedule List")
+
+
+@app.command("attendees")
+def fetch_schedule_attendees(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    schedule_id: str = typer.Argument(help="Schedule ID"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+    page: int = typer.Option(1, "--page", "-p", help="Page number"),
+    page_size: int = typer.Option(500, "--size", "-s", help="Page size"),
+):
+    client = get_client()
+    result = client.fetch_schedule_attendees(
+        calendar_id=calendar_id, schedule_id=schedule_id,
+        user_token=user_token, user_id=user_id,
+        page=page, page_size=page_size,
+    )
+    output_result(result, fields=["total"], title="Schedule Attendees")
+
+
+@app.command("add-attendees")
+def add_schedule_attendees(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    schedule_id: str = typer.Argument(help="Schedule ID"),
+    attendees: str = typer.Argument(help="Attendee staff IDs as JSON list: '[\"id1\",\"id2\"]'"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    attendees_list = json.loads(attendees)
+    result = client.add_schedule_attendees(
+        calendar_id=calendar_id, schedule_id=schedule_id,
+        attendees=attendees_list, user_token=user_token, user_id=user_id,
+    )
+    output_result(result, fields=["schedule_id"], title="Add Attendees Result")
+
+
+@app.command("delete-attendees")
+def delete_schedule_attendees(
+    calendar_id: str = typer.Argument(help="Calendar ID"),
+    schedule_id: str = typer.Argument(help="Schedule ID"),
+    attendees: str = typer.Argument(help="Attendee staff IDs as JSON list"),
+    user_token: str = typer.Option("", "--user-token", help="User token"),
+    user_id: str = typer.Option("", "--user-id", help="User ID"),
+):
+    client = get_client()
+    attendees_list = json.loads(attendees)
+    result = client.delete_schedule_attendees(
+        calendar_id=calendar_id, schedule_id=schedule_id,
+        attendees=attendees_list, user_token=user_token, user_id=user_id,
+    )
+    output_result(result, fields=["schedule_id"], title="Delete Attendees Result")

lansenger_cli-0.1.0/src/lansenger_cli/commands/callback.py

@@ -0,0 +1,64 @@
+import typer
+import json
+from rich import print as rprint
+
+from lansenger_cli.utils import is_json_output, console
+
+app = typer.Typer(help="Parse and verify callback events")
+
+
+@app.command("parse-payload")
+def parse_callback_payload(
+    encrypted_data: str = typer.Argument(help="Encrypted callback data"),
+    encoding_key: str = typer.Option("", "--encoding-key", help="Encoding key for decryption"),
+    verify_signature: bool = typer.Option(False, "--verify-sig", help="Verify signature"),
+    timestamp: str = typer.Option("", "--timestamp", help="Timestamp for signature verification"),
+    nonce: str = typer.Option("", "--nonce", help="Nonce for signature verification"),
+    signature: str = typer.Option("", "--signature", help="Signature to verify"),
+):
+    from lansenger_sdk import parse_callback_payload
+    events = parse_callback_payload(
+        encrypted_data,
+        encoding_key=encoding_key,
+        verify_signature=verify_signature,
+        timestamp=timestamp,
+        nonce=nonce,
+        signature=signature,
+    )
+    if is_json_output():
+        rprint(json.dumps([e.to_dict() if hasattr(e, "to_dict") else str(e) for e in events], indent=2, ensure_ascii=False))
+        return
+    for event in events:
+        rprint(f"[bold cyan]Event #{event.event_id}[/bold cyan] — {event.event_type} ({event.category})")
+        if hasattr(event, "data") and hasattr(event.data, "to_dict"):
+            rprint(json.dumps(event.data.to_dict(), indent=2, ensure_ascii=False))
+        else:
+            rprint(event.data)
+
+
+@app.command("verify-signature")
+def verify_callback_signature(
+    timestamp: str = typer.Argument(help="Timestamp"),
+    nonce: str = typer.Argument(help="Nonce"),
+    signature: str = typer.Argument(help="Signature"),
+    encoding_key: str = typer.Argument(help="Encoding key"),
+):
+    from lansenger_sdk import verify_callback_signature
+    valid = verify_callback_signature(timestamp, nonce, signature, encoding_key)
+    rprint(f"Signature valid: {valid}")
+
+
+@app.command("event-types")
+def get_callback_event_types():
+    from lansenger_sdk import get_callback_event_types
+    types = get_callback_event_types()
+    if is_json_output():
+        rprint(json.dumps(types, indent=2, ensure_ascii=False))
+        return
+    from rich.table import Table
+    table = Table(title="Callback Event Types", show_header=True, header_style="bold cyan")
+    table.add_column("Event Type")
+    table.add_column("Category")
+    for event_type, category in types.items():
+        table.add_row(event_type, category)
+    console.print(table)

lansenger_cli-0.1.0/src/lansenger_cli/commands/config.py

@@ -0,0 +1,54 @@
+import typer
+from rich import print as rprint
+
+from lansenger_sdk import CredentialStore
+
+from lansenger_cli.utils import get_store, output_result, is_json_output
+
+app = typer.Typer(help="Manage CLI configuration (credentials, tokens)")
+
+VALID_KEYS = ["app_id", "app_secret", "api_gateway_url", "passport_url"]
+
+
+@app.command("set")
+def config_set(
+    key: str = typer.Argument(help=f"Config key: {', '.join(VALID_KEYS)}"),
+    value: str = typer.Argument(help="Config value"),
+):
+    if key not in VALID_KEYS:
+        rprint(f"[red]Error:[/red] Invalid key '{key}'. Valid keys: {', '.join(VALID_KEYS)}")
+        raise typer.Exit(1)
+    store = get_store()
+    creds = store.load_credentials()
+    creds[key] = value
+    store.save_credentials(
+        app_id=creds.get("app_id", ""),
+        app_secret=creds.get("app_secret", ""),
+        api_gateway_url=creds.get("api_gateway_url", ""),
+        passport_url=creds.get("passport_url", ""),
+    )
+    rprint(f"[green]Set[/green] {key} = {value}")
+
+
+@app.command("show")
+def config_show():
+    store = get_store()
+    if is_json_output():
+        rprint(store.load())
+        return
+    creds = store.load_credentials()
+    has = store.has_credentials()
+    full = store.has_full_config()
+    rprint(f"Credentials configured: {has}")
+    rprint(f"Full config available: {full}")
+    rprint(f"Store path: {store.path}")
+    for k, v in creds.items():
+        display = v if k in ("api_gateway_url", "passport_url") else ("***" if v else "(empty)")
+        rprint(f"  {k}: {display}")
+
+
+@app.command("clear")
+def config_clear():
+    store = get_store()
+    store.clear()
+    rprint("[green]Cleared[/green] all stored configuration.")