eureka is a CLI tool that allows you to quickly write down your idea with the editor of your
choice, and then have the idea committed and pushed to your idea git repository.
Imagine working on something important and then having an idea. Instead of letting your idea
slip by you can just type
eureka and you're able to quickly store your idea and then
It's developed by and for people who enjoy using the terminal.
eureka requires a git repository with a
README.md in the root folder. This is the default
structure when you create an empty repository with a readme on GitHub, so it's easy to start using
it. And since it's your own repository you can make it private to keep your ideas secret.
$ cargo install eureka
Use the same command to update
eureka to the latest version.
The first time you run
eureka it will ask a few questions regarding your setup. This configuration
will be stored in
After the setup is complete you simply run:
When your idea is committed it's pushed to
To view your stored ideas use the
$ eureka --view
--clear-editor Clear the stored path to your idea editor --clear-repo Clear the stored path to your idea repo -v, --view View your ideas using less
An easy to remember alias for
eureka is the word
idea. This makes it easy to remember to use
eureka to store your ideas.
echo 'alias idea="eureka"' >> ~/.zshrc
echo 'alias idea="eureka"' >> ~/.bashrc
This repo uses a Makefile as an interface for common operations.
- Do code changes
make build linkto build the project and create a symlink from the built binary to the root of the project
./eurekato execute the binary with your changes
See github issues.