🗒️ 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仓库