gitkeeper / pilum

A sophisticated task manager with a CLI and a GUI written in Rust.

Pilum

About

Pilum is a sophisticated task manager with a CLI and a GUI written in Rust.

Pilum serves as a convenient and easy-to-use task management tool, operated via the command line and a graphical interface. It keeps track of your to-do tasks, enabling operations like adding, removing and altering tasks as per your requirements. Pilum is equipped with a wide range of commands for sophisticated task manipulations.

Essentially, Pilum functions as a list organizer. You can feed details, along with their respective parameters, and the program neatly structures and displays it. By integrating deadlines and recurring tasks, it becomes a comprehensive to-do manager. Further refinement is achieved by incorporating elements like priorities, tags, project groups and more, making Pilum a fully-fledged task organization program.

Installation

For the time being, you must have Rust installed on your machine. To install Rust, it's recommended to follow Rust's installation instructions for your respective operating system.

Afterward, you can install Pilum by running cargo install pilum.

Usage

Pilum's command-line interface is invoked with the following pattern:

pilum <filter> <command> [ <mods> | <args> ]

For further information run pilum --help.

Development

After checking out the repo, run cargo check followed by cargo build to install dependencies. Then, runcargo test to run the tests. You can also run cargo run to invoke the task manager and add some arguments and/or options to play around with the commands available. To benchmark the application you may run cargo bench.

If you work on new features, you should also add the proper documentation. Please run cargo doc before you create a pull request and especially before you publish. To release a new version, update the version number in Cargo.toml, and then run cargo publish, which will upload the package to crates.io. The project adheres to the semantic versioning standard.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/gitkeeper/pilum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

This package is available as open source and dual-licensed under the terms of Apache 2.0 and MIT. The user or developer choosing to use, distribute, or modify this software can opt to do so under either of these licenses, adhering to the terms and conditions defined by the license they choose.