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 5a3b1a1ef0 Set dependency versions 2 years ago
bin 5a3b1a1ef0 Set dependency versions 2 years ago
doc 3a18655a7f Increment header levels in the README.md I missed in the first run 2 years ago
imag-bookmark 6845074d14 Fix version string in imag-bookmark as well 2 years ago
imag-counter 5a3b1a1ef0 Set dependency versions 2 years ago
imag-diary 5a3b1a1ef0 Set dependency versions 2 years ago
imag-link 5a3b1a1ef0 Set dependency versions 2 years ago
imag-notes 5a3b1a1ef0 Set dependency versions 2 years ago
imag-ref 5a3b1a1ef0 Set dependency versions 2 years ago
imag-store 1e5112614f Another fix for the dependency spec of imag-store 2 years ago
imag-tag 5a3b1a1ef0 Set dependency versions 2 years ago
imag-todo 5a3b1a1ef0 Set dependency versions 2 years ago
imag-view 5a3b1a1ef0 Set dependency versions 2 years ago
libimagbookmark ef53cb806e Fix messed up version string 2 years ago
libimagcounter 5a3b1a1ef0 Set dependency versions 2 years ago
libimagdiary 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentryedit 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentryfilter 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentrylink 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentrylist 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentrymarkdown 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentrytag 5a3b1a1ef0 Set dependency versions 2 years ago
libimagentryview 5a3b1a1ef0 Set dependency versions 2 years ago
libimagerror bdbf5cedfb Merge pull request #820 from Thiez/libimagerror/traceiter 2 years ago
libimaginteraction 5a3b1a1ef0 Set dependency versions 2 years ago
libimagmail 5a3b1a1ef0 Set dependency versions 2 years ago
libimagnotes 5a3b1a1ef0 Set dependency versions 2 years ago
libimagref 5a3b1a1ef0 Set dependency versions 2 years ago
libimagrt 5a3b1a1ef0 Set dependency versions 2 years ago
libimagstore 5a3b1a1ef0 Set dependency versions 2 years ago
libimagstorestdhook 5a3b1a1ef0 Set dependency versions 2 years ago
libimagtimeui 5a3b1a1ef0 Set dependency versions 2 years ago
libimagtodo 5a3b1a1ef0 Set dependency versions 2 years ago
libimagutil b5bfc1978c Fix: Cargo.toml does not know "website", but "homepage" 2 years ago
tests 157f4e79aa test setup: Prepare store directory before starting tests 2 years ago
.editorconfig 88e7c1bd8d Add editorconfig configuration file 2 years ago
.gitignore b55789578c Ignore /out 2 years ago
.travis.yml 050aec2aa1 Merge pull request #734 from matthiasbeyer/test-via-makefile 2 years ago
CONTRIBUTING.md 15e43ee0bc Some general updates 2 years ago
LICENSE b0f0b4bcfd Add LICENSE file 3 years ago
Makefile a9deb488b3 Fix missing [[ on travis 2 years ago
README.md d88c5d9a01 Add section about how to stay uptodate 2 years ago
default.nix 956cf56b1a Fix default.nix syntax 2 years ago
imagrc.toml ac1af164e9 Merge pull request #775 from matthiasbeyer/libimaginteraction/readline 2 years ago

README.md

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

Build Status Issue Stats Issue Stats [license]()

What is this / Goal and Functionality

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. So imag is more like a data-mining helper than an actual PIM tool, but we implement some of the PIM aspects directly in imag. Parts of PIM (we call them "modules") that are already implemented and basically working:

  • todo (via taskwarrior, we track the tasks one creates in taskwarrior)
  • diary
  • notes
  • bookmarks
  • counter (just an example, nothing that usable)

Helper modules that come with imag but are not "PIM aspects":

  • linking entries
  • viewing entries
  • tagging entries
  • creating misc entries
  • creating entries that refer to files/directories

Building/Running

Here goes how to try imag out.

imag is a suite of tools and you can build them individually. All subdirectories prefixed with "libimag" are libraries for the respective binaries. All subdirectories prefixed with "imag-" are binaries and compiling them will give you a commandline application.

Building

By now, there are several targets in the Makefile, fulfilling following roles:

  • all is the default and builds every crate in debug mode. To build a single module, call make <module>, for example make imag-store.
  • release, as the name implies, builds every module in release mode. E.G.: make imag-store-release to build "imag-store" in release mode.
  • install will install all commandline modules to the default installation root (see man cargo-install). To install a single module, run make <module>-install, E.G.: make imag-store-install
  • bin/lib are separate targets for either building all binaries or libraries.
  • lib-test runs cargo test for all libraries. For testing a single library, E.G.: make test-libimagstore.
  • clean will run cargo clean in every crate. For cleaning a single crate, use make imag-store-clean for example.
  • to build only the imag binary, use the target imag-bin (imag-bin-release for release build, imag-bin-clean for cargo cleaning).

Running

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 man cargo-install. 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

Staying up-to-date

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"

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

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.

Documentation

For detailed information, please read the documentation. You can either read the Markdown files or compile it to HTML/PDF using pandoc. Developer documentation is also available online on github.io.

Please note that the documentation is work in progress as well and may be 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.

This decision was made to ensure everyone can write applications which use the imag core functionality which is distributed with the imag source distribution.