Back to Beads

Essential Commands

website/docs/cli-reference/essential.md

1.0.33.5 KB
Original Source

Essential Commands

The most important commands for daily use.

bd create

Create a new issue.

bash
bd create <title> [flags]

Flags:

FlagShortDescription
--type-tIssue type: bug, feature, task, epic, chore
--priority-pPriority: 0-4 (0=critical, 4=backlog)
--description-dDetailed description
--labels-lComma-separated labels
--parentParent issue ID (for hierarchical)
--depsDependencies (e.g., discovered-from:bd-42)
--jsonJSON output

Examples:

bash
bd create "Fix login bug" -t bug -p 1
bd create "Add dark mode" -t feature -p 2 --description="User requested"
bd create "Subtask" --parent bd-42 -p 2
bd create "Found during work" --deps discovered-from:bd-42 --json

bd list

List issues with filters.

bash
bd list [flags]

Flags:

FlagDescription
--statusFilter by status: open, in_progress, closed
--priorityFilter by priority (comma-separated)
--typeFilter by type (comma-separated)
--label-anyIssues with any of these labels
--label-allIssues with all of these labels
--jsonJSON output

Examples:

bash
bd list --status open
bd list --priority 0,1 --type bug
bd list --label-any urgent,critical --json

bd show

Show issue details.

bash
bd show <id> [flags]

Examples:

bash
bd show bd-42
bd show bd-42 --json
bd show bd-42 bd-43 bd-44  # Multiple issues

bd update

Update issue fields.

bash
bd update <id> [flags]

Flags:

FlagDescription
--statusNew status
--priorityNew priority
--titleNew title
--descriptionNew description
--add-labelAdd label
--remove-labelRemove label
--jsonJSON output

Examples:

bash
bd update bd-42 --claim
bd update bd-42 --priority 0 --add-label urgent
bd update bd-42 --title "Updated title" --json

bd close

Close an issue.

bash
bd close <id> [flags]

Flags:

FlagDescription
--reasonClosure reason
--jsonJSON output

Examples:

bash
bd close bd-42
bd close bd-42 --reason "Fixed in PR #123"
bd close bd-42 --json

bd ready

Show issues ready to work on (no blockers).

bash
bd ready [flags]

Flags:

FlagDescription
--priorityFilter by priority
--typeFilter by type
--jsonJSON output

Examples:

bash
bd ready
bd ready --priority 1
bd ready --json

bd blocked

Show blocked issues and their blockers.

bash
bd blocked [flags]

Examples:

bash
bd blocked
bd blocked --json

bd dolt push

Push changes to a Dolt remote.

bash
bd dolt push [flags]

Performs:

  1. Dolt commit (snapshot current database state)
  2. Push to Dolt remote

Examples:

bash
bd dolt push

bd dolt pull

Pull changes from a Dolt remote.

bash
bd dolt pull [flags]

Examples:

bash
bd dolt pull

bd info

Show system information.

bash
bd info [flags]

Flags:

FlagDescription
--whats-newShow recent version changes
--schemaShow database schema
--jsonJSON output

Examples:

bash
bd info
bd info --whats-new
bd info --json

bd stats

Show project statistics.

bash
bd stats [flags]

Examples:

bash
bd stats
bd stats --json