「Eureka」の版間の差分
(英語版から転載) |
(一部翻訳) |
||
1行目: | 1行目: | ||
[[en:Eureka]] |
[[en:Eureka]] |
||
− | + | [https://github.com/simeg/eureka Eureka] の README から: |
|
+ | Eureka は、自分の好きなエディターを使って素早くアイデアを書き留め、アイデアをコミットして idea git リポジトリにプッシュすることができる CLI ツールです。 |
||
− | :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. |
||
+ | {{Note|Eureka の上流レポジトリには1年以上動きがなく、開発者に連絡を取ろうとしても失敗しています。このパッケージが更新されることはないでしょうが、ビルドや機能は期待通りです。}} |
||
− | {{Note|Eureka upstream repository has not had any activity for over a year, and attempts to contact the developer has failed. Most likely this package will never be updated, however it still builds and functions as expected.}} |
||
− | == |
+ | == インストール == |
− | + | {{AUR|eureka-notes}} [[インストール]] |
|
− | == |
+ | == 設定 == |
+ | Eureka は現在、複雑な設定をサポートしていません。ただし、最初に eureka を実行すると、独自の設定が生成されます。 |
||
− | Eureka does not currently support any sort of complex configuration. However generates its own configuration when you first execute eureka. |
||
+ | eureka を最初に実行すると、使用するリポジトリのフルパスを聞かれます。これは README.md ファイルを含む git リポジトリです。今回の設定では、ログインしているユーザーのホームディレクトリにeureka のデータを保存することにします。 |
||
− | When you first execute eureka, it will ask you to enter the full path to the repository you would like to use, this is a git repository containing a README.md file. For this setup we will store the eureka data within the home directory of the user you are logged in as. |
||
+ | {{ic|cd}} - ホームディレクトリにいることを確認してください |
||
− | {{ic|cd}} - Ensure you are in your home directory |
||
− | {{ic|mkdir eureka}} - |
+ | {{ic|mkdir eureka}} - eureka ディレクトリを作成する |
− | {{ic|cd eureka}} - |
+ | {{ic|cd eureka}} - eureka ディレクトリに入る |
− | {{ic|git init}} - |
+ | {{ic|git init}} - eureka ディレクトリ内で新しい git リポジトリを初期化する |
− | {{ic|touch README.md}} - |
+ | {{ic|touch README.md}} - eureka が探す README.md ファイルを作成します (このファイルが見つからない場合はエラーになります。) |
+ | eureka のストレージディレクトリが作成されました。ノートパソコンを落としてデータが消えてしまわないように、eureka はノートに加えた変更を自動的に origin リモートにプッシュします。 |
||
− | Congratulations, you have created the eureka storage directory, now in order to keep these notes safe from loss of data, such as you dropping your laptop and losing all the data, eureka automatically pushes to the "origin" remote ever change you make to your notes, so we must add this remote. |
||
+ | git プロバイダは、利用したいリポジトリへの読み書き権限があれば、[https://github.com Github] や [https://gitlab.com Gitlab] など、どれでも構いません。リポジトリを作成したら、 ssh リンクをコピーして、次のコマンドにコピーしてください。 |
||
− | Any git provider can be used, such as [https://github.com Github] or [https://gitlab.com Gitlab] as long as you have read/write permissions to the repository you would like to use, once you have created the repository, copy the ssh link and copy it into the following command: |
||
− | {{ic|git remote add origin ''ssh-url''}} - |
+ | {{ic|git remote add origin ''ssh-url''}} - 使用したいリポジトリの ssh URL とともに |
+ | 最後に、eureka を起動する準備ができました。eureka を実行すると、リポジトリへのフルパスを聞かれるので、 {{ic|/home/''user''/eureka}} と入力してください。 |
||
− | Finally, you are ready to start eureka, once executed eureka will ask for the full path to your repository, enter {{ic|/home/''user''/eureka}}. |
||
− | + | 設定ファイルは {{ic|$HOME/.config/eureka/config.json}} に格納されています。 |
|
== Troubleshooting == |
== Troubleshooting == |
2023年2月16日 (木) 05:08時点における版
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.