Skip to content

Commit

Permalink
Fix the CLI docs (qmk#6979)
Browse files Browse the repository at this point in the history
- Sort the commands alphabetically
- Add missing `json_keymap`
- Correct underscore to dash
  • Loading branch information
stjohnjohnson authored and zvecr committed Oct 29, 2019
1 parent afc5cb7 commit e0e2695
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 11 deletions.
30 changes: 20 additions & 10 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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).
Expand Down Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion lib/python/qmk/cli/json/keymap.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

@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.
Expand Down

0 comments on commit e0e2695

Please sign in to comment.