2 个版本
0.10.1 | 2020 年 2 月 29 日 |
---|---|
0.10.0 | 2019 年 12 月 24 日 |
#61 在 #imag
在 imag 中使用
320KB
5.5K SLoC
imag - imag-pim.org
imag
是一个命令行个人信息管理套件。
此应用程序处于早期开发阶段。有一些功能是可行的,但我们目前不认为任何功能是稳定或可用的。尽管如此,请随意尝试。
使命宣言
我们的(长期)目标是
创建一个快速、可脚本化、以命令行为先、仅文本的套件工具,以涵盖个人信息管理的各个方面。
是的,imag 是一个相当雄心勃勃的项目,因为它试图重新实现多个“个人信息管理方面”的功能。我们尽可能地使用标准,如 vcard、icalendar 等。
有关更多详细信息,请参阅 文档。
构建/运行
以下是尝试 imag
的方法。
imag
是一个 套件/集合 工具(例如 git),您可以单独构建每个 "模块"。
构建
使用 cargo build --all
命令构建所有 crate,通过指定 cargo 的 --manifest-path
标志来构建单个 crate。./bin 中的 crate 是实际的命令行工具,./bin/core 包含 imag 命令的核心集合(在 git 中称为 "管道")和 ./bin/domain 包含特定领域的 imag 命令,例如待办事项工具或书签工具。
运行
构建您想要尝试的模块后,您可以通过使用 --help
标志来调用二进制文件本身,以获取有关模块可以做什么的帮助。
如果您已安装该模块,您可以通过调用 imag-<modulename>
(如果安装目录位于您的 $PATH
中),或将 imag
二进制文件安装以调用 imag <modulename>
(同样,如果所有内容都在您的 $PATH
中)。通过调用 imag --help
来查看哪些模块被发现并可使用。通过调用 imag --versions
来打印所有模块的版本。
示例用法
由于 imag 是一个庞大而复杂的项目,我们无法在这里展示所有工具。但为了给您一些启示,这里有一个示例
# Lets initialize imag
imag init
# Recursively import vcf files
imag contact import /home/user/contacts
# Create a contact (vcf) in the private collection
imag contact create --file /home/user/contacts/private
# Add a diary entry
imag diary -p private create
# Uh, I forgot something in a diary entry, select one (or multiple) and edit it
# use the `fzf` tool here (not a part of imag) to select from the IDs
imag diary -p private list | fzf -m | imag edit
# Link a contact to the diary entry
imag link diary/private/2018/01/01/00:00:00 contact/bc222298-casf-40a4-bda1-50aa980a68c9
# Annotate a contact with some notes
imag annotate add contact/bc222298-casf-40a4-bda1-50aa980a68c9 contact-notes
# Write down some notes named "pineapple"
imag notes create "pineapple"
# Where was that contact again?
imag grep Eva # also possible with `imag contact find Eva`
# Okay, we need to add some imag-internal notes to that contact
imag grep Eva -l | imag edit
# Now save our work
imag git add . # "imag-git" simply calls git in the imag store
imag git commit -m 'Commit message'
保持最新状态
我们有一个 imag 的官方网站,我在那里发布 发行说明 和每月(左右)更新,介绍源树中发生的事情(RSS 在这里)。
我们还有一个 邮件列表,我在那里发布更新,并鼓励讨论和提问。
文档
我们在 ./doc 子目录 中有一些文档,可以使用 pandoc 编译成 PDF 或网站。不过,可能不是最新的。最新版本的开发者文档可在 docs.rs 上找到。
请贡献力量!
我们正在寻找贡献者!您可以自由地通过 邮件列表 开启问题(提问、建议功能或其他事项)!
还可以查看 CONTRIBUTING.md 文件!
联系方式
欢迎加入我们在 freenode 的新 IRC 频道:#imag 或我们的 邮件列表。
许可协议
我们选择根据 GNU LGPLv2.1 协议分发此软件。
依赖关系
~17–29MB
~483K SLoC