beads_rust/CLI_SCHEMA.json at main · greenforestpath/beads_rust · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
{
  "tool": "br",
  "repo": "beads_rust",
  "purpose": "Agent-first issue tracker (SQLite + JSONL).",
  "entrypoints": {
    "binary": "br",
    "agent_docs": [
      "AGENTS.md",
      "docs/agent/QUICKSTART.md",
      "docs/agent/ROBOT_MODE.md",
      "docs/agent/SCHEMA.md",
      "docs/agent/ERRORS.md",
      "docs/agent/EXAMPLES.md"
    ],
    "deep_docs": [
      "docs/CLI_REFERENCE.md",
      "docs/AGENT_INTEGRATION.md"
    ]
  },
  "global_flags": [
    {
      "flag": "--json",
      "type": "bool",
      "notes": "Force machine-readable JSON output (overrides --format)."
    },
    {
      "flag": "--no-color",
      "type": "bool",
      "notes": "Disable ANSI styling in text output."
    },
    {
      "flag": "--quiet",
      "type": "bool",
      "notes": "Minimize output (errors only)."
    }
  ],
  "format_env": {
    "BR_OUTPUT_FORMAT": {
      "values": [
        "text",
        "json",
        "toon",
        "csv"
      ],
      "notes": "Highest precedence default output format when --format/--json not provided."
    },
    "TOON_DEFAULT_FORMAT": {
      "values": [
        "text",
        "json",
        "toon",
        "csv"
      ],
      "notes": "Fallback default output format when BR_OUTPUT_FORMAT is not set."
    }
  },
  "schema_surface": {
    "supported": true,
    "command": "br schema all --format json",
    "targets": [
      "all",
      "issue",
      "issue-with-counts",
      "issue-details",
      "ready-issue",
      "stale-issue",
      "blocked-issue",
      "tree-node",
      "statistics",
      "error"
    ]
  },
  "output_notes": [
    "Prefer `--format json` (or `--json`) for parsing.",
    "Prefer `--format toon` for token-efficient outputs; decode with `tru --decode` when needed.",
    "Errors may be emitted as structured JSON on stderr."
  ]
}