🗒️ 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贡献者！请随意分支此存储库，提出您想建议的更改并创建合并请求。

🪐 链接

• GitHub仓库
• GitLab仓库