Fix the CLI docs (#6979)
- Sort the commands alphabetically - Add missing `json_keymap` - Correct underscore to dash
This commit is contained in:
		
							parent
							
								
									afc5cb7f0a
								
							
						
					
					
						commit
						e0e26957d4
					
				
					 2 changed files with 21 additions and 11 deletions
				
			
		
							
								
								
									
										30
									
								
								docs/cli.md
									
										
									
									
									
								
							
							
						
						
									
										30
									
								
								docs/cli.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -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`
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue