Skip to content

matteing/notectl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notectl

A simple note management tool.

Description

notectl provides a portable suite of tools you can use to organize and backlink your plain-text notes. It isn't tied to any specific text editor.

It isn't concerned with note taking, that's up to you. However, its opinionated nature means it contains tools useful for building a second-brain, such as quick "daily note" creation.

Simply put, it kicks some plaintext ass.

Features

  • Daily notes: opens a Markdown note with today's (or tomorrow's) date
  • Supports iA Writer attachments ("content blocks")
  • Moves any scattered attachments into a single folder
  • Backlinking: automatic backlinking for notes, with filtering support (filter backlinks by #tag or date)
  • Topical notes template with automatic indexing
  • Git snapshots before any automatic change to your notes

Why?

I don't want to be tied to a particular text editor for my notes. I'd like to use Obsidian features, such as attachment management and automatic backlink indexing, but prefer using iA Writer.

There's also some principle to it: my notes should be fully usable from any editor, using a suite of single-purpose, portable tools (think UNIX philosophy).

Sample commands

In lieu of documentation, here's some sample usage:

# Install notectl
poetry install
notectl --install-completion

# Configure it (check the `conf` folder for examples)
notectl config init

# Create daily notes
notectl daily today
notectl daily tomorrow

# Collect all your attachments into a single folder
notectl attachments tidy

# Fill all <autoindex /> tags with any backlinks
notectl autoindex run

# Create a topical note (with autoindexing support)
notectl topic new "Programming"

Disclaimer

This project is a WIP. It's messy and likely will be forever (as long as it meets my needs).

There are safeguards in place to ensure that it doesn't wreck your notes. Configure the Git snapshot feature to ensure nothing goes wrong.

About

A simple note management utility that kicks serious ass

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published