{"id":13478761,"url":"https://github.com/simeg/eureka","last_synced_at":"2025-05-15T14:06:10.851Z","repository":{"id":27139403,"uuid":"111455319","full_name":"simeg/eureka","owner":"simeg","description":"💡 CLI tool to input and store your ideas without leaving the terminal","archived":false,"fork":false,"pushed_at":"2023-11-04T06:12:54.000Z","size":8843,"stargazers_count":811,"open_issues_count":7,"forks_count":42,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-11T18:46:57.508Z","etag":null,"topics":["cli","command-line","idea","ideas","productivity","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simeg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-11-20T19:45:20.000Z","updated_at":"2025-05-09T21:51:57.000Z","dependencies_parsed_at":"2024-01-03T04:10:53.283Z","dependency_job_id":"75571b05-0833-4af6-980d-dc454eb04bc7","html_url":"https://github.com/simeg/eureka","commit_stats":{"total_commits":239,"total_committers":10,"mean_commits":23.9,"dds":0.4728033472803347,"last_synced_commit":"ba2b16fcd73663603de8c12fb8c4a0b658f62ffb"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simeg%2Feureka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simeg%2Feureka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simeg%2Feureka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simeg%2Feureka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simeg","download_url":"https://codeload.github.com/simeg/eureka/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355335,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","idea","ideas","productivity","rust","terminal"],"created_at":"2024-07-31T16:02:02.405Z","updated_at":"2025-05-15T14:06:05.827Z","avatar_url":"https://github.com/simeg.png","language":"Rust","readme":"# eureka [![Crate Status](https://img.shields.io/crates/v/eureka.svg)](https://crates.io/crates/eureka) ![CI](https://github.com/simeg/eureka/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/simeg/eureka/branch/master/graph/badge.svg)](https://codecov.io/gh/simeg/eureka)\n`eureka` is a CLI tool that allows you to quickly write down an idea using your\npreferred editor, and then have the idea committed and pushed to your idea\ngit repository.\n\nImagine working on something important and then having an idea. Instead of\nletting your idea slip by you can just type `eureka` and you're able to quickly\nstore your idea and then continue working.\n\n![demo](assets/demo.gif)\n\n## Required Setup\n`eureka` requires a git repository with a `README.md` in the root folder. This\nis the default structure when you create an empty repository with a readme on\nGitHub, so it's easy to start using it. And since it's your own repository you\ncan make it private to keep your ideas secret.\n\n`eureka` looks at your environment variables to decide what program to use.\n* `$EDITOR` for what to edit your ideas with (falls back to `vi`)\n* `$PAGER` for what to view your ideas with (falls back to `less`)\n\n## Installation\n\n**[Homebrew](https://brew.sh/)**\n```sh\n$ brew install eureka\n```\n\n**[Cargo](https://doc.rust-lang.org/cargo)**\n```sh\n$ cargo install eureka\n```\n\n_Rust stable version will always be supported_\n\n## Usage\nThe first time you run `eureka` it will ask for the path to your ideas repo.\nThis configuration will be stored in your [XDG Base Directory](https://wiki.archlinux.org/title/XDG_Base_Directory) if found, otherwise in `$HOME/.config/eureka`.\n\nAfter the setup simply run `eureka` to capture an idea. It will then be \ncommitted and pushed to the `origin` remote and the `main` branch.\n\nView your stored ideas with the `-v` or `--view` flag.\n\n```sh\n$ eureka --view\n```\n\n### Flags\n\n```sh\n    --clear-config    Clear your stored configuration\n-v, --view            View ideas with your $PAGER env variable. If unset use less\n```\n\n### Recommended alias\nAn easy to remember alias for `eureka` is the word `idea`. This makes it easy\nto remember to use `eureka` to store your ideas.\n\n**Zsh**\n```sh\necho 'alias idea=\"eureka\"' \u003e\u003e ~/.zshrc\n```\n\n**Bash**\n```sh\necho 'alias idea=\"eureka\"' \u003e\u003e ~/.bashrc\n```\n\n**Fish**\n```sh\necho 'alias idea=\"eureka\"' \u003e\u003e ~/.config/fish/config.fish\n```\n\n## Improvements\nSee [github issues](https://github.com/simeg/eureka/issues).\n","funding_links":[],"categories":["Productivity","Rust","Applications","Tools","cli","Developer Tools","\u003ca name=\"note-taking\"\u003e\u003c/a\u003eNote taking"],"sub_categories":["Note Taking and Lists","Productivity","Rust","Command Line Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimeg%2Feureka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimeg%2Feureka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimeg%2Feureka/lists"}