Repository files navigation

eureka is a CLI tool that allows you to quickly write down an idea using yourpreferred editor, and then have the idea committed and pushed to your ideagit repository.

Imagine working on something important and then having an idea. Instead ofletting your idea slip by you can just typeeureka and you're able to quicklystore your idea and then continue working.

eureka requires a git repository with aREADME.md in the root folder. Thisis the default structure when you create an empty repository with a readme onGitHub, so it's easy to start using it. And since it's your own repository youcan make it private to keep your ideas secret.

eureka looks at your environment variables to decide what program to use.

• $EDITOR for what to edit your ideas with (falls back tovi)
• $PAGER for what to view your ideas with (falls back toless)

Homebrew

$ brew install eureka

Cargo

$ cargo install eureka

Rust stable version will always be supported

The first time you runeureka it will ask for the path to your ideas repo.This configuration will be stored in yourXDG Base Directory if found, otherwise in$HOME/.config/eureka.

After the setup simply runeureka to capture an idea. It will then becommitted and pushed to theorigin remote and themain branch.

View your stored ideas with the-v or--view flag.

$ eureka --view

    --clear-config    Clear your stored configuration-v, --view            View ideas with your$PAGER env variable. Ifunset use less

An easy to remember alias foreureka is the wordidea. This makes it easyto remember to useeureka to store your ideas.

Zsh

echo'alias idea="eureka"'>>~/.zshrc

Bash

echo'alias idea="eureka"'>>~/.bashrc

Fish

echo'alias idea="eureka"'>>~/.config/fish/config.fish

Seegithub issues.