# imag - [imag-pim.org](https://imag-pim.org) `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.** ## Goal / What is imag? 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. Yes, imag is a rather ambitious project as it tries to reimplement functionality for several "personal information management aspects". It is a hobby project, keep that in mind. We try to use standards like vcard, icalendar and others wherever possible. Have a look at [the documentation](./doc/) for some more words on this. ## Building/Running Here is how to try `imag` out. `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. ### Building We use `cargo` for building all crates in this repository. Make sure to use a recent `cargo`, at least one with workspace support. Building all crates works with `cargo build --all`, building individual crates by specifying the `--manifest-path` flag to cargo. ### Running 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-` (if the install-directory is in your `$PATH`), or install the `imag` binary to call `imag ` (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: ```bash # 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](https://imag-pim.org), where I post [release notes](https://imag-pim.org/releases/) and monthly(ish) updates what's happening in the source tree ([RSS here](https://imag-pim.org/index.xml)). We also have a [mailinglist](https://imag-pim.org/mailinglist/) where I post updates and where discussion and questions are encouraged. ## Documentation We have some documentation in [the ./doc subtree](./doc/) 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 docs.rs](https://docs.rs/releases/search?query=imag). ## Please contribute! We are looking for contributors! Feel free to open issues (by writing to [the mailinglist](https://imag-pim.org/mailinglist/)) for asking questions, suggesting features or other things! Also have a look at [the CONTRIBUTING.md file](./CONTRIBUTING.md)! ## Contact Feel free to join our new IRC channel at freenode: #imag or our [mailinglist](https://imag-pim.org/mailinglist/). ## License We chose to distribute this software under terms of GNU LGPLv2.1.