#note #keep #list #server #clone #google #command

bin+lib term_keep

基于终端的 Google Keep 模拟器。可以作为服务器上的笔记记录/待办事项列表应用。

4 个稳定版本

1.2.1 2024 年 8 月 4 日
1.2.0 2023 年 2 月 7 日
1.1.0 2022 年 11 月 27 日
1.0.0 2022 年 11 月 23 日

#613数据库接口

Download history 83/week @ 2024-07-29 31/week @ 2024-08-05

114 每月下载量

MIT 许可证

220KB
2K SLoC

Term Keep

基于终端的 Google Keep 模拟器。可以作为服务器上的笔记记录/待办事项列表应用。

快速入门

使用 cargo 安装

cargo install term_keep

或者克隆仓库,然后手动安装。之后将可执行文件添加到您的 PATH 中。

cargo build --release

通过定义环境变量 TERM_KEEP_DB_PATH 指定您想要存储数据库的位置。

使用 ~/.bashrc 文件的示例

export TERM_KEEP_DB_PATH=/home/my_user/.term-keep/data.db

执行以下命令以查看子命令列表

term_keep -h

可选地,您可以创建一个别名以使其访问更快更方便

# ~/.bashrc
alias tk=term_keep

描述

动机

如今存在许多笔记或待办事项应用,但大多数都使用图形界面,因此与云服务器兼容的并不多。

此应用可用于存储与您的服务器管理工作相关的备忘录或任务,例如待完成的计划、需要备份的数据相关的任务或需要工作的不完整的配置文件。

功能

要获取功能列表的完整列表,请执行帮助命令

term_keep -h

笔记和任务

支持两种类型的笔记

  1. 普通笔记:适用于备忘录和存储任意信息。
  2. 任务:需要完成的任务。每个任务具有三种可能的状态之一:待办(未开始)、进行中和完成。

编辑器无关编辑

创建或编辑笔记时,Term Keep 仅打开默认编辑器。这意味着您可以使用 Vim、Nano、Neovim 或您喜欢的任何编辑器。

可以通过环境变量 EDITOR 配置编辑器。

Markdown

可以使用 markdown 格式化笔记,由 termimad 库提供支持。

检查列表

您还可以在笔记中创建检查列表,类似于在 GitHub issues 中处理任务列表的方式。

Today's tasks

- [] Clean my room
- [] Do 3 hours of work
- [x] Shower

当显示笔记内容时,将以简单的格式和着色显示。

模板

您可以从之前创建的模板创建笔记。

探索与模板相关的命令

term_keep -h | grep template

# Help for individual commands
term_keep templates -h
term_keep upsert-template -h
term_keep remove-template -h

# etc

配置

环境变量

变量名 描述 示例
EDITOR 要使用的编辑器 vim
TERM_KEEP_DB_PATH 存储数据库文件的路径 ~/.term-keep/test.db
TERM_KEEP_SUMMARY_MAX_LENGTH 截断笔记摘要前显示的字符数(当执行主命令 term_keep 时) 100
TERM_KEEP_HIDE_LOGO 隐藏徽标。默认情况下显示徽标。 0(false)或 1(true)。

开发

使用的工具

  • Rust(带有Cargo)
  • SQLite

格式

cargo fmt

代码检查

cargo clippy

测试

cargo test

依赖项

~33–45MB
~738K SLoC