WaniKani CLI Tool is a command line interface (CLI) tool designed to connect to the WaniKani API to retrieve and display personal learning statistics for Japanese learners. It is written in Go and uses a TUI library to create an interactive and visually pleasing interface.
With WaniKani CLI Tool, you can quickly and easily check your current level, review statistics, and progress charts. It's perfect for those who want to keep track of their WaniKani learning journey without having to navigate through the WaniKani website.
Screen.Recording.2023-03-05.at.16.40.31.mov
- Interactive and user-friendly TUI
- Display of current level, review statistics, and progress charts
- Quick and easy access to personal learning statistics
- Secure and reliable connection to the WaniKani API
To install WaniKani CLI Tool, simply clone the repository and build the binary file using the following command:
$ git clone git@github.com:RandolfTjandra/wk.git
$ cd wk
$ export WK_KEY="your wanikani api key"
$ make local
Once you have built the binary, you can run the tool using the following command:
$ wk
This assumes /usr/local/bin is in your $PATH
When you run WaniKani CLI Tool, you will be prompted to enter your API key. You can find your API key on the WaniKani website by going to the API Tokens section of your account settings.
(Right now you have to enter your API key into pkg/wanikani/config.go manually)
Once you have entered your API key, make and run the application. From there, you can navigate through the various options using the arrow keys and enter key.
We welcome contributions to WaniKani CLI Tool! If you find a bug or have an idea for a new feature, please open an issue on the repository. If you would like to contribute code, please fork the repository and submit a pull request.
WaniKani CLI Tool is released under the MIT License. See LICENSE for more information.