# hsh: an all-in-one life-management tool

`hsh` is a tool that tries to bring note taking, bookmarking, and todo
management to a single place. While the initial focus is on the CLI, and I care
very much about ensuring that `hsh` always has an outstanding command line, I
explicitly want to make sure that `hsh` also has a good web front-end.

## Design and Inspiration

`hsh` owes a great debt to [`nb`][nb], and started off fully compatible with it.
In fact, until recently, if you pointed `hsh` and `nb` to the same notebook,
they could operate on it in the same way. And like `nb`, `hsh` believes
completely in the primacy of plain text.

That said, `hsh` is heading in a different direction:

- There isn't anything like nb's indices/numeric IDs
- While `nb` relies on a rich collection of command-line tools to work, my goal
  with `hsh` is for it to be fully self-contained. (That said, it currently
  relies on `ripgrep`, and will continue to do so until I implement caching in
  SQLite.)
- While `hsh`, like `nb`, currently relies on Git for a lot of its history and
  metadata, and while I plan for `hsh` to continue _optionally supporting that
  flow_, my intention is for `hsh` to track much of that metadata internally and
  directly.

## Current Status

Note taking and a loose concept of todos are now present. In particular, the
following functionality exists:

- Cloning notebooks
- Adding and removing notes
- Searching (requires `ripgrep`)
- Using Git to sync and manage the notebooks
- Searching todos and marking them complete or incomplete
- Bookmarking, including storing a Markdown format of the web page

[nb]: https://xwmx.github.io/nb/