NIKA

Nika is a command-line interface (CLI) tool designed to make learning Japanese a part of your daily routine right within your terminal. This project is my first Rust application, developed to support my Japanese studies and Rust programming skills.

Features

Main Features:

• Dictionary updater
• Dictionary simple search
• Random words
• User preferences (e.g. number of daily words)
• Study lists
• Daily words
• Mark word/kanji status (skipped, done, etc.)
• Progress tracking (e.g. streak, average words per day)
• Word details (e.g. examples, links to online dictionaries)
• Dictionary advanced search
• Kanji
• Shell completion

Future Features:

• DBpedia definitions
• Morphological analysis of sentences
• Daily grammar
• Favorites
• History
• SRS
• Similar words

Requirements

This project has the following requirements:

• Rust and Cargo: Cargo is the package manager for Rust. It is needed to build and run the project.
• Crontab: Cron is a time-based job scheduler in Unix-like operating systems. It is used in this project to maintain the dictionary updated.

Installation

Clone the repo:

git clone https://github.com/saiteki-kai/nika
cd nika/

Run the installer:

chmod +x install.sh
./install.sh

Usage

To get started with Nika, run the following command:

nika --help

The dictionary is automatically updated through a cron job every 3 days. However, if you want to update the dictionary manually, you can do so by running the following command:

nika-updater

If you want to display daily words every time you open the terminal, add the following line to your shell configuration file (.zshrc, .bashrc, ...):

clear && nika study daily -s

You can use the less command to easily scroll through the daily words:

nika study daily | less

License

The original source code of this project is licensed under the terms of the GPLv3 license.

JMDICT & KANJIDIC

This package uses the JMdict/EDICT and KANJIDIC dictionary files. These files are the property of the Electronic Dictionary Research and Development Group, and are used in conformance with the Group's licence.

The modified versions of these files are sourced from jmdict-simplified.