xylous / settle

A command-line tool for managing a digital Zettelkasten

settle

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

Getting started

Requirements

• cargo/rust toolchain (for building)
• SQLite (for running)

Installation

There's a Rust crate available, so you can simply run:

cargo install settle

Overview

• full usage manual, with technical descriptions of every command
  • includes instructions on setting up shell command autocompletion
• project motivation
• design principles
• configuration
• tags and subtags
• links and backlinks
• creating new notes (with templates as well)
• keeping the database up to date
• projects
  • moving notes between projects
• renaming notes
• query, search and filter
  • interactively visualise your Zettelkasten, inspired by Obsidian MD's Graph View
  • exporting your Zettelkasten to a graph format

Contributing

Pull requests are welcome. For any minor or major changes, you can open an issue to discuss what you would like to change.

License

MIT