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 e21393dd2a Fix version string in imag-bookmark as well||2 years ago|
|.imag-documentation||2 years ago|
|bin||2 years ago|
|doc||2 years ago|
|imag-bookmark||2 years ago|
|imag-counter||2 years ago|
|imag-diary||2 years ago|
|imag-link||2 years ago|
|imag-notes||2 years ago|
|imag-ref||2 years ago|
|imag-store||2 years ago|
|imag-tag||2 years ago|
|imag-todo||2 years ago|
|imag-view||2 years ago|
|libimagbookmark||2 years ago|
|libimagcounter||2 years ago|
|libimagdiary||2 years ago|
|libimagentryedit||2 years ago|
|libimagentryfilter||2 years ago|
|libimagentrylink||2 years ago|
|libimagentrylist||2 years ago|
|libimagentrymarkdown||2 years ago|
|libimagentrytag||2 years ago|
|libimagentryview||2 years ago|
|libimagerror||2 years ago|
|libimaginteraction||2 years ago|
|libimagmail||2 years ago|
|libimagnotes||2 years ago|
|libimagref||2 years ago|
|libimagrt||2 years ago|
|libimagstore||2 years ago|
|libimagstorestdhook||2 years ago|
|libimagtimeui||2 years ago|
|libimagtodo||2 years ago|
|libimagutil||2 years ago|
|tests||2 years ago|
|.editorconfig||2 years ago|
|.gitignore||2 years ago|
|.travis.yml||2 years ago|
|CONTRIBUTING.md||2 years ago|
|LICENSE||3 years ago|
|Makefile||2 years ago|
|README.md||2 years ago|
|default.nix||2 years ago|
|imagrc.toml||2 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.
We try to implement as many aspects of personal information management (PIM),
but re-use existing commandline tools.
We do this by tracking/referring to the data the tools create.
A user can now link pieces of data (from different tools), tag this data and
query/search this data using imag.
imag is more like a data-mining helper than an actual PIM tool, but we
implement some of the PIM aspects directly in
Parts of PIM (we call them "modules") that are already implemented and basically
Helper modules that come with
imag but are not "PIM aspects":
Here goes how to try
imag is a suite of tools and you can build them individually.
All subdirectories prefixed with "
libimag" are libraries for the respective
All subdirectories prefixed with
"imag-" are binaries and compiling them will
give you a commandline application.
By now, there are several targets in the Makefile, fulfilling following roles:
allis the default and builds every crate in debug mode. To build a single module, call
make <module>, for example
release, as the name implies, builds every module in release mode. E.G.:
make imag-store-releaseto build "imag-store" in release mode.
installwill install all commandline modules to the default installation root (see
man cargo-install). To install a single module, run
make <module>-install, E.G.:
libare separate targets for either building all binaries or libraries.
cargo testfor all libraries. For testing a single library, E.G.:
cargo cleanin every crate. For cleaning a single crate, use
make imag-store-cleanfor example.
imagbinary, use the target
imag-bin-releasefor release build,
To test out a single module, simply using
cargo run -- <options> in the
respective directory will do the trick.
But you can also
make <module> and call the binary on the commandline.
For using it "normally", install the
binaries as described above, as well as the imag-binary:
$> make install
The installation root of the binaries may not yet be in your $PATH.
To see where this installation root is check out
To change the $PATH in bash:
$> PATH=$PATH:~/.cargo/bin $> imag --help
To test, simply add
--help to one of the above commands:
$> imag counter --help
Despite we have a official site for imag, I do not push updates to this site, yet. Anyways, I post a blog articles about what happened in the last two weeks every other week.
You can find them on my personal blog, tagged "imag"
From time to time I publish an article about imag which does not focus on some things that are happening, but rather about something more general.
Please note that the documentation is work in progress as well and may be 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.
This decision was made to ensure everyone can write applications which use the imag core functionality which is distributed with the imag source distribution.