Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xylous/settle
A command-line tool for managing a digital Zettelkasten
https://github.com/xylous/settle
cli knowledge-management luhmann note note-taking note-taking-app notes personal-knowledge-management rust zettel zettelkasten
Last synced: 27 days ago
JSON representation
A command-line tool for managing a digital Zettelkasten
- Host: GitHub
- URL: https://github.com/xylous/settle
- Owner: xylous
- License: mit
- Created: 2021-08-03T12:49:23.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-03T22:35:21.000Z (about 1 year ago)
- Last Synced: 2024-03-15T08:48:17.435Z (9 months ago)
- Topics: cli, knowledge-management, luhmann, note, note-taking, note-taking-app, notes, personal-knowledge-management, rust, zettel, zettelkasten
- Language: Rust
- Homepage:
- Size: 1.27 MB
- Stars: 30
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - xylous/settle - A command-line tool for managing a digital Zettelkasten (Rust)
README
# 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](./doc/SETTLE_MANUAL.md), with technical descriptions of
every command
- includes [instructions on setting up shell command
autocompletion](./doc/SETTLE_MANUAL.md#shell-autocompletion)
- [project motivation](./doc/history.md)
- [design principles](./doc/design-principles.md)
- [configuration](./doc/configuration.md)
- [tags and subtags](./doc/tags-and-subtags.md)
- [links and backlinks](./doc/links-and-backlinks.md)
- [creating new notes (with templates as well)](./doc/creating-notes.md)
- [keeping the database up to date](./doc/keeping-the-database-up-to-date.md)
- [projects](./doc/projects.md)
- [moving notes between projects](./doc/moving-notes-between-projects.md)
- [renaming notes](./doc/renaming-notes.md)
- [query, search and filter](./doc/query-search-and-filter.md)
- [interactively visualise your Zettelkasten](./doc/vizk.md), inspired by
[Obsidian MD's Graph View](https://help.obsidian.md/Plugins/Graph+view)
- [exporting your Zettelkasten to a graph format](./doc/graphs.md)
## 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](LICENSE)