Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
13d723c
Create agents for planing/implement/test new capabilities provided fr…
Jul 26, 2026
7276123
Revise Implementer agent details in markdown
aviatco Jul 28, 2026
fd1a3d3
Merge pull request #5 from aviatco/dev/aviatcohen/improveOnboardingIt…
aviatco Aug 2, 2026
f096c9d
Merge branch 'microsoft:main' into main
aviatco Oct 19, 2026
cfc5ea4
Revert "Improve onboarding item agent"
aviatco Oct 19, 2026
6daa70b
Merge pull request #7 from aviatco/revert-5-dev/aviatcohen/improveOnb…
aviatco Oct 19, 2026
27162aa
Add machine-readable JSON output for --help
Oct 26, 2026
f348883
add fab_help tests
Oct 28, 2026
62eaeca
validate help structure
Oct 28, 2026
3fbfede
resolve comments
Oct 28, 2026
3aa7573
Fixed leaf JSON help to retain aliases from registered subparser choi…
Oct 28, 2026
d6b361a
Merge branch 'main' into dev/aviatcohen/supportMachineReadableHelp
aviatco Oct 28, 2026
8462b79
Fixed interactive help to run before config-dependent logging in REPL…
Oct 29, 2026
1192487
Merge branch 'dev/aviatcohen/supportMachineReadableHelp' of https://g…
Oct 29, 2026
64dda27
Removed all fab prefix in interactive example
Oct 29, 2026
66f828c
Fixed JSON help usage to list required options explicitly before [fla…
Oct 29, 2026
de2574d
Merge branch 'microsoft:main' into main
aviatco Nov 4, 2026
7c8feef
resove conflicts
Nov 5, 2026
5039eb1
Update docs/essentials/output_format.md
aviatco Nov 5, 2026
778645a
resove PR comments
Nov 5, 2026
e206368
removed redundant helpers error logs
Nov 11, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/unreleased/added-20261026-103451.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: added
body: Add machine-readable JSON help for root, group, and leaf commands with offline help discovery and a versioned schema
time: 2026-10-26T10:34:51.302706323Z
custom:
Author: aviatco
AuthorLink: https://github.com/aviatco
56 changes: 56 additions & 0 deletions docs/essentials/output_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,62 @@ The configuration is stored in your Fabric CLI configuration file and applies to

## JSON Output Schema

### help in JSON format

Use JSON help to discover commands, arguments, and flags for scripts and automation.

```bash
# Root help
fab --help --output_format json

# Command help
fab mkdir -h --output_format json

# Subcommand help
fab job run --help --output_format json

# Equivalent shorthand
fab job run --help --json

# Help accepts combined short flags
fab ls -lh --output_format json
```

In interactive mode, omit the `fab` prefix:

```text
help --output_format json
help --output_format text
```

JSON help follows this response structure. Array contents depend on the selected
command; root help lists available commands and global flags.

```json
{
"timestamp": "<UTC timestamp>",
"status": "Success",
"command": "<canonical command name>",
"result": {
"data": [
{
"schema_version": "1.0",
"cli_version": "<installed CLI version>",
"description": "<command description>",
"usage": "fab <command> [flags]",
"args": [],
"flags": [],
"aliases": [],
"subcommands": [],
"examples": [],
"notes": [],
"learn_more": []
}
]
}
}
```

### Success Response Structure
```json
{
Expand Down
11 changes: 11 additions & 0 deletions docs/essentials/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ For command-specific parameters:
fab <command> --help
```

For machine-readable help, add `--output_format json`:

```bash
fab job run --help --output_format json
```

`--help`, `-h`, and `-help` support JSON and text. See
[Json format help](output_format.md#help-in-json-format) for the response
contract, format precedence, and offline behavior.

For a complete list of commands, see the [Commands page](../commands/index.md).


Expand Down Expand Up @@ -61,6 +71,7 @@ For a complete list of commands, see the [Commands page](../commands/index.md).
| `--interval` | Specify the interval for `job` schedule |
| `--json` | Use JSON output (same as `--output_format json`) |
| `--mode` | Specify the operational mode for `table load` |
| `--output_format` | Select `json` or `text` for results and help |
| `--retain_n_hours` | Retain specified hours for `table vacuum` |
| `--schedule` | Set the job schedule for `job` |
| `--show_headers` | Turn headers on for `api` |
Expand Down
Loading
Loading