Eureka
出自 Eureka 的 README
- Eureka 是一个 CLI 工具,允许您使用您偏好的编辑器快速写下想法,然后将想法提交并推送到您的想法 git 仓库。
安装
安装 eureka-notesAUR 软件包。
配置
Eureka 目前不支持任何复杂的配置。 但是,当您首次执行 eureka 时,它会生成自己的配置。
当您第一次执行 eureka 时,它会要求您输入您想要使用的仓库的完整路径,这是一个包含 README.md 文件的 git 仓库。 对于此设置,我们将 eureka 数据存储在您当前登录用户的 home 目录下。
首先,确保您位于您的 home 目录中。
$ cd
然后创建 eureka 目录,并进入该目录。
$ mkdir eureka && cd eureka
然后在 eureka 目录中初始化一个新的 git 仓库。
$ git init
然后创建 README.md
文件,笔记将存储在该文件中。
$ touch README.md
恭喜,您已创建 eureka 存储目录,现在为了保护这些笔记免受数据丢失的影响,例如您摔坏笔记本电脑并丢失所有数据,eureka 会自动将您对笔记所做的每次更改推送到 "origin" 远程仓库,因此我们必须添加此远程仓库。
可以使用任何 git 提供商,例如 Github 或 Gitlab,只要您对您想要使用的仓库具有读/写权限,一旦您创建了仓库,复制 ssh 链接并将其复制到以下命令中
git remote add origin ssh-url
- 使用您想要使用的仓库的 ssh url
最后,您已准备好启动 eureka,一旦执行,eureka 将要求您输入仓库的完整路径,输入 /home/user/eureka
。
Eureka 将以 json 格式自动生成您的配置,您可以在 $HOME/.config/eureka/config.json
找到配置文件。
故障排除
无法找到二进制路径错误
如果您收到以下错误 ERROR eureka > cannot find binary path
,当未设置 EDITOR 环境变量 时,Eureka 默认使用 vi 编辑器。
如果您不想全局定义环境变量,您可以始终在执行 eureka 时内联定义它,以下是使用 neovim 和 eureka 而不设置任何环境变量的示例
$ EDITOR=nvim eureka
没有该文件或目录错误
如果您收到以下错误 ERROR eureka > No such file or directory (os error 2)
,Eureka 尝试查找您在首次启动时定义的目录,但找不到它,或者该目录不包含 eureka 运行所必需的 README.md
文件。