Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add cli convert subcommand, from raw KLE to JSON #6898

Merged
merged 19 commits into from
Nov 13, 2019
Merged

Add cli convert subcommand, from raw KLE to JSON #6898

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
840f216
Add initial pass at KLE convert
cfbender Oct 4, 2019
28dac30
Add cli log on convert
cfbender Oct 4, 2019
825bd31
Move kle2xy, add absolute filepath arg support
cfbender Oct 4, 2019
edb7c52
Add overwrite flag, and context sensitive conversion
cfbender Oct 4, 2019
fe7c625
Update docs/cli.md
cfbender Oct 4, 2019
00122a3
Fix converter.py typo
cfbender Oct 4, 2019
a7a675f
Add convert unit test
cfbender Oct 4, 2019
ae5df8d
Rename to kle2qmk
cfbender Oct 6, 2019
23a278f
Rename subcommand
cfbender Oct 6, 2019
0ab880d
Rename subcommand to kle2json
cfbender Oct 7, 2019
5435425
Change tests to cover rename
cfbender Oct 7, 2019
45617d7
Rename in __init__.py
cfbender Oct 8, 2019
2ef5baa
Update CLI docs with new subcommand name
cfbender Oct 8, 2019
95315c1
Fix from suggestions in PR #6898
cfbender Oct 8, 2019
e3400b7
Help with cases of case sensitivity
cfbender Oct 8, 2019
30f3b91
Update cli.md
skullydazed Nov 13, 2019
09d8faa
Use angle brackets to indicate required option
skullydazed Nov 13, 2019
0f0f339
Make the output text more accurate
skullydazed Nov 13, 2019
180e595
Merge branch 'master' into cli-convert
skullydazed Nov 13, 2019
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
Prev Previous commit
Next Next commit
Update CLI docs with new subcommand name
  • Loading branch information
@cfbender
cfbender committed Oct 8, 2019
commit 2ef5baa4e6e4bdc7110db784a617d43e5481d26d
10 changes: 5 additions & 5 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,30 +85,30 @@ qmk compile <configuratorExport.json>
qmk compile -kb <keyboard_name> -km <keymap_name>
```

## `qmk convert`
## `qmk kle2json`

This command allows you to convert from raw KLE data to qmk configurator json. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite.
cfbender marked this conversation as resolved.
Show resolved Hide resolved

**Usage**:

```
qmk convert [filename] [-f]
qmk kle2json [filename] [-f]
```
**Examples**:

```
$ qmk convert ~/github/qmk_firmware/kle.txt
$ qmk kle2json ~/github/qmk_firmware/kle.txt
☒ File /home/cody/github/qmk_firmware/info.json already exists, use -f or --force to overwrite.
...
$ qmk convert ~/github/qmk_firmware/kle.txt -f
$ qmk kle2json ~/github/qmk_firmware/kle.txt -f
Ψ Wrote keymap to /home/cody/github/qmk_firmware/info.json

```

or if cwd is already `~/github/qmk_firmware/`:

```
$ qmk convert kle.txt -f
$ qmk kle2json kle.txt -f
Ψ Wrote keymap to /home/cody/github/qmk_firmware/info.json
```

Expand Down