Command Reference

Detailed reference for every slash command in Glean Code. Looking for a quick overview? See the README's Commands at a glance.

/help

Show help for a specific command, or list every available command grouped by category.

/help [command]

Parameter	Description
`command`	Optional. Command name without the leading `/`. Omit to list all commands.

/help
/help search
/help agents.run

Output — Without an argument: a grouped list of all commands with one-line summaries. With a command name: usage signature, parameter table, examples, and the underlying REST endpoint.

Endpoint — (local)

/status

Show the current connection state, active mode, configured instance, and any impersonation in effect.

/status

/status

Output — A summary box showing: mode (live / mock / auto), instance host, token presence, act-as email if set, and the active chat thread id.

Endpoint — (local)

/doctor

Run a full health check: validates config, tests DNS resolution, TCP connectivity, and performs a live auth probe against the search endpoint.

/doctor

/doctor

Output — A line per check (config, url shape, dns, tcp, auth probe) with a pass/fail status and detail message. Useful for diagnosing connectivity or token problems.

Endpoint — (local checks + POST /rest/api/v1/search probe)

/login

Store a Glean instance host and API token. Writes to ~/.gleancode/config.json and immediately switches the session to live mode.

/login --instance <host> --token <token> [--act-as <email>]

Parameter	Description
`--instance`	Full Glean backend host, e.g. `acme-be.glean.com`. Include the `-be` suffix — nothing is appended automatically.
`--token`	A Glean Client API token with the required scopes.
`--act-as`	Optional. Email address to impersonate via `X-Glean-ActAs`.

/login --instance acme-be.glean.com --token glean_tok_xxx
/login --instance acme-be.glean.com --token glean_tok_xxx --act-as jane@acme.com

Output — Confirms credentials saved and shows the resolved base URL.

Endpoint — (local, affects Authorization header)

/logout

Clear stored credentials and revert to mock mode.

/logout

/logout

Output — Confirms credentials removed.

Endpoint — (local)

/config

View or update individual configuration keys. Changes are persisted to ~/.gleancode/config.json.

/config [get <key> | set <key> <value> | list]

Subcommand	Description
`list`	Print the full config as key/value pairs.
`get <key>`	Print the value of a single key.
`set <key> <value>`	Update a key. See the Config keys section for valid keys and values.

/config list
/config get mode
/config set mode live
/config set default_page_size 20
/config set indexing_token glean_idx_xxx

Output — For list and get: the value(s). For set: a confirmation message.

Endpoint — (local, ~/.gleancode/config.json)

/mode

Quickly switch the API mode without editing config.

/mode <live|mock|auto>

Value	Description
`live`	Force all API calls to the real Glean backend.
`mock`	Force all calls to return local fake data (no network).
`auto`	Use live if credentials are present, otherwise fall back to mock.

/mode auto
/mode mock
/mode live

Output — Confirms the new mode.

Endpoint — (local)

/history

Show commands entered during the current session.

/history [--limit <n>]

Parameter	Description
`--limit`	Maximum number of entries to show. Default `20`.

/history
/history --limit 5

Output — A numbered list of recent commands, newest last.

Endpoint — (local)

/clear

Clear the terminal screen.

/clear

/clear

Endpoint — (local)

/exit

Quit Glean Code.

/exit

/exit

Endpoint — (local)

/chat

Send a message to the Glean Assistant. Continues the current thread by default; use --new to start a fresh conversation.

/chat <message> [--new] [--chat-id <id>] [--agent <name>] [--stream]

Parameter	Description
`message`	The user message. Quote it if it contains spaces.
`--new`	Start a new chat thread, discarding the current thread id.
`--chat-id`	Continue a specific chat thread by id.
`--agent`	Route the turn through a named agent configuration.
`--stream`	Request a streaming response.

/chat "what did engineering ship last week?"
/chat "summarise the Q2 plan" --new
/chat "draft an email to Alice" --agent sales

Output — The assistant's response in a styled box, with cited source documents listed below. The active chat thread id is saved for subsequent /chat calls.

Endpoint — POST /rest/api/v1/chat

/search

Search the Glean index and display ranked results with snippets.

/search <query> [--page-size <n>] [--datasource <name>]

Parameter	Description
`query`	Free-text search query.
`--page-size`	Number of results to return. Defaults to `default_page_size` in config.
`--datasource`	Restrict results to one datasource, e.g. `gdrive`, `slack`, `jira`, `confluence`.

/search "quarterly planning"
/search "oncall runbook" --datasource confluence --page-size 5

Output — Numbered result list, each showing title, datasource, URL, and a matching text snippet.

Endpoint — POST /rest/api/v1/search

/datasources.list

List all datasources visible to the current token, derived from a faceted search call.

/datasources.list [--with-counts] [--with-status] [--sample <n>]

Parameter	Description
`--with-counts`	Show document counts per datasource.
`--with-status`	Fetch full indexing status per datasource (requires `indexing_token`).
`--sample`	Sample size for the underlying search call. Default `100`.

/datasources.list
/datasources.list --with-counts
/datasources.list --with-status
/datasources.list --with-counts --sample 200

Output — A list of datasource names. With --with-counts: document counts alongside each name. With --with-status: uploaded/indexed counts and coverage % from the Indexing API.

Endpoint — POST /rest/api/v1/search (facets) + POST /api/index/v1/debug/{ds}/status

/autocomplete

Get query suggestions for a partial search string.

/autocomplete <partial>

Parameter	Description
`partial`	The in-progress query string.

/autocomplete "quart"
/autocomplete "onboard"

Output — A list of suggested completions ranked by relevance.

Endpoint — POST /rest/api/v1/autocomplete

/recommendations

Get document recommendations for a user based on their activity and context.

/recommendations [--user <email>]

Parameter	Description
`--user`	Target user email. Defaults to the authenticated user.

/recommendations
/recommendations --user alice@acme.com

Output — A list of recommended document titles and URLs.

Endpoint — POST /rest/api/v1/recommendations

/feedback

Send explicit feedback on a search result or chat turn using its tracking token.

/feedback <tracking-token> <rating> [--comment <text>]

Parameter	Description
`tracking-token`	The `trackingToken` field returned in a search result or chat response.
`rating`	`THUMBS_UP` or `THUMBS_DOWN`.
`--comment`	Optional free-text comment.

/feedback tok_1 THUMBS_UP
/feedback tok_1 THUMBS_DOWN --comment "wrong datasource"

Output — Confirmation that feedback was recorded.

Endpoint — POST /rest/api/v1/feedback

/datasources.status

Show full indexing status for a single datasource: visibility, document upload and index counts, coverage percentage, and the last five processing events.

Requires indexing_token — set it with /config set indexing_token <token>.

/datasources.status <datasource>

Parameter	Description
`datasource`	Datasource name, e.g. `slack`, `gdrive`, `confluence`.

/datasources.status slack
/datasources.status gdrive

Output — Datasource visibility, uploaded document count, indexed document count, coverage %, and a table of the last 5 processing history events with timestamps.

Endpoint — POST /api/index/v1/debug/{datasource}/status

/indexing.rotate-token

Rotate the indexing API token secret and print the new raw secret. Store it immediately — the old secret is invalidated.

/indexing.rotate-token

/indexing.rotate-token

Output — The new raw secret and a reminder to run /config set indexing_token <new-secret>.

Endpoint — POST /api/index/v1/rotatetoken

/datasources.config

Get the live configuration for a custom datasource — object definitions, ACL settings, trusted domains, icon URL.

/datasources.config <datasource>

/datasources.config gdrive
/datasources.config custom1

Output — Datasource config object (object types, isUserReferencedByEmail, trustedDomains, datasourceCategory, etc.).

Endpoint — POST /api/index/v1/getdatasourceconfig

/documents.status

Get upload + indexing status for a single document.

/documents.status --datasource <ds> --object-type <type> --id <doc-id>

/documents.status --datasource gdrive --object-type Article --id doc-1

Output — uploadStatus, lastUploadedAt, lastIndexedAt, any indexing errors.

Endpoint — POST /api/index/v1/getdocumentstatus

/documents.count

Count uploaded documents in a custom datasource.

/documents.count --datasource <ds>

/documents.count --datasource custom1

Output — Document count.

Endpoint — POST /api/index/v1/getdocumentcount

/users.count

Count users uploaded for a custom datasource.

/users.count --datasource <ds>

/users.count --datasource custom1

Output — User count.

Endpoint — POST /api/index/v1/getusercount

/documents.access

Check whether a specific user has access to a specific document — useful for debugging "why can't user X see doc Y?"

/documents.access --datasource <ds> --object-type <type> --id <doc> --user <email>

/documents.access --datasource gdrive --object-type Article --id doc-1 --user alice@example.com

Output — YES / NO access decision.

Endpoint — POST /api/index/v1/checkdocumentaccess

/debug.document

Get debug info (status + uploaded permissions) for a single document.

/debug.document <datasource> <doc-id> [--object-type <type>]

/debug.document gdrive doc-1 --object-type Article

Output — Document upload status, last-uploaded/indexed timestamps, ACL permissions.

Endpoint — POST /api/index/v1/debug/{datasource}/document

/debug.documents

Bulk debug for multiple documents in a datasource.

/debug.documents <datasource> --from-file <items.json>

The JSON file should be an array of {objectType, docId} entries.

/debug.documents gdrive --from-file ./batch.json

Output — Per-document debug results.

Endpoint — POST /api/index/v1/debug/{datasource}/documents

/debug.user

Get debug info for a user in a datasource — upload status + uploaded group memberships.

/debug.user <datasource> <email>

/debug.user gdrive alice@example.com

Output — User upload status and groups uploaded via the permissions API.

Endpoint — POST /api/index/v1/debug/{datasource}/user

/index.document

Index a single document. Supports two input modes — pass a fully-formed JSON body, or point at a local file and let the CLI synthesize the body for you.

/index.document (--from-file <doc.json> | --path <file>) \
                [--datasource <ds>] [--object-type <type>] \
                [--public | --acl-from-file <perms.json>] \
                [--id-prefix <s>] [--view-url-prefix <url>] \
                [--version <n>] [--dry-run]

Flag	Description
`--from-file`	JSON file containing a full `DocumentDefinition` body
`--path`	Local file path. Synthesizes a `DocumentDefinition` from the file. Errors if a directory is passed — use `/index.bulk-documents --path` for folders
`--datasource`	(with `--path`) Datasource name
`--object-type`	(with `--path`) Object type (e.g. `Article`)
`--public`	(with `--path`) Make the doc world-readable. Mutually exclusive with `--acl-from-file`
`--acl-from-file`	(with `--path`) JSON file containing a `DocumentPermissionsDefinition` applied to the doc
`--id-prefix`	(with `--path`) String prepended to the path-derived id slug
`--view-url-prefix`	(with `--path`) Base URL prepended to the relative path. Defaults to `file://<absolute>`
`--version`	Optional version int for optimistic concurrency
`--dry-run`	Print the assembled request body and exit without calling the API

Supported file types when using --path: .txt, .md, .markdown, .html, .htm, .json. Binary formats (PDF, .docx) are out of scope.

/index.document --from-file ./doc.json
/index.document --path ./README.md --datasource custom1 --object-type Article --public
/index.document --path ./team/onboarding.md --datasource custom1 --object-type Article \
                --acl-from-file ./perms.json --dry-run

Output — Acceptance status from the API. With --dry-run, the assembled JSON body.

Endpoint — POST /api/index/v1/indexdocument