settle

settle is a CLI tool that helps you manage your digital Zettelkasten.

Getting started

Requirements

• cargo/rust toolchain
• SQLite

Installation

There's a crate on crates.io, so you can simply run:

cargo install settle

Usage

Read the manual

Roadmap

• generate database from existing files
• create Zettel
• list Zettel
• tags
  • recognize hashtag-tags (e.g. #interesting-tag)
  • search for tags
  • list all tags
• configuration
  • custom Zettelkasten directory
  • custom database file path
  • be able to use templates
• list mentioned but non-existent Zettel
• use an inbox
• search for text inside notes
• support matching titles with wildcards
• update Zettel metadata individually
• print links
  • forward links (from a Zettel to other Zettel)
  • backlinks (to a Zettel from other Zettel)
• projects (subdirectories within the main Zettelkasten folder)
  • add notes to projects
  • generate the database with projects included
  • start with an 'inbox' project by default

Meta

• configure Cargo.toml properties
• shell autocompletion
  • zsh
  • bash
  • fish
• write a proper man page
• logo (pixel art?)
• publish to crates.io

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT