utd is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install utd

It will make the utd command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall utd uninstalls.

Adding `utd` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add utd

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

utd = "0.1.2"

The utd library will be automatically available globally.

Back to the crate overview.

Readme

ugly todo

Create tasks and save notes offline from your terminal!

This is a port/readaptation of Ugly To-Do with additional features

Demo

Installation

Arch Linux

paru -S utd

Not on Arch?

You need cargo, which is provided by the rust or rustup packages. Check with your package manager. Alternatively, you can get the latest stable version of rustup by running:

curl https://sh.rustup.rs -sSf | sh

From here, you can install utd by running:

cargo install utd

Building from source

git clone https://github.com/kawaki-san/utd-rs.git && cd utd-rs

Then you can build the binary:

cargo build --release

When that's done, you can find the utd binary in the target/release directory. You may want to copy it to a directory in your $PATH. A man file is output at target/utd.1 after building should you want an entry in mandb

Start with shell

bash

echo "utd" >> ~/.bashrc

zsh

echo "utd" >> ~/.zshrc

fish

function fish_greeting
    utd
end
funcsave fish_greeting

Usage

Add task(s) with priorities:

utd -a "My first task" "My second task" "Check issues @Git" -n "Update license" -p low -p low -p high

This adds 3 tasks with custom priorities to your board (default priority is normal).

Priorities are mapped respectively to their tasks and notes - with tasks taking precedence i.e - If you set 3 tasks and 2 notes; then you pass 4 priorities - the tasks will take the first 3 priorities, the first note will have a custom priority, but the last one will use the default - normal

Run utd -h or man utd for help.

Configuration

utd doesn't create a config file for you, but it looks for one in the following locations:

$XDG_CONFIG_HOME/utd.toml
$XDG_CONFIG_HOME/utd/config.toml

Windows

%APPDATA%\Roaming\utd\utd.toml
%APPDATA%\Roaming\utd\utd\config.toml

The default configuration file can be found in the repo, here

Installing the command-line executable

Adding utd library as a dependency

Adding `utd` library as a dependency