glean-shared

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

glean — Shared Reference

glean — 通用参考文档

Read this first. All other glean skills assume familiarity with auth, flags, and output formats described here.

请先阅读本文档。所有其他glean技能都默认你已熟悉本文档中介绍的身份验证、标志和输出格式。

Installation

安装

bash

brew install gleanwork/tap/glean-cli

bash

brew install gleanwork/tap/glean-cli

Authentication

身份验证

bash

undefined

bash

undefined

Browser-based OAuth (interactive — recommended)

基于浏览器的OAuth（交互式 — 推荐）

glean auth login

Verify credentials

验证凭据

glean auth status

CI/scripting (no interactive setup needed)

CI/脚本环境（无需交互式设置）

export GLEAN_API_TOKEN=your-token export GLEAN_HOST=your-company-be.glean.com


Credentials resolve in this order: environment variables → system keyring → ~/.glean/config.json.

export GLEAN_API_TOKEN=your-token export GLEAN_HOST=your-company-be.glean.com


凭据的优先级顺序为：环境变量 → 系统密钥环 → ~/.glean/config.json。

CLI Syntax

CLI语法

bash

glean <command> [subcommand] [flags]

bash

glean <command> [subcommand] [flags]

Global Flags

全局标志

Flag	Description
--output <FORMAT>	json (default), ndjson (one result per line), text
--fields <PATHS>	Dot-path field projection (e.g. results.document.title,results.document.url)
--json <PAYLOAD>	Complete JSON request body (overrides all other flags)
--dry-run	Print request body without sending

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

Schema Introspection

架构自省

Always call glean schema <command> before invoking a command you haven't used before.

bash

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

在使用你从未用过的命令之前，请先调用glean schema <command>。

bash

glean schema | jq '.commands'          # 列出所有命令
glean schema search | jq '.flags'      # 搜索命令的标志

Security Rules

安全规则

Never output API tokens or secrets directly
Always use --dry-run before write/delete operations in automated pipelines
Prefer environment variables over config files for CI/CD

绝对不要直接输出API令牌或机密信息
始终在自动化流水线中的写入/删除操作前使用--dry-run
在CI/CD环境中优先使用环境变量而非配置文件

Error Handling

错误处理

All errors go to stderr; stdout contains only structured output. Exit code 0 = success, non-zero = error.

所有错误信息输出到stderr；stdout仅包含结构化输出。退出码0表示成功，非0表示错误。

Available Commands

可用命令

Command	Description
glean activity	Report user activity and feedback. Subcommands: report, feedback.
glean agents	Manage and run Glean agents. Subcommands: list, get, schemas, run.
glean announcements	Manage Glean announcements. Subcommands: create, update, delete.
glean answers	Manage Glean answers. Subcommands: list, get, create, update, delete.
glean api	Make a raw authenticated HTTP request to any Glean REST API endpoint.
glean chat	Have a conversation with Glean AI. Streams response to stdout.
glean collections	Manage Glean collections. Subcommands: create, delete, update, add-items, delete-item.
glean documents	Retrieve and summarize Glean documents. Subcommands: get, get-by-facets, get-permissions, summarize.
glean entities	List and read Glean entities and people. Subcommands: list, read-people.
glean insights	Retrieve Glean usage insights. Subcommands: get.
glean messages	Retrieve Glean messages. Subcommands: get.
glean pins	Manage Glean pins. Subcommands: list, get, create, update, remove.
glean search	Search for content in your Glean instance. Results are JSON.
glean shortcuts	Manage Glean shortcuts (go-links). Subcommands: list, get, create, update, delete.
glean tools	List and run Glean tools. Subcommands: list, run.
glean verification	Manage document verification. Subcommands: list, verify, remind.

命令	描述
glean activity	报告用户活动和反馈。子命令：report、feedback。
glean agents	管理和运行Glean agents。子命令：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快捷方式（跳转链接）。子命令：list、get、create、update、delete。
glean tools	列出和运行Glean工具。子命令：list、run。
glean verification	管理文档验证。子命令：list、verify、remind。