~ruther/qmk_firmware

e0e26957d43018998c405783a2609b99f0e098a7 — St. John Johnson 5 years ago afc5cb7
Fix the CLI docs (#6979)

- Sort the commands alphabetically
- Add missing `json_keymap`
- Correct underscore to dash
2 files changed, 21 insertions(+), 11 deletions(-)

M docs/cli.md
M lib/python/qmk/cli/json/keymap.py
M docs/cli.md => docs/cli.md +20 -10
@@ 69,6 69,16 @@ There are some limitations to the local CLI compared to the global CLI:

# CLI Commands

## `qmk cformat`

This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files.

**Usage**:

```
qmk cformat [file1] [file2] [...] [fileN]
```

## `qmk compile`

This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo.


@@ 85,16 95,6 @@ qmk compile <configuratorExport.json>
qmk compile -kb <keyboard_name> -km <keymap_name>
```

## `qmk cformat`

This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files.

**Usage**:

```
qmk cformat [file1] [file2] [...] [fileN]
```

## `qmk config`

This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md).


@@ 125,6 125,16 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor
```

## `qmk json-keymap`

Creates a keymap.c from a QMK Configurator export.

**Usage**:

```
qmk json-keymap [-o OUTPUT] filename
```

## `qmk list-keyboards`

This command lists all the keyboards currently defined in `qmk_firmware`

M lib/python/qmk/cli/json/keymap.py => lib/python/qmk/cli/json/keymap.py +1 -1
@@ 11,7 11,7 @@ import qmk.keymap

@cli.argument('-o', '--output', arg_only=True, help='File to write to')
@cli.argument('filename', arg_only=True, help='Configurator JSON file')
@cli.subcommand('Create a keymap.c from a QMK Configurator export.')
@cli.subcommand('Creates a keymap.c from a QMK Configurator export.')
def json_keymap(cli):
    """Generate a keymap.c from a configurator export.