fdnotes 0.3.0
A clean & simple plaintext note manager.
Requires Python: >=3.9
Keywords: cli,command-line,note,notes,note manager

fdn
===

[![](https://img.shields.io/github/v/release/spheten/fdn?style=flat-square)][re]
[![](https://img.shields.io/github/issues/spheten/fdn?style=flat-square)][is]
[![](https://img.shields.io/badge/license-BSD--3-green?style=flat-square)][li]

**fdn** (*Fair Dinkum Notes*) is a clean & simple note manager for people who have a bunch of important text files sitting in a folder somewhere and want to do command-line stuff to them, without losing all their data to someone else's proprietary database.

Just run `fdn init` and tell it where the folder is, then you'll be able to create, explore, organise and backup your notes without any trouble. Configuration is one file in [the standard location][cf] and there are even tools for exporting your notes and creating automated backups. Easy as!

Install
-------

```bash
$ pip install fdnotes
```

Or download the [latest build release][re].

Usage
-----

### Set up fdn

```text
$ fdn init
Â· G'day and welcome to Fair Dinkum Notes!
Â· Your default configuration path is ~/AppData/Roaming/fdn/config.toml.
Â· I've written a template there, should I open it for you?
[yes/no] â€º yes

Â· Opening now. Press any key to continue...
â€º

Â· Welcome back, checking configuration...
Â· Cheers! Configuration is valid. Run "fdn help" to see what you can do.
```

### List all notes

```bash
# Note names are all lowercase and slugified.
$ fdn list
Â· dropbear-sightings
Â· jokes-about-americans
Â· rugby-calendar-2021

# Also takes an optional glob argument.
$ fdn list rugby*
Â· rugby-calendar-2021
```

### Search all notes

```bash
$ fdn find McDonalds
Â· dropbear-sightings (1 item)
Â· jokes-about-americans (17 items)
```

### Show a note

```bash
$ fdn show dropbear-sightings
[REDACTED]
```

### Open a new or existing note

```bash
# Will open in your default editor.
$ fdn open rugby-calendar-2021
```

### Rename a note

```bash
$ fdn move footy21 rugby-calendar-2021
```

### Delete a note

```bash
$ fdn drop simpsons-references
```

### Import a note

```bash
# Will accept both local files and URLS.
$ fdn impo koala-tips ~/Desktop/Koala_Tips.txt
$ fdn impo marsupials https://example.com/marsupials.txt
```

### Export a note

```bash
# Choose between 'html', 'json' or 'text'.
$ fdn expo json jokes-about-americans
{"name": "jokes-about-americans", # etc ...
```

### Export the entire database

```bash
# Choose between 'html', 'json', 'text' or 'zip'.
$ fdn dump zip ~/database-backup.zip
```

Bonus Tips
----------

### Abbreviation

All commands support abbreviation, so you only have to type enough letters to disambiguate. For example, if you type:

```bash
$ fdn o whatever
```

It'll be automatically expanded to:

```bash
$ fdn open whatever
```


Contributing
------------

Bug reports, fixes, and feature suggestions are encouraged. Please check out our [issue tracker][is] for more.

License
-------

fdn is released under the [BSD-3 license][li].

[bb]: https://github.com/etcd-io/bbolt
[cf]: https://github.com/ActiveState/appdirs
[ch]: https://github.com/spheten/fdn/blob/master/changes.md
[fm]: https://jekyllrb.com/docs/front-matter/
[is]: https://github.com/spheten/fdn/issues
[li]: https://github.com/spheten/fdn/blob/master/license.md
[re]: https://github.com/spheten/fdn/releases/latest