This repository is a mirror (I push to manually) of github.com/matthiasbeyer/imag Do not use this repository for pull-requests or issue tracking. https://github.com/matthiasbeyer/imag
|Matthias Beyer 3767d8d38f Merge pull request #999 from matthiasbeyer/update-chrono||3 years ago|
|.imag-documentation||3 years ago|
|bin||3 years ago|
|doc||3 years ago|
|imag-bookmark||3 years ago|
|imag-counter||3 years ago|
|imag-diary||3 years ago|
|imag-link||3 years ago|
|imag-mail||3 years ago|
|imag-notes||3 years ago|
|imag-ref||3 years ago|
|imag-store||3 years ago|
|imag-tag||3 years ago|
|imag-todo||3 years ago|
|imag-view||3 years ago|
|libimagannotation||3 years ago|
|libimagbookmark||3 years ago|
|libimagcounter||3 years ago|
|libimagdiary||3 years ago|
|libimagentrycategory||3 years ago|
|libimagentrydatetime||3 years ago|
|libimagentryedit||3 years ago|
|libimagentryfilter||3 years ago|
|libimagentrylink||3 years ago|
|libimagentrylist||3 years ago|
|libimagentrymarkdown||3 years ago|
|libimagentrytag||3 years ago|
|libimagentrytimetrack||3 years ago|
|libimagentryview||3 years ago|
|libimagerror||3 years ago|
|libimaginteraction||3 years ago|
|libimagmail||3 years ago|
|libimagnotes||3 years ago|
|libimagref||3 years ago|
|libimagrt||3 years ago|
|libimagstore||3 years ago|
|libimagtimeui||3 years ago|
|libimagtodo||3 years ago|
|libimagutil||3 years ago|
|tests||4 years ago|
|.editorconfig||4 years ago|
|.gitignore||4 years ago|
|.travis.yml||3 years ago|
|CONTRIBUTING.md||3 years ago|
|Cargo.toml||3 years ago|
|LICENSE||4 years ago|
|Makefile||3 years ago|
|README.md||3 years ago|
|default.nix||3 years ago|
|imagrc.toml||3 years ago|
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.
Our (long-term) goal is to
Create a fast, reliable commandline personal information management suite which covers all aspects of personal information management, consists of reusable parts and integrates well with known commandline tools.
imag is a PIM helper. We do not actually implement the PIM functionality, but try to interface with existing PIM tools (via their API or via some standard format they use, e.g. vcard) to make the data they manage linkable and queryable in an uniform way.
imag consists of modules (e.g.
each module covers one PIM aspect.
The initial approach is to use one PIM tool for one module.
So you can use
imag-todo with taskwarrior,
imag-mail with Maildirs and
Here is how to try
imag is a suite/collection of tools (like git, for example) and you can
build them individually.
All subdirectories prefixed with "
libimag" are libraries.
All subdirectories prefixed with
"imag-" are binaries and compiling them will
give you a commandline application.
make to automate the build process.
Make sure to not include some
-j 8 arguments, this will not work as you
There are several targets for each of the sub-crates in the Makefile:
|all||Build everything, debug mode||
|bin||Build all binaries, debug mode||
|lib||Build all libraries, debug mode||
|lib-test||Test all libraries||
|imag-bin||Build only the
|clean||Remove build artifacts||
|install||*||Build everything, release mode, install||
|release||*||Build everything, release mode||
Multi targets are callable for each sub-crate. For example you can call
make imag-store-check to run
cargo check on the
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
<modulename> (also if everything is in your
We also have a mailinglist where I post updates and where discussion and questions are encouraged.
There is a blog series which gets an update once a month on my blog, where entries are tagged "imag". I also post non-regular posts about imag things there.
This is a hobby project, so sometimes things are not optimal and might go unrecognized and slip through. Feel free to open issues about things you notice!
Though, we have some documentation in the ./doc subtree which can be compiled to PDF or a website. These docs are not published anywhere and are not even integrated into our CI, so it might be broken (though it's unlikely). Developer documentation is also available online on github.io and on docs.rs, though they might be a bit outdated.
We are looking for contributors!
There is always a number of complexity/easy tagged issues available in the issue tracker you can start with and we are open to questions!
Feel free to open issues for asking questions, suggesting features or other things!
Also have a look at the CONTRIBUTING.md file!
Have a look at our website where you can find some information on how to get in touch and so on.
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.