ff-notes/ff

A distributed note taker and task manager.

𝑓𝑓

A distributed note taker and task manager.

What's the big deal?

1. 𝑓𝑓 synchronizes via any file sync application, like git, Yandex.Disk, Dropbox, or Google Drive.
2. 𝑓𝑓 is available offline and synchronizes without conflicts thanks to CRDT and RON.

Stability

Works on all my computers and synchronizes between them successfully. 𝑓𝑓's own issues are tracked in 𝑓𝑓 since the first day of development. I also use 𝑓𝑓 for my personal tasks since the first day of development. Please feel free to test it in your environment. But no guarantees.

Project-based task management

𝑓𝑓 detects if it is run inside a git repository and saves notes in it. Other VCS will be supported in future. Feel free to open a ticket if you want to extend support.

Install

$ git clone https://github.com/ff-notes/ff.git
$ cd ff
$ stack install ff

Install experimental GUI

GTK version

Prerequisites

Follow https://github.com/haskell-gi/haskell-gi\#installation.

Program

Mac OS:

$ export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"
$ stack install ff-gtk

Ubuntu:

$ stack install ff-gtk

Qt version

Prerequisites

Mac OS:

$ brew install qt

Ubuntu:

# apt install qt5-default

Program

$ stack install ff-qt

Completion for commands and options

Ubuntu 18.04

ff --bash-completion-script `which ff` | sudo tee /etc/bash_completion.d/ff

MacOS

ff --bash-completion-script `which ff` | sudo tee /usr/local/etc/bash_completion.d/ff

Usage

Look what 𝑓𝑓 can do for you

$ ff --help
Usage:  [-b|--brief] [--json] [-C|--data-dir DIRECTORY]
        [(-V|--version) | COMMAND | [-l|--limit ARG]
          [(-n|--no-tag) | [--tag TAG]... [--without-tag TAG]...]]
  A note taker and task tracker

Available options:
  -b,--brief               List only note titles and ids
  --json                   Use JSON for input/output
  -C,--data-dir DIRECTORY  Path to the data dir
  -V,--version             Current ff-note version
  -l,--limit ARG           Number of issues
  -n,--no-tag              Filter items that have no tags
  --tag TAG                Filter by tag
  --without-tag TAG        Filter items without tag
  -h,--help                Show this help text

Available commands:
  add                      add new task or note
  agenda                   show what you can do right now [default action]
  config                   show/edit configuration
  contact                  show contacts
  delete                   delete a task
  done                     mark a task done (archive)
  edit                     edit a task or a note, using command from environment
                           variable `EDITOR` or program `editor`
  new                      synonym for `add`
  postpone                 make a task start later
  search                   search for notes with the given text
  show                     show note by id
  tags                     show tags of all notes
  sponsors                 show project sponsors
  track                    track issues from external sources
  unarchive                restore the note from archive
  upgrade                  check and upgrade the database to the most recent
                           format
  wiki                     show all wiki notes

Get started

Personal

To save personal notes and tasks somewhere you must configure 𝑓𝑓's data directory

ff config dataDir --help

If you use Yandex.Disk, you can say just

ff config dataDir -y

Project-based

To work with a project's tasks, just run 𝑓𝑓 inside a VCS repository.

$ ls
.git
$ ff add ...
$ ls
.ff .git
$ git add .ff

Get some unfinished tasks

$ ff
Actual:
    * buy milk
      id 458a1456lrc-12z3opnykw, start 2018-01-10

Add new task or note

$ ff add 'learn Haskell'

Now you can find it in your agenda:

$ ff
Actual:
    * buy milk
      id 458a1456lrc-12z3opnykw, start 2018-01-10
    * learn Haskell
      id 459h2tqxutq-24nuhr86ae, start 2018-01-14

Mark task done

Marking done is actually moving to archive.

$ ff done 458a1456lrc-12z3opnykw
archived:
    buy milk
    id 458a1456lrc-12z3opnykw, start 2018-01-10

Archived tasks don't appear in an agenda:

$ ff
Actual:
    * learn Haskell
      id 459h2tqxutq-24nuhr86ae, start 2018-01-14

Developers community

We have a telegram chat ff-dev where you can ask your questions.

Alternative chat: https://gitter.im/ff-notes

ff's Issues

ff serve: open browser

not default; with option -o | --open

Connect Travis

Use sequence CRDT for text

Add command to list wiki pages

Delete merged version files

Handle parallel execution effects, like unexpected version file disappearance.

Add Wiki

1. new status Wiki
2. add adds task
3. add --wiki adds wiki
4. edit works with both
5. agenda doesn't list wikis

Colorized output

printOrPage from pager shows colors when env Pager = more. For less it does not. less required flag -r to show colors.

We wait until end of 01.19 for PR approving.

Re-write agenda sections

-- | haskellish pseudocode for agenda sections logic
agendaSection start end
    | end == Nothing    = if
        | start <= today -> Actual
        | start >  today -> StartingSoon
    | end <  Just today =   Overdue
    | end == Just today =   DueToday
    | end >  Just today = if
        | start <= today -> EndingSoon
        | start >  today -> StartingSoon

export issue status (ff -> GitHub)

close GitHub issue and sync it with ff when a user tries to complete the task in ff

Add shell completion

Those IDs aren't gonna type themselves...

Short commands

a = agenda
n = new
d = done
...

Get note by id

Command ff show to show note by id.

Allow group modification

Allow this

ff delete ID1 ID2 ID3
ff done ID1 ID2 ID3
ff edit --start START ID1 ID2 ID3
ff postpone ID1 ID2 ID3
ff unarchive ID1 ID2 ID3

But NOT this

ff edit ID1 ID2 ID3

It is non-sense to set the same text for multiple notes.

Edit subcommand

Add search

A full-text search index would be nice life-saving.

Contexts

Implement type (or types?) for different contexts (as in GTD)

• location:
  • predefined: Moscow, London
  • user-defined: work, home
• time: Monday, weekend, morning
• user state: on the internet, on phone

Hide pid from note-id when pid is unique

Disallow dates when adding wiki notes

Show `fetching...` while fetching issues

Dots are adding with an interval.

Android app

Close issue in ff after closing on github

Remove readFile method

RGA: assign sequential timestamps

crdt: acquire sequential timestamps

Tags

A tag is a document in the ff database.

It must contain one text field (RgaText).

A note must have a field "tags" of type OR-Set, containing references (ids) to tag objects.

Use a git repository as a storage

Should be useful for software projects

Necessary:

• Find data dir based on git: look for .git/.hg/.svn, else take dataDir from config

Optional:

• Commit automatically on editing.
• ff --global — do not look for .ff, use dataDir only from config
• ff --vcs — look for .git/.hg/.svn, create .ff there

Unit test for parsing config

ff serve: daemonize

not default; with option -d

Use Swarm as a backend

Subcommand to delete notes

status = Deleted
set some empty or nonsense values to other fields

Brief view option

Show the note titles without meta data.

Start date can't be less than current

Support multiple external note sources

Create a dedicated table for sources

Support git-urls in `ff track`

like [email protected]:ff-notes/ff.git

Add notes without subcommand

Make command ff TEXT equivalent to ff new TEXT

Remove comma from agenda messages

For fast id selecting

Github sync: extract repository address from git remote "origin"

Add timezone to timestamps

use a string. Specifically, use the full qualified name in the Olson database, so something like Australia/Adelaide or America/Los_Angeles. These are standardized descriptors of the timezones used in the world, and you can use these in pretty much every programming language ever used in the last few decades.

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

https://zachholman.com/talk/utc-is-enough-for-everyone-right

Import from gmail

Proper error messages

Distinguish these cases in error messages:

• a document doesn't exist
• a document is invalid
• a document is tracked
• a document is archived

Subcommand aliases and abbreviations

Wait for

• subcommand aliases in optparse-applicative
• subcommand abbreviations in optparse-applicative -- pcapriotti/optparse-applicative#193

Links between notes

Use for:

• dependencies
• tags (#20)
• contexts (#21)
• contact contexts (#22)

Implementation variants:

1. A field in Note with a set of links (incoming, outgoing).
2. A separate type Link{from, to :: DocId Note}
3. Something else?

import issues (GitHub -> ff)

• implement this feature
• import ff notes

Add optional time to dates

Probable solution:

-- | Day and Maybe Time
type DMT = Either Day UTCTime

Day is treated in current time zone, UTCTime is UTC

With timezone

use a string. Specifically, use the full qualified name in the Olson database, so something like Australia/Adelaide or America/Los_Angeles. These are standardized descriptors of the timezones used in the world, and you can use these in pretty much every programming language ever used in the last few decades.

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

https://zachholman.com/talk/utc-is-enough-for-everyone-right

Use modern prettyprinter

https://hackage.haskell.org/package/prettyprinter

Desktop app: try qtah

Track issue content

along with title

Version option

• -V,--version
• Add changelog line
• Include git revision (git rev-parse HEAD, git rev-parse --symbolic-full-name HEAD)
• git dirtiness (count lines of git status --short).

Contacts

A contact is a document in the ff database.

It must contain one text field (RgaText) — for a human name.

A note must have a field "assignee" of type [Contact], containing a reference (id) to a contact object.

Setting dataDir should prompt to create it

Otherwise, until a first note recorded:

$ ff
ff: /home/user/.local/share/ff/note: getDirectoryContents:openDirStream: does not exist (No such file or directory)

List issues from Github

• fetch issues from GitHub with ff github --list
• allow a user to specify repository to operate
• change option ff github --list to subcommand ff github list
• render github issues with ff output mechanism (NoteView)
• use taskMode to get proper state in ff github llist
• replace groupSort with sorted Map construction
• merge FF.takeSamples with Github.sampleMaps.takeFromMany
• limit via pagination
• add test with reference GitHub response and golden NoteView output