This repository contains several tools for working with Johnny Decimal systems.
From source
-
Install rust. Go to the rust installation page and follow the instructions.
-
Clone the repository.
git clone https://github.com/Tallented-code-bot/johnnydecimal
cd johnnydecimal- Compile the project.
cargo build --release- Move the binary to somewhere on your
path. For example, you might move it to~/.local/bin/if you are on Linux. Important: the binary is calledjd, notjohnnydecimal.
mv ./target/release/jd ~/.local/bin/From binary
-
Download the zip or tar file for your OS from the release page.
-
If you are on windows, extract the zip file. If you are on mac/linux, you can extract the tar.gz file like this.
tar -xvf <tar.gz file>- Move the
jdorjd.exeexecutable to somewhere on your path. On linux a good place could be~/.local/bin/.
This enables you to easily cd to any johnnydecimal number.
If you do not want this, you can skip it.
Fish
Add this to your configuration, usually found at ~/.config/fish/config.fish.
jd init fish | sourceBash
Add this to your configuration, usually found at ~/.bashrc.
eval "$(jd init bash)"Zsh
Add this to your configuration, usually found at ~/.zshrc.
eval "$(jd init zsh)"The first thing you need to do is index your Johnny Decimal system.
-
Go to the folder above your Johnny Decimal root folder. For example, if your root folder is
~/jd, you would go to~. -
Run
jd index <ROOT_FOLDER>. For this example, you would runjd index jd/. This will look at all your files and write the index to<ROOT_FOLDER>/.JdIndex. -
As long as you are inside your root folder, you can use
jd. You could show all your JD numbers withjd show, you could add a new one withjd add <CATEGORY>, or you could go to a specific one withj <JD_NUMBER>(assuming that you added the config to your shell!).
This project is under the GNU GPL-3 license. (You can view the license here.)
Feel free to contribute to this project, either by submitting a pull request or by adding an issue.