Grom

Grom 是一个笔记 CLI。它允许你创建项目特定的笔记以及快速笔记，你还可以拥有每日、每周或每月的日记。

[!警告] 这是项目的早期版本，仍在开发中。代码尚未稳定，可能包含错误。这也是我的第一个 Rust 项目，因此代码可能不是最好的。

安装

目前，唯一支持的安装方法是使用 crates.io 中的以下命令

cargo install grom

配置

Grom 预期在 $HOME/.config/grom 下有一个 'grom.toml' 文件（目前仅支持并测试了 Mac 和 Linux，因此我不知道 Windows 的行为）。文件的正文应如下所示

# These values are the default
[core]
note_dir="~/notes" # defines where the notes are saved
editor="nvim" # which editor to use to open the file. Any command is applicable (just use the actual command not an alias)

用法

Grom 提供 3 个基本功能

• 日记（每日、每周和每月）
• 项目（创建和打开项目）
• 通过 Git 同步（目前支持 init、push 和 pull）

日记

如上所述，grom 提供了每日、每周和每月的日记。要创建日记条目，可以使用以下命令

# to create a daily diary entry. (created under -> <note_dir>/diary/<year>/<month>/<iso_week>/dd-MM-YYYY.md)
grom today

# to create a weekly diary entry (created under -> <note_dir>/diary/<year>/<month>/<iso_week>/week.md)
grom week

# to create a monthly diary entry (created under -> <note_dir>/diary/<year>/<month>/month.md)
grom month

如果这些文件已经存在，grom 将在配置文件中定义的编辑器中打开现有文件。

项目

Grom 还允许你创建项目特定的笔记。要创建/打开项目，可以使用以下命令

# to create a project (created under -> <note_dir>/projects/<project_name>/start.md) 
grom new <project_name>

# to open a project
grom <project_name>

# to use the interactive project selection
grom

通过 Git 同步

通过 Git 仓库同步你的笔记也是可能的。要这样做，你可以使用以下命令

# initialiting the repository
grom init <git_url>

# pushing changes to your repo
grom push <commit_message>

# pulling changes from remote
grom pull

变更日志

见 变更日志