bee document view

Overview

View a document

Use --web to open in the browser (--project is required for --web).

Usage

bee document view [flags] <DOCUMENT>

Arguments

DOCUMENT

Document ID

Flags

-p, --project <id>

Project ID or project key (required for --web)

-w, --web

Open the document in the browser

-n, --no-browser

Print the URL instead of opening the browser

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

View document details

bee document view 12345

Open document in browser

bee document view 12345 --web -p PROJECT

Output as JSON

bee document view 12345 --json

Environment variables

BACKLOG_PROJECT

Project ID or project key (required for --web)

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