eureka

eureka is a CLI tool that allows you to quickly write down an idea using your preferred editor, 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 continue working.

It is developed by and for people who enjoy using the terminal.

Required Setup

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.

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

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

Installation

Homebrew

$ brew install eureka

Cargo

$ cargo install eureka

Rust stable version will always be supported

Usage

The first time you run eureka it will ask for the path to your ideas repo. This configuration will be stored in ~/.eureka/.

After the setup simply run eureka to capture an idea. It will then be committed and pushed to the origin remote and the branch name of your choice.

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

$ eureka --view

Flags

--clear-branch    Clear the stored branch name
--clear-repo      Clear the stored path to your idea repo
-v, --view        View ideas with your $PAGER env variable. If unset use less

Recommended alias

An easy to remember alias for eureka is the word idea. This makes it easy to remember to use eureka to store your ideas.

Zsh

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

Bash

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

Development

This repo uses a Makefile as an interface for common operations.

1. Do code changes
2. Run make build link to build the project and create a symlink from the built binary to the root of the project
3. Run ./eureka to execute the binary with your changes
4. Profit ⭐️

Improvements

See github issues.