glean-cli

Glean CLI

glean 命令行工具可通过身份验证访问贵公司的 Glean 实例。它可以搜索文档、与 Glean Assistant 聊天、查找人员和团队、管理集合等。

适用场景

用户出现以下需求时，请使用 Glean CLI：

• 询问内部文档、政策、维基或公司知识
• 想查找人员、团队或组织架构
• 需要搜索企业数据源（Confluence、Jira、Google Drive、Slack 等）
• 提出需要公司特定背景信息的问题
• 想管理 Glean 资源（集合、快捷方式、置顶内容、公告）

安装

brew install gleanwork/tap/glean-cli

身份验证

# Browser-based OAuth (interactive — recommended)
glean auth login

# Verify credentials
glean auth status

# CI/scripting (no interactive setup needed)
export GLEAN_API_TOKEN=your-token
export GLEAN_SERVER_URL=<your Glean server URL>

凭据按以下顺序解析：环境变量 → 系统密钥环 → ~/.glean/config.json。

CLI 语法

glean <command> [subcommand] [flags]

全局标志

标志	描述
--output	json（默认）、ndjson（每行一个结果）、text
--fields	按点分隔路径投影字段（例如 results.document.title,results.document.url）
--json	完整的 JSON 请求正文（覆盖其他所有标志）
--dry-run	打印请求正文，但不发送

架构内省

调用尚未使用过的命令前，务必先调用 glean schema <command>。

glean schema | jq '.commands'          # list all commands
glean schema search | jq '.flags'      # flags for search

安全规则

• 绝不直接输出 API 令牌或密钥
• 在自动化流水线中执行写入或删除操作前，务必使用 --dry-run
• 在 CI/CD 中，优先使用环境变量而非配置文件

错误处理

所有错误都会输出到 stderr；stdout 仅包含结构化输出。 退出代码 0 = 成功，非零 = 错误。

可用命令

命令	描述
glean activity	报告用户活动和反馈。子命令：report、feedback。
glean agents	管理并运行 Glean Agent。子命令：list、get、schemas、run。
glean announcements	管理 Glean 公告。子命令：create、update、delete。
glean answers	管理 Glean 答案。子命令：list、get、create、update、delete。
glean api	向任意 Glean REST API 端点发送原始的身份验证 HTTP 请求。
glean chat	与 Glean AI 对话。响应将以流的形式输出到 stdout。
glean collections	管理 Glean 集合。子命令：create、delete、update、add-items、delete-item。
glean documents	获取并总结 Glean 文档。子命令：get、get-by-facets、get-permissions、summarize。
glean entities	列出并读取 Glean 实体和人员。子命令：list、read-people。
glean insights	获取 Glean 使用情况洞察。子命令：get。
glean messages	获取 Glean 消息。子命令：get。
glean pins	管理 Glean 置顶内容。子命令：list、get、create、update、remove。
glean search	搜索 Glean 实例中的内容。结果为 JSON。
glean shortcuts	管理 Glean 快捷方式（go-links）。子命令：list、get、create、update、delete。
glean tools	列出并运行 Glean 工具。子命令：list、run。
glean verification	管理文档验证。子命令：list、verify、remind。

此前是否安装过按命令拆分的技能？

此项目的早期版本为每个命令提供了一个独立技能（glean-cli-search、glean-cli-pins 等）。这些技能已由这个整合后的技能取代。如果仍安装着这些技能，请通过以下命令将其移除：

npx -y skills remove -g -y \
  glean-cli-activity glean-cli-agents glean-cli-announcements \
  glean-cli-answers glean-cli-api glean-cli-chat glean-cli-collections \
  glean-cli-documents glean-cli-entities glean-cli-insights \
  glean-cli-messages glean-cli-pins glean-cli-search glean-cli-shortcuts \
  glean-cli-tools glean-cli-verification