#imag #information #personal #management #pim

bin+lib imag-markdown

imag 核心分布的一部分:imag-markdown 命令

2 个版本

0.10.1 2020 年 2 月 29 日
0.10.0 2019 年 12 月 24 日

#57 in #imag

LGPL-2.1

230KB
4K SLoC

imag - imag-pim.org

imag 是一个命令行个人信息管理套件。

此应用程序处于早期开发阶段。有一些功能正在运行,但我们目前不认为任何内容是稳定的或可用的。不过,您可以随意尝试。

使命宣言

我们的(长期)目标是

创建一个快速、可脚本化、以命令行为首、仅使用纯文本的工具套件,涵盖个人信息管理的所有方面。

是的,imag 是一个相当雄心勃勃的项目,因为它试图重新实现几个“个人信息管理方面”的功能。我们尽可能使用标准,如 vcard、icalendar 等。

有关此内容的更多内容,请参阅 文档

构建/运行

以下是尝试 imag 的方法。

imag 是一个 套件/集合 工具(例如 git),您可以单独构建每个“模块”。

构建

使用 cargo build --all 命令构建所有包,通过指定 cargo 的 --manifest-path 标志来构建单个包。./bin 目录中的包是实际的命令行工具,./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 条件下分发此软件。

依赖关系

~14–25MB
~407K SLoC