Eureka
Eureka の README から:
Eureka は、自分の好きなエディターを使って素早くアイデアを書き留め、アイデアをコミットして idea git リポジトリにプッシュすることができる CLI ツールです。
目次
インストール
設定
Eureka は現在、複雑な設定をサポートしていません。ただし、最初に eureka を実行すると、独自の設定が生成されます。
eureka を最初に実行すると、使用するリポジトリのフルパスを聞かれます。これは README.md ファイルを含む git リポジトリです。今回の設定では、ログインしているユーザーのホームディレクトリにeureka のデータを保存することにします。
cd
- ホームディレクトリにいることを確認してください
mkdir eureka
- eureka ディレクトリを作成する
cd eureka
- eureka ディレクトリに入る
git init
- eureka ディレクトリ内で新しい git リポジトリを初期化する
touch README.md
- eureka が探す README.md ファイルを作成します (このファイルが見つからない場合はエラーになります。)
eureka のストレージディレクトリが作成されました。ノートパソコンを落としてデータが消えてしまわないように、eureka はノートに加えた変更を自動的に origin リモートにプッシュします。
git プロバイダは、利用したいリポジトリへの読み書き権限があれば、Github や Gitlab など、どれでも構いません。リポジトリを作成したら、 ssh リンクをコピーして、次のコマンドにコピーしてください。
git remote add origin ssh-url
- 使用したいリポジトリの ssh URL とともに
最後に、eureka を起動する準備ができました。eureka を実行すると、リポジトリへのフルパスを聞かれるので、 /home/user/eureka
と入力してください。
設定ファイルは $HOME/.config/eureka/config.json
に格納されています。
Troubleshooting
Cannot find binary path error
If you get the following error ERROR eureka > cannot find binary path
, Eureka defaults to the vi editor when no EDITOR environment variable is set.
If you do not want to define the environment variable globally, you can always define it inline when executing eureka, below is an example with using eureka with neovim without any environment variable set:
$ EDITOR=nvim eureka
No such file or directory error
If you get the following error ERROR eureka > No such file or directory (os error 2)
Eureka has attempted to look for the directory you defined on first startup, and could not find it, or the directory does not contain the README.md
file which must be present for eureka to function.