- Installation
- Quickstart
- Controls
- Configuration
- Import/export
- Future Plans
- Issues/Considerations
- Tests
Follow me on Twitter for the latest fzn
updates and announcements, or just to watch me talk to myself.
WASM powered web-app is now live! More info here
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.
- Opens
fzn
- Fuzzy searches for
shopping
, highlights matching lines withCtrl-s
, and zooms on common prefix withEnter
(=
denotes a full string match). - Adds new line (with auto-prepended
shopping
prefix) - Presses
Escape
to go to search line - Fuzzy searches for
impo
, highlights and zooms onimportant project
- Focuses on line
write `hello` script
, and opens a note buffer (in vim) withCtrl-o
- Adds the script, then saves and closes the vim buffer, thus attaching the note to the line
- Fuzzy matches on
fzn
, focuses on a line with a URL, and pressesCtrl-_
to match the URL and open in default browser
Backed 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.
S3 (quickstart)
Configure an S3 bucket yourself to sync between machines/users (accessed via access key/secret)
Compile locally (requires Go):
git clone git@github.com:Sambigeara/fuzzynote.git
cd fuzzynote
make build
From the releases page.
ArchLinux users can build and install fzn
with:
yay -S fuzzynote
- Install
fzn
- Start
./fzn
- Install
fzn
- Sign up here
- Login and follow prompts
./fzn login
- Start
./fzn
- Sign up/log in
- Add a line starting with
fzn_cfg:friend
, e.g.
fzn_cfg:friend {friends_email}
- Ensure you are are connected to the internet
- Get your friend to do the same (emails swopped, of course)
- Sign up/log in
- Add a friend, and have them add you, as per the above
- In the line you want to share, write the friends email, prefixed with a
@
, e.g.
fzn_cfg:friend joe@bloggs.com
Some random line I want to share @joe@bloggs.com
-
Configure an S3 bucket with access via access key/secret - link to AWS docs.
-
Create a file called
config.yml
in thefzn
root directory. By default, this is at$HOME/.fzn/
on*nix
systems, or%USERPROFILE%\.fzn
on Windows. If you've already runfzn
, the root directory will have aprimary.db
and one or morewal_*.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
- Start the app, if you haven't already
./fzn
At 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!
- General navigation:
Arrow keys
- Go to start of line:
Ctrl-a
- Go to end of line:
Ctrl-e
- Go to search line:
ESCAPE
- Exit:
Double ESCAPE
Any number of tab-separated search groups are applied to the lists independently. Use full, fuzzy, or inverse string matching.
- Fuzzy string match, start the search group with
~
- Inverse string match (full strings), start the search group with
!
- Separate search groups:
TAB
~foo # matches "fobo"
foo # will not match "fobo"
!foo # will ignore any lines with "foo" in it
- Add new line (prepending search line text to new line):
Enter
- Delete line:
Ctrl-d
- Undo/Redo last operation:
Ctrl-u/Ctrl-r
- Moves current item up or down:
PageUp/PageDown
- Open note on the currently selected list item in selected terminal editor (default is Vim). Save in editor saves to list item:
Ctrl-o
- Copy current item into buffer:
Ctrl-c
- Paste current item from buffer:
Ctrl-p
- Select item under cursor:
Ctrl-s
- Set common prefix string to search line:
Enter
- Clear selected items:
Escape
- Globally display/hide archived items:
Ctrl-v (top line)
- Archive/un-archive list item:
Ctrl-v
- Open first URL in list item:
Ctrl-_
- Copy first URL from list item into the system clipboard:
Ctrl-c
- Export current matched lines to text file (will output to
current_dir/export_*.txt
):Ctrl-^
The following character combinations will parse to different useful outputs:
{d}
: A date in the formMon, Jan 2, 2006
fzn --help
will print out the configurable options.
> fzn --help
Usage: fzn [options] [arguments]
OPTIONS
--root/$FZN_ROOT <string>
--colour/$FZN_COLOUR <string> (default: light)
--editor/$FZN_EDITOR <string> (default: vim)
--help/-h
display this help message
--version/-v
display version information
editor
: specifies the terminal editor which is used when opening notes on list items.vim
,emacs
andnano
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 thatfzn
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 default
Export 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
.
- E2E encryption
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:
- Sometimes the sync algorithm gets confused. Usually, all that is needed is just to add or delete a line or character (adding additional events to the WAL will trigger a flush and get things moving). If that doesn't work, turning it off and on again usually does the trick.
- Notice something wrong? Please do open an issue!
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).