🗒️ Kamiya

Kamiya 是一个简洁的笔记应用，在终端中运行。它将所有笔记存储在数据库中，这使得存储笔记更加容易。

✨ 特点

• 运行更快。 Kamiya 被设计得尽可能快。为此，我们使用了现代技术。
• 轻量级数据库。 Kamiya 的数据库体积小巧，适合关心文件大小的用户。
• 易于使用。 Kamiya 对普通用户来说没有任何复杂的功能。你只需要一个终端。
• 易于备份。 您可以自己或使用集成工具备份您的笔记数据库。
• 终端的最佳选择。 如果您是普通终端用户或使用（neo）vim 等编辑器，并且需要做笔记，它是一个不错的选择。

💾 安装

您有几种方法可以安装Kamiya。以下是一些可能的方法

使用 cargo 安装

1. 安装 rustup 并安装最新的稳定Rust工具链。
2. 安装适用于您的系统的编译器。
3. 运行 cargo install kamiya 并等待 cargo 为您构建 Kamiya。
4. 构建完成后，您可以从终端运行 Kamiya！

从版本中安装

1. 转到版本页面。
2. 下载与您的操作系统和架构匹配的版本。
3. 从存档中解压可执行文件并将其放置在存在于 PATH 变量中的目录中。
4. (附加) 如果不是可执行文件，请将其设置为可执行。

从源代码构建

1. 安装 rustup 并安装最新的稳定Rust工具链。
2. 克隆此存储库并进入其目录。
3. 运行 cargo build 编译调试可执行文件，或运行 cargo build --release 编译优化可执行文件。如果在 Windows 上编译 Kamiya 时遇到一些问题，请尝试使用 WSL 编译。
4. 可执行文件将出现在 /target/[debug, release] 目录中。您可以将它们移动到存在于 PATH 变量中的目录。

⌨️ 使用方法

结构

Kamiya 的使用结构简单。

kamiya <command> [argument, ..]

一些命令不需要参数。

撰写您的第一条笔记。

要创建笔记，请使用 take 命令并传递要保存的内容。

kamiya take "This content will be saved."

此外，您可以使用 --name 或 -n 参数为您的笔记提供名称。如果不提供，Kamiya 将根据配置为您生成名称。

kamiya take "This content will be saved." -n "My Awesome Note"

查看保存的笔记。

您可以使用 list 命令检查数据库中保存的笔记。

kamiya list

搜索笔记。

您可以搜索所需的笔记。只需使用 search 命令并传递您要查找的笔记名称。

kamiya search "My Awesome Note"

不必指定笔记的全名。只需写下名称的一部分，Kamiya 就会找到名称中包含相似字符的笔记。

kamiya search Awesome

获取笔记内容。

您可以使用 get 命令通过传递笔记名称来获取笔记的内容。

kamiya get "My Awesome Note"

获取帮助。

只需使用 help 命令即可获取所有可用命令的完整列表，或使用 --help 获取特定命令的帮助。

kamiya help        # Get list of available commands.
kamiya take --help # Get help for `take` command.

⚙️ 配置

Kamiya 首次启动时，将在用户的 .config 目录中创建一个名为 kamiya.yml 的配置文件。这是一个 YAML 文件，具有以下结构。

options:
    name_template: NewNote&i
    editor: nano
entries: []

• name_template - 新笔记标题的示例。请注意，此选项的内容必须包含 &i，否则程序将报错。
• editor - 将打开哪个编辑器来编辑笔记内容。
• entries - 您已保存的笔记数组。 不要编辑。

📨 报告问题

如果您遇到问题，请随时在 Kamiya 的 GitHub 或 GitLab 问题中报告。

📦 贡献

我们欢迎新的贡献者加入 Kamiya！请随意fork此存储库，进行您想要提出的更改，并创建合并请求。

🪐 链接

• GitHub 存储库
• GitLab 存储库