/fossiliser

An archiver of statuses from a Mastodon user

Primary LanguageJanetMIT LicenseMIT

Fossiliser

Build Status

Fossiliser is a CLI utility written in Janet for archiving statuses from a Mastodon user to Markdown-formatted text files.

Installation

Build the fossil executable using JPM:

git clone https://github.com/pyrmont/fossiliser
cd fossiliser
jpm -l run exe-deps
jpm -l build

Now copy the build/fossil executable to a directory on your PATH.

Fossiliser can also be used as a library. Add the dependency to your project.janet file:

(declare-project
  :dependencies ["https://github.com/pyrmont/fossiliser"])

Usage

The fossil executable can be used like this:

Usage: fossil [--ignored-app <name>] [--mentions] [--output-dir <output-dir>] [<path>]

Archive statuses from a user on Mastodon.

Parameters:

 path    The path for the input file. (Default: stdin)

Options:

 -i, --ignored-app <name>         Statuses created by an application with this <name> will be ignored. This option can be used
                                  multiple times.
 -m, --mentions                   Include mentions in archive.
 -o, --output-dir <output-dir>    The directory in which to archive files. (Default: .)

 -h, --help                       Show this help message.

Bugs

Found a bug? I'd love to know about it. The best way is to report your bug in the Issues section on GitHub.

Licence

fossiliser is licensed under the MIT Licence. See LICENSE for more details.