bee document list

Overview

List documents

Use --keyword to search within document titles and content.

Usage

bee document list [flags]

Flags

-p, --project <id>

Project ID or project key (required)

-k, --keyword <text>

Keyword search

--sort <field>

Sort field {created|updated}

--order <dir>

Sort order

-L, --count <n>

Number of results (default: 20)

--offset <n>

Offset for pagination

--json <fields>

Output as JSON (optionally filter by field names, comma-separated)

-s, --space <hostname>

Space hostname (e.g. xxx.backlog.com, or your own domain)

-y, --yes

Skip confirmation prompt

Examples

List documents in a project

bee document list -p PROJECT

Search documents by keyword

bee document list -p PROJECT -k "meeting notes"

Output as JSON

bee document list -p PROJECT --json

Environment variables

BACKLOG_PROJECT

Project ID or project key (required)

BACKLOG_SPACE

Space hostname (e.g. xxx.backlog.com, or your own domain)

BACKLOG_API_KEY

Authenticate with an API key

BACKLOG_SPACE

Space hostname

BACKLOG_PROJECT

Default project ID or project key