Kamiya is a no-nonsense note taking app that runs in terminal. It stores all your notes in database so it makes easier to store your notes.
- Works faster. Kamiya is designed to be as fast as possible. To do this, we use modern technology.
- Lightweight database. Kamiya's database have a small size so it can fit for users who care about file sizes.
- Easy to use. Kamiya has nothing hard to do for regular user. Only you need is have any terminal.
- Easy to backup. You can backup your notes database by yourself or with integrated tools.
- Best choice for terminal. If you are a regular terminal user or using editors like (neo)vim, and you need to make notes - it's a good choice for you.
You have some ways to install Kamiya. Here is some of possible:
- Install
rustup
and install latest stable Rust toolchain. - Install compiler that required for your system.
- Run
cargo install kamiya
and wait until cargo build Kamiya for you. - After build you can run Kamiya from your terminal!
- Go to releases page.
- Download a version that matches your OS and architecture.
- Unpack executable file from archive and place it in directory which is exists in
PATH
variable. - (Additional) Make file executable if it's not.
- Install
rustup
and install latest stable Rust toolchain. - Clone this repository and enter their directory.
- Run
cargo build
to compile debug executable, orcargo build --release
to compile optimized executable. If you have encountered some problems when compiling Kamiya on Windows, try to compile it with WSL. - Executable file will appear in
/target/[debug, release]
directory. You can move them to directory which exists inPATH
variable.
Kamiya have an easy usage structure.
kamiya <command> [argument, ..]
Some commands dont require arguments.
To make note, use take
command and pass content to save.
kamiya take "This content will be saved."
Also, you can provide a name for your note with --name
or -n
argument.
If not, Kamiya will generate the name for you note depending on configuration.
kamiya take "This content will be saved." -n "My Awesome Note"
You can check for notes which are saved in your database with list
command.
kamiya list
You can search for note that you need.
Just use search
command and pass the name of note that you need to find.
kamiya search "My Awesome Note"
It's not necessary to specify the full name of the note. It's enough to write part of his name, and Kamiya will find notes with similar characters in the name.
kamiya search Awesome
You can use get
command to get the content of note by passing the name of note.
kamiya get "My Awesome Note"
Just use help
command to get full list of available commands or --help
to get help about specific command.
kamiya help # Get list of available commands.
kamiya take --help # Get help for `take` command.
The first time Kamiya is started, it will create a configuration file at user's home directory at .config/kamiya/config.toml
.
It's a TOML file and has the following structure.
[options]
name_template = "Note&i"
editor = "nano"
name_template
- An example of a title for a new note. Note that the contents of this option must contain&i
, otherwise the program will give an error.editor
- Which editor will be opened to edit note content.
You can edit this options with Kamiya by using this commands:
editor
- set editor.template
set note name template.
If you encounter a problem, feel free to report about it on GitHub or GitLab issues of Kamiya.
We are welcome new contributors to Kamiya! Feel free to fork this reposotiry, make changes that you want to suggest and create merge request.