Terminal-based, hyper-fast, CRDT-backed, collaborative note-taking tool
Terminal-based, hyper-fast, CRDT-backed, collaborative note-taking tool
Fuzzynote (fzn)
Follow me on Twitter for the latest fzn updates and announcements, or just to watch me talk to myself.
fzn is local-first; remote-second. It acts on local in-memory data, meaning no expensive I/O and native speeds.
Instant search (over large datasets) via any number of full or fuzzy match groups.
Zoom in using common prefixes.
fznshopping, highlights matching lines with Ctrl-s, and zooms on common prefix with Enter (= denotes a full string match).shopping prefix)Escape to go to search lineimpo, highlights and zooms on important projectwrite `hello` script, and opens a note buffer (in vim) with Ctrl-ofzn, focuses on a line with a URL, and presses Ctrl-_ to match the URL and open in default browserBacked by a CRDT-based, append-only, mergeable text database.
Collaboration is done on a per-line/item basis; by adding @{email} to the item. Shared lists are displayed by adding the email as a search group.
Offline changes will sync later with guaranteed/consistent output.
In short, you can collaborate on multiple "documents" from the same view at the same time.
Configure an S3 bucket yourself to sync between machines/users (accessed via access key/secret)
Compile locally (requires Go):
git clone [email protected]:Sambigeara/fuzzynote.git
cd fuzzynote
make buildFrom the releases page.
ArchLinux users can build and install fzn with:
yay -S fuzzynotefzn./fznfzn./fzn login./fznfzn_cfg:friend , e.g.fzn_cfg:friend {friends_email}@, e.g.fzn_cfg:friend [email protected]
Some random line I want to share @[email protected]Configure an S3 bucket with access via access key/secret - link to AWS docs.
Create a file called config.yml in the fzn root directory. By default, this is at $HOME/.fzn/ on *nix systems, or %USERPROFILE%\.fzn on Windows. If you've already run fzn, the root directory will have a primary.db and one or more wal_*.db files, for reference.
Add the following to the file, using key/secret from above:
s3:
- key: {AWS_ACCESS_KEY}
secret: {AWS_SECRET}
bucket: bucket_name
prefix: some_prefix./fznAt present fzn only supports S3 as a remote target. However, it is easily extensible, so if there is demand for additional platforms, then please make a request via a new issue!
Arrow keysCtrl-aCtrl-eESCAPEDouble ESCAPEAny number of tab-separated search groups are applied to the lists independently. Use full, fuzzy, or inverse string matching.
~!TAB~foo # matches "fobo"
foo # will not match "fobo"
!foo # will ignore any lines with "foo" in itEnterCtrl-dCtrl-u/Ctrl-rPageUp/PageDownCtrl-oCtrl-cCtrl-pCtrl-sEnterEscapeCtrl-v (top line)Ctrl-vCtrl-_Ctrl-ccurrent_dir/export_*.txt): Ctrl-^The following character combinations will parse to different useful outputs:
{d}: A date in the form Mon, Jan 2, 2006fzn --help will print out the configurable options.
> fzn --help
Usage: fzn [options] [arguments]
OPTIONS
--root/$FZN_ROOT
--colour/$FZN_COLOUR (default: light)
--editor/$FZN_EDITOR (default: vim)
--help/-h
display this help message
--version/-v
display version informationeditor: specifies the terminal editor which is used when opening notes on list items. vim, emacs and nano all appear to work. Others may too.sync-frequency-ms/gather-frequency-ms: these can be ignored for nowroot: (mostly for testing and can be ignored for general use) specifies the directory that fzn will treat as it's root. By default, this is at $HOME/.fzn/ on *nix systems, or %USERPROFILE%\.fzn on Windows.fzn supports importing from and exporting to line separated plain text files.
Import will generate a new set of list items based on individual lines in a plain text file. You need to specify the visibility each time as per the examples below:
./fzn import path/to/file --show # Items will be shown by default
./fzn import --hide path/to/file # Items will be hidden by defaultExport allows you to generate a plain text file (in the directory from which fzn was invoked) based on the current match-set in the app. In short: search for something, press Ctrl-^, and fzn will spit out a file named something along the lines of export_*.txt.
The terminal client is fully functioning, however given the early stages of the project, and the (at points) rapid development, there are likely to be some bugs hanging around. Things to look out for:
Almost entirely broken. Fuzzynote has undergone some fairly substantial changes over the past few months - the test suite will be updated to suit in due course (please don't judge me).
No open issues yet, or sync has not completed.