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 1b8ccb42a7 libimagstorestdhook: Remove 3 years ago
bin 795df63679 Add missing license headers 3 years ago
doc b3e7f095ce Merge pull request #966 from matthiasbeyer/libimagtimetrack 3 years ago
imag-bookmark 4ca6f4c386 Update version strings: 0.2.0 -> 0.3.0 3 years ago
imag-counter 4ca6f4c386 Update version strings: 0.2.0 -> 0.3.0 3 years ago
imag-diary 9ab29bc37a Update chrono: 0.2 -> 0.4 3 years ago
imag-link 05c316a1ed Fix build 3 years ago
imag-mail 4ca6f4c386 Update version strings: 0.2.0 -> 0.3.0 3 years ago
imag-notes 9650f46e23 Version strings: 0.2.0 -> 0.3.0 3 years ago
imag-ref 9650f46e23 Version strings: 0.2.0 -> 0.3.0 3 years ago
imag-store c8bbe33513 Use stdout backend, not stdio backend 3 years ago
imag-tag 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
imag-todo 19e8be9f9b Update toml-query: 0.2.0 -> 0.3.0 3 years ago
imag-view 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagannotation c71b70702c Merge pull request #983 from matthiasbeyer/libimagannotation/add-is_annotation 3 years ago
libimagbookmark 2355de6d2e Remove unused dependency 3 years ago
libimagcounter bddc79efaa Update toml-query: 0.2.0 -> 0.3.0 3 years ago
libimagdiary 297c552335 Update chrono: 0.2 -> 0.4 3 years ago
libimagentrycategory 218977ae17 Update toml-query: 0.2.0 -> 0.3.0 3 years ago
libimagentrydatetime aee7772665 Update chrono: 0.3 -> 0.4 3 years ago
libimagentryedit 9650f46e23 Version strings: 0.2.0 -> 0.3.0 3 years ago
libimagentryfilter 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagentrylink 0155fea4c1 Impl Display for StoreLinkConsistencyErrorCustomData 3 years ago
libimagentrylist 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagentrymarkdown 9650f46e23 Version strings: 0.2.0 -> 0.3.0 3 years ago
libimagentrytag ac805dcef7 Add is_tag_str(&str) wrapper for is_tag(String) 3 years ago
libimagentrytimetrack 17b9c01163 Update chrono: 0.3 -> 0.4 3 years ago
libimagentryview 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagerror 33390acf23 Allow custom data in errors to be displayed 3 years ago
libimaginteraction 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagmail a106b8c1f4 Add missing license headers 3 years ago
libimagnotes 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagref 4257ec1026 Merge pull request #930 from matthiasbeyer/update-toml 3 years ago
libimagrt 625938398d Use `file_abstraction` module instead of `store` 3 years ago
libimagstore 2478df4149 Fix: Re-set file length before writing to it 3 years ago
libimagtimeui d6e09ab550 Update chrono: 0.2 -> 0.4 3 years ago
libimagtodo 398332fcb2 Update toml-query: 0.2.0 -> 0.3.0 3 years ago
libimagutil 795df63679 Add missing license headers 3 years ago
tests 157f4e79aa test setup: Prepare store directory before starting tests 3 years ago
.editorconfig 88e7c1bd8d Add editorconfig configuration file 4 years ago
.gitignore b55789578c Ignore /out 4 years ago
.travis.yml cfaed077dc Update to rustc 1.17 3 years ago
CONTRIBUTING.md e88c5011ab Remove libimagstorestdhook entry 3 years ago
Cargo.toml bdec778b9e Fix wrong lib name 3 years ago
LICENSE b0f0b4bcfd Add LICENSE file 4 years ago
Makefile a8062b0446 Add cargo test call for binaries 3 years ago
README.md 820fccae27 Added Tokei badge for displaying LOC 3 years ago
default.nix be38166bc7 Remove bundler 3 years ago
imagrc.toml 91dce6858f Remove hook config from example config file 3 years ago

README.md

imag - imag-pim.org

imag is a commandline personal information management suite.

Build Status Issue Stats Issue Stats [license]() Tokei

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.

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. imag-notes, imag-tag, imag-view), where 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 imag-calendar with icalendar files.

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 make to automate the build process. Make sure to not include some -j 8 arguments, this will not work as you might think!

There are several targets for each of the sub-crates in the Makefile:

Target Multi Purpose Example
all Build everything, debug mode make all
bin Build all binaries, debug mode make bin
lib Build all libraries, debug mode make lib
lib-test Test all libraries make lib-test
imag-bin Build only the imag binary, debug mode make imag-bin
clean Remove build artifacts make clean
update Run cargo update make update
check-outdated Run cargo outdated make check-outdated
check * Run cargo check make check
install * Build everything, release mode, install make install
release * Build everything, release mode make release

The Multi targets are callable for each sub-crate. For example you can call make imag-store-check to run cargo check on the imag-store crate.

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-<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).

Staying up-to-date

We have a official website for imag, where I post release notes. There is no RSS feed, though.

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.

I also post these blog posts on reddit and submit them to this-week-in-rust.

Documentation

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.

Please contribute!

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!

Contact

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.

License

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