Skip to content

cb-g/halcyon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

halcyon

A minimal, priority-based todo list manager with trash bin.

Quick Start

./install.sh   # one-time setup, prompts for Docker or Cargo
./run.sh       # run halcyon

The install script will:

  • Build via Docker or Cargo
  • Optionally add a halcyon alias to your shell config (~/.zshrc or ~/.bashrc)

Manual Installation

Docker (Recommended)

Docker keeps everything self-contained: no Rust toolchain required, and your todo data stays in ./data/ instead of ~/.halcyon.

docker build -t halcyon .
mkdir -p data
docker run -it --rm -v "$(pwd)/data:/data" halcyon

Cargo

Requires Rust. Stores data in ~/.halcyon/todos.json.

cargo install --path .
halcyon

Usage

Navigate with arrow keys, ESC to go back/exit.

Menu Structure

View
  ├── All
  ├── Pending
  └── Completed
Do
  ├── Add
  ├── Complete
  ├── Edit
  ├── Delete
  └── Clear completed
Trash
  ├── View
  ├── Restore
  └── Empty
Reset (clears all todos and trash)

Features

  • Priority levels (High/Normal/Low) with color coding
  • Autocomplete for task selection
  • Trash bin with restore
  • Reset option to clear all data

Uninstallation

./uninstall.sh

Prompts to remove:

  • Docker image
  • Data directory (./data/)
  • Cargo binary
  • Home data (~/.halcyon/)
  • Shell alias

About

CLI note-taking

Topics

Resources

License

Stars

Watchers

Forks