Backup repository for / imag
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Matthias Beyer 733979609f Merge branch 'rewrite-readme-contrib-etc' into master 4 years ago
.github Rewrite github template 5 years ago
bin Merge branch 'imag-bookmark-remove-collections' into master 4 years ago
doc Rewrite contributing for less (boilerplate) text 4 years ago
etc Add importer for ioverlander into imag-wiki 6 years ago
lib Add functions to get by id and remove with FileLockEntry 4 years ago
scripts Add imag-calendar 4 years ago
tests Add ui test for imag-view 4 years ago
.editorconfig Remove Makefile/html config, set {md,yaml,nix} indent to 4 spaces 7 years ago
.gitignore Ignore Intellij-IDEA dotfiles 6 years ago
.travis.yml Update minimum required rust version to 1.37.0 4 years ago Add changelog 7 years ago Move contributing guidelines to documentation 7 years ago
Cargo.toml Add version-sync tests to ensure we update correctly 4 years ago
LICENSE Add LICENSE file 8 years ago Rewrite README to contain less boilerplate text 4 years ago
default.nix Fix default.nix for new transitive dependency 5 years ago
imagrc.toml Add default configuration for imag-todo show format 4 years ago

imag -

imag is a commandline personal information management suite.

This application is in early development. There are some things that work, but we do not consider anything stable or usable at this moment. Feel free to play around anyways.

Mission statement

Our (long-term) goal is to

Create a fast, scriptable, commandline first, plain-text-only suite of tools to cover all aspects of personal information management.

Yes, imag is a rather ambitious project as it tries to reimplement functionality for several "personal information management aspects". We try to use standards like vcard, icalendar and others wherever possible.

Have a look at the documentation for some more words on this.


Here is how to try imag out.

imag is a suite/collection of tools (like git, for example) and you can build each "module" individually.


Building all crates works with cargo build --all, building individual crates by specifying the --manifest-path flag to cargo. The crates in ./bin are the actual commandline tools, ./bin/core contains a core set of imag commands ("plumbing" in git-speak) and ./bin/domain contains domain-specific imag commands, for example a todo tool or a bookmark tool.


After you build the module you want to play with, you can simply call the binary itself with the --help flag, to get some help what the module is capable of.

If you installed the module, you can either call imag-<modulename> (if the install-directory is in your $PATH), or install the imag binary to call imag <modulename> (also if everything is in your $PATH). Call imag --help to see which modules are found and can be used. Call imag --versions to print the versions of all modules.

Example usage

As imag is a big and complex project, we cannot show all tools of the suite here. But to give you some idea, here's an example:

# 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'

Staying up-to-date

We have a official website for imag, where I post release notes and monthly(ish) updates what's happening in the source tree (RSS here).

We also have a mailinglist where I post updates and where discussion and questions are encouraged.


We have some documentation in the ./doc subtree which can be compiled to PDF or a website using pandoc. It might not be up to date, though. Developer documentation for the last release is available on

Please contribute!

We are looking for contributors! Feel free to open issues (by writing to the mailinglist) for asking questions, suggesting features or other things!

Also have a look at the file!


Feel free to join our new IRC channel at freenode: #imag or our mailinglist.


We chose to distribute this software under terms of GNU LGPLv2.1.