@@ -165,11 +165,11 @@ tbdflow init --yes --main-branch trunk
165165tbdflow init --yes --remote git@github.com:org/repo.git
166166```
167167
168- | Flag | Description |
169- | ---------------- | ----------------------------------------------------------|
170- | -y, --yes | Accept defaults, skip all interactive prompts. |
171- | --main-branch | Set the main branch name (default: ` main ` ). |
172- | --remote | Link a remote repository URL and push the initial commit.|
168+ | Flag | Description |
169+ | ---------------| - ----------------------------------------------------------|
170+ | -y, --yes | Accept defaults, skip all interactive prompts. |
171+ | --main-branch | Set the main branch name (default: ` main ` ). |
172+ | --remote | Link a remote repository URL and push the initial commit. |
173173
174174` .tbdflow.yml `
175175This file controls the core workflow of the tool. You can customise:
@@ -349,11 +349,11 @@ the safety net.
349349
350350## Global options
351351
352- | Flag | Description | Required |
353- | -----------| ----------------------------------------------------------| ----------|
354- | --verbose | Prints the underlying Git commands as they are executed. | No |
355- | --dry-run | Simulate the command without making any changes. | No |
356- | --json | Emit machine-readable JSON output instead of human-readable text. Supported by ` info ` and ` status ` . | No |
352+ | Flag | Description | Required |
353+ | -----------| --------------------------------------------------------------------------------------------------------------- | ----------|
354+ | --verbose | Prints the underlying Git commands as they are executed. | No |
355+ | --dry-run | Simulate the command without making any changes. | No |
356+ | --json | Emit machine-readable JSON output instead of human-readable text. Supported by ` info ` , ` status ` , and ` radar ` . | No |
357357
358358## Commands
359359
@@ -374,19 +374,19 @@ tbdflow commit [options]
374374
375375** Options:**
376376
377- | Flag | Option | Description | Required |
378- | ------| ------------------------| ----------------------------------------------------------| ----------|
379- | -t | --type | The type of commit (e.g., feat, fix, chore). | Yes |
380- | -s | --scope | The scope of the changes (e.g., api, ui). | No |
381- | -m | --message | The descriptive commit message (subject line). | Yes |
382- | | --message-file | Read the subject from a file (` - ` for stdin). Conflicts with --message. | No |
383- | | --body | Optional multi-line body for the commit message. | No |
384- | | --body-file | Read the body from a file (` - ` for stdin). Conflicts with --body. | No |
385- | -b | --breaking | Mark the commit as a breaking change. | No |
386- | | --breaking-description | Provide a description for the 'BREAKING CHANGE:' footer. | No |
387- | | --tag | Optionally add and push an annotated tag to this commit. | No |
388- | | --issue | Optionally add an issue reference to the footer. | No |
389- | | --no-verify | Bypass the interactive DoD checklist. | No |
377+ | Flag | Option | Description | Required |
378+ | ------| ------------------------| ------------------------------------------------------------------------- | ----------|
379+ | -t | --type | The type of commit (e.g., feat, fix, chore). | Yes |
380+ | -s | --scope | The scope of the changes (e.g., api, ui). | No |
381+ | -m | --message | The descriptive commit message (subject line). | Yes |
382+ | | --message-file | Read the subject from a file (` - ` for stdin). Conflicts with --message. | No |
383+ | | --body | Optional multi-line body for the commit message. | No |
384+ | | --body-file | Read the body from a file (` - ` for stdin). Conflicts with --body. | No |
385+ | -b | --breaking | Mark the commit as a breaking change. | No |
386+ | | --breaking-description | Provide a description for the 'BREAKING CHANGE:' footer. | No |
387+ | | --tag | Optionally add and push an annotated tag to this commit. | No |
388+ | | --issue | Optionally add an issue reference to the footer. | No |
389+ | | --no-verify | Bypass the interactive DoD checklist. | No |
390390
391391** Example:**
392392
@@ -951,6 +951,40 @@ trunk CI status (when `ci_check` is enabled):
951951}
952952` ` `
953953
954+ **Radar data:**
955+
956+ The `radar` command returns trunk health, file churn hotspots, and overlap detection in a single payload :
957+
958+ ` ` ` json
959+ {
960+ "success": true,
961+ "data": {
962+ "trunk": {
963+ "branch_name": "main",
964+ "status": "green",
965+ "last_integrated_minutes_ago": 12
966+ },
967+ "hotspots": [
968+ { "file": "src/auth/logic.rs", "changes_count": 14 },
969+ { "file": "src/db/schema.sql", "changes_count": 8 }
970+ ],
971+ "overlaps": [
972+ {
973+ "branch": "feat/API-42-user-auth",
974+ "author": "@alicia",
975+ "commits_ahead": 2,
976+ "files": [
977+ { "file": "src/auth/handler.rs", "level": "line" },
978+ { "file": "src/auth/middleware.rs", "level": "file" }
979+ ]
980+ }
981+ ],
982+ "branches_scanned": 4,
983+ "local_files_count": 3
984+ }
985+ }
986+ ` ` `
987+
954988# ### `undo`
955989
956990In TBD, the rule is simple : if the trunk breaks, fix it or revert it immediately. `tbdflow undo` is a smart wrapper
0 commit comments