Skip to main content
skill CX Codex

glean-cli — Claude Code skill: search company knowledge with Glean

Teaches the agent to drive the glean CLI: search the corporate index, query Glean Assistant, pull documents and people, manage collections.

Apache-2.0 ★ 173 updated 2026-10-24

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add sammcj/agentic-coding --skill glean-cli -a claude-code
Open on GitHub

What glean-cli does

The skill gives the agent a working map of glean, a local CLI that signs in to a company's Glean instance and exposes the REST API underneath. From there it runs searches across internal sources, asks Glean Assistant a question, looks up a colleague, or fetches and summarises a document. Results land as JSON on stdout with errors on stderr and a real exit code, which is why piping into jq needs no extra parsing.

The package holds the skill instructions plus references/commands.md, a lookup table for commands and flags. Anything unfamiliar gets checked against glean schema <command> first: the schema tracks the installed build and wins over the reference file. Three global flags carry most of the weight — --output json|ndjson|text, --json '<payload>' for request bodies that don't fit a single string, and --dry-run, which prints the request and sends nothing. Read commands sit apart from write commands, and the writes touch a live tenant.

The binary has to be on $PATH first: brew install gleanwork/tap/glean-cli. Missing it, the skill asks whether to install rather than guessing. Login goes through the browser with glean auth login; scripts use GLEAN_API_TOKEN and GLEAN_HOST, with credentials resolving from env vars, then the system keyring, then ~/.glean/config.json. Watch out for --json, since it overrides individual flags without warning.

What it helps with

  • pull up an internal runbook and get its link
  • ask Glean Assistant how the company handles expenses
  • look up a coworker and check their department
  • summarise a document from its id
  • preview a collection request before anything is created

Example prompts for the agent

  • Search Glean for our incident response runbook and list the links
  • Ask Glean Assistant how international travel gets expensed
  • Look up Jane Smith in Glean: email, title, department

How to install glean-cli

1Skills CLI (Vercel)

npx skills add sammcj/agentic-coding --skill glean-cli -a claude-code

2Manually: put the files in place

~/.claude/skills/glean-cli/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/glean-cli/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about glean-cli

How do I install glean-cli in Claude Code?

Run npx skills add sammcj/agentic-coding --skill glean-cli -a claude-code. The skill file ends up at ~/.claude/skills/glean-cli/SKILL.md.

What does glean-cli do?

It teaches the agent the glean CLI: searching the corporate index, talking to Glean Assistant, reading documents and people, and managing collections and pins.

Can it run in CI?

Yes. Set GLEAN_API_TOKEN and GLEAN_HOST instead of the browser login; credentials resolve from env vars, then the system keyring, then ~/.glean/config.json.

Source text

SKILL.md · Apache-2.0
---
name: glean-cli
description: Provides knowledge on using the `glean` CLI tool to access company knowledge and documents through Glean. Use when the user asks you to use Glean to search, read or otherwise access knowledge from their company's Confluence, Slack, Google Drive Files (Slides, Documents, Sheets) etc.
---

# Glean CLI

`glean` is a local CLI that authenticates to a company's Glean instance and exposes its REST API. It can search the corporate index, talk to Glean Assistant, look up people, fetch and summarise documents, and manage Glean-side resources (collections, pins, go-links, announcements, curated answers, agents, verification workflows).

Output is JSON on stdout, errors on stderr, exit code reflects success. This makes the CLI ideal for piping into `jq`.

## Prerequisite check

Before using anything in this skill, make sure the binary is on `$PATH`:

```bash
command -v glean
```

The `glean` CLI command is provided by `brew install gleanwork/tap/glean-cli`

If the command isn't found, you shoulkd ask the user if they wish you to install it for them.

If unauthenticated (run `glean auth status` upon authentication errors) and the user is at a terminal: `glean auth login` (browser OAuth). For CI or scripts, set `GLEAN_API_TOKEN` and `GLEAN_HOST` env vars instead - credentials resolve in the order: env vars -> system keyring -> `~/.glean/config.json`.

## Always introspect first

`glean schema` is the source of truth for commands and flags - Glean ships updates, and the schema reflects whatever version is installed locally. Before invoking a command you haven't used in this session, run:

```bash
glean schema <command>          # full machine-readable schema for one command
glean schema | jq '.commands'   # list every available command
```

The reference file in this skill (`references/commands.md`) is a fast lookup, but if `glean schema` disagrees, schema wins.

## Calling pattern

```bash
glean <command> [subcommand] [flags]
```

Three flags are global and worth knowing up front:

| Flag                            | Purpose                                                                                                                                    |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `--output <json\|ndjson\|text>` | Default `json`. Use `ndjson` when streaming results to a pipeline.                                                                         |
| `--json '<payload>'`            | Send a complete JSON request body. Overrides every other flag - use this for any non-trivial request, the schema documents the body shape. |
| `--dry-run`                     | Print the request that would be sent, send nothing. Always use this before any create/update/delete operation.                             |

Short positional flags exist for ergonomic queries (`glean search "vacation policy"`, `glean chat "what are the holidays?"`), but anything beyond a single string should go through `--json`.

## Commands at a glance

Read-only:

| Command           | Use for                                                      |
| ----------------- | ------------------------------------------------------------ |
| `glean search`    | Find documents across all enterprise sources.                |
| `glean chat`      | Ask Glean Assistant a question; streams an AI answer.        |
| `glean documents` | Fetch a doc's metadata, content, permissions, or AI summary. |
| `glean entities`  | Look up people, teams, or custom entities.                   |
| `glean messages`  | Read a specific Slack/Teams message by ID.                   |
| `glean insights`  | Pull search/usage analytics.                                 |
| `glean agents`    | List, inspect, and run Glean AI agents.                      |
| `glean tools`     | List and run Glean platform tools.                           |
| `glean answers`   | List/get curated Q&A pairs.                                  |

Write/admin:

| Command               | Use for                                                                |
| --------------------- | ---------------------------------------------------------------------- |
| `glean collections`   | Create/update/delete document collections; add/remove items.           |
| `glean pins`          | Promote a document to the top of results for given queries.            |
| `glean shortcuts`     | Manage go-links (e.g. `go/wiki`).                                      |
| `glean announcements` | Create/update/delete time-bounded company announcements.               |
| `glean answers`       | Create/update curated answers.                                         |
| `glean verification`  | Mark documents verified; send verification reminders.                  |
| `glean activity`      | Log user activity events; submit relevance feedback.                   |
| `glean api`           | Raw authenticated HTTP call to any Glean REST endpoint (escape hatch). |

For flag-level detail and worked examples on any of these, read `references/commands.md` - it's organised by command in the same order as the tables above.

## Common workflows

**Search and pipe into jq.** Search returns JSON with a `results` array; each result has a `document` with `title`, `url`, `id`, `snippets`, etc.

```bash
glean search "incident response runbook" | jq '.results[] | {title: .document.title, url: .document.url}'
```

**Find then summarise.** Combine search with the summarise subcommand:

```bash
DOC_ID=$(glean search "Q1 OKRs" | jq -r '.results[0].document.id')
glean documents summarize --json "{\"documentId\":\"$DOC_ID\"}" | jq -r .summary
```

**Ask a question.** For any "what does our company say about X" question, prefer `glean chat` over `glean search` - Glean Assistant cites the underlying documents in its response.

```bash
glean chat "How do I expense international travel?"
```

**Look up a person.**

```bash
glean entities read-people --json '{"query":"Jane Smith"}' | jq '.[0] | {name, email, title, department}'
```

## Gotchas

- **Don't echo tokens.** `GLEAN_API_TOKEN` is sensitive; never `echo` it, log it, or include it in error messages or commit it to a file. Use it via env var only.
- **Always `--dry-run` first for writes.** Any `create`, `update`, `delete`, `verify`, `remind`, `add-items`, `delete-item`, or `report` action sends data into the customer's Glean tenant. Print the body first, get the user's confirmation if it's not their explicit ask, then send.
- **`--json` overrides everything.** If both `--json` and individual flags are supplied, the JSON body wins - silently. Don't mix the two.
- **Schema, not memory.** Flag names and JSON body shapes evolve between Glean releases. If you pass a body and the API rejects it, run `glean schema <command>` and check the current shape rather than guessing.
- **`glean api` is the escape hatch, not the default.** If a dedicated subcommand exists for what you're doing (e.g. `glean search` rather than `glean api search`), prefer it - the dedicated command has nicer ergonomics and a stable contract.
- **Errors land on stderr.** When piping into `jq` or another consumer, capture stderr separately so you can surface the real error message rather than a "parse error: unexpected end of JSON" downstream.
- **Search results aren't always document objects.** `results[]` may contain promoted answers, people, or pinned items - when working programmatically, branch on `.type` or guard with `.document?`.

© sammcj · Apache-2.0 · sammcj/agentic-coding

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set73

The whole set →
ghostty-config ghostty-config is a Claude Code skill that configures and troubleshoots Ghostty terminal files, including keybind syntax, CLI actions, and Linux/macOS differences. CX Codex +1 ★ 173repo stars release-debrief release-debrief compares a supported tool’s newest release with the last saved debrief. Use it to catch changes in Claude Code, OpenCode, llama-swap, or llama.cpp. CX Codex +1 ★ 173repo stars pptx-to-md pptx-to-md turns PPTX into per-slide Markdown files, preserving text, image positions, and descriptions of diagrams and screenshots. Useful when you need structured deck content with interpreted visuals. CX Codex +1 ★ 173repo stars web-artifacts-builder-v2 web-artifacts-builder-v2 builds multi-component HTML artifacts with React, including interfaces that need state or routing. Use it to turn a frontend project into a standalone HTML file. CX Codex +1 ★ 173repo stars ai-changelog ai-changelog sets up an AI-maintained CHANGELOG.md workflow across your project. Configures CalVer, SemVer, or simple date-based logging for non-code repositories. CX Codex +1 ★ 173repo stars rust-engineer The rust-engineer skill turns Claude Code into a Rust-focused coding assistant for ownership, async code, safety checks, testing, and performance work. CX Codex +1 ★ 173repo stars software-research-assistant software-research-assistant — a subagent that digs into how to actually implement a library, framework, SDK, or API: pulls code examples, version facts, compatibility, and current best practices from live sources. CX Codex ★ 173repo stars guided-demo guided-demo adds interactive, self-running guided walkthroughs and typed narration overlays to web apps and HTML pages. CX Codex +1 ★ 173repo stars

More in the catalog

Project sponsors

Companies that keep this analytics open