# Gleanwork Glean CLI Glean CLI

> Glean CLI

- Skill: `tomevault-io/gleanwork-glean-cli-glean-cli` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/gleanwork-glean-cli-glean-cli`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/gleanwork-glean-cli-glean-cli/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/gleanwork-glean-cli-glean-cli

---


# Glean CLI

The `glean` command-line tool provides authenticated access to your company's Glean instance. It can search documents, chat with Glean Assistant, look up people and teams, manage collections, and more.

## When to Use

Use the Glean CLI when the user:

- Asks about internal documents, policies, wikis, or company knowledge
- Wants to find people, teams, or org structure
- Needs to search across enterprise data sources (Confluence, Jira, Google Drive, Slack, etc.)
- Asks questions that require company-specific context
- Wants to manage Glean resources (collections, shortcuts, pins, announcements)

## Installation

```bash
brew install gleanwork/tap/glean-cli
```

## Authentication

```bash
# 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>
```

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

## CLI Syntax

```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 |

## 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
```

## 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

## Error Handling

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

## Available Commands

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


## Previously installed per-command skills?

Earlier versions of this project shipped one skill per command (`glean-cli-search`, `glean-cli-pins`, etc.). Those are superseded by this consolidated skill. If you still have them installed, remove them with:

```bash
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
```

---
> Source: [gleanwork/glean-cli](https://github.com/gleanwork/glean-cli) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-19 -->