stationery

v0.5.1

Published

4 years ago

Compose letters at the command line.

0High
0Medium
0Low

mgmarlow

cli node javascript

build status

Stationery

A tool for composing letters in the command line. Inspired by jrnl.

$ dear Beatrice, Then is courtesy a turncoat. But it is certain I am loved of all ladies,
only you excepted; and I would I could find in my heart that I had not a hard heart,
for truly I love none. -- Benedick

Results in:

Beatrice-12-2-17.txt
> Dear Beatrice,
> 
> Then is courtesy a turncoat. But it is certain
> I am loved of all ladies, only you excepted; and
> I would I could find in my heart that I had not a
> hard heart, for truly I love none.
> 
> Yours,
> Benedick

Installation

npm install -g stationery

Compositions

Compose letters with the dear command, following much in the way that you would write a normal letter.

dear <subject>, <body> -- <signature>

Compositions require that a subject is specified. The subject line must end with a comma.

dear Beatrice,
dear Don John,

The rest of the command will be interpreted as the letter's body, up until any optional arguments.

End your letter with -- <signature> to provide your name as a signature. Signatures will default to "truly" unless otherwise specified in the .stationeryconfig. Note: a signature must be the last item provided to stationery, meaning all other arguments must come before it:

dear Beatrice, Hello. --tpl informal-greeting -- Benedick

Stationery saves new letters at the path: %USERPROFILE%/stationery/compositions/. Letters are named with the format: <subject>-<timestamp>.txt.

Working with Compositions

list: List all compositions with -l or --list:

dear -l

> Beatrice-2017-12-9.txt
> Don-John-2017-12-10.txt

list all: List compositions with contents with -la or --list --all:

dear -la

> Beatrice-2017-12-9.txt
>Dear Beatrice,
>
>Then is courtesy a turncoat.
>
>Yours,
>Benedick

...

editor: Open an editor (default vim) with -e or --editor. Letters will be saved to your compositions directory:

dear -e

> Name your composition: To Beatrice
# Opens vim
# Saves to usr/stationery/compositions/To-Beatrice-2017-12-24.txt

Configuration

By default, stationery will look for configuration at %USERPROFILE%/.stationeryconfig. You can override this behavior with the --config argument, supplying your own json file as the argument.

An example configuration file:

.stationeryconfig

{
    "signature": "Holmes: detective, entreprenuer, smart guy."
}

With the above configuration, this will be your output from stationery:

$ dear Beatrice, Hello.

/usr/stationery/compositions/Beatrice-12-2-17.txt
> Dear Beatrice,
>
> Hello.
>
> Yours,
> Holmes: detective, entreprenuer, smart guy.

Templates

Built-in Templates

basic-letter (default)

Use a built-in template with the --tpl command:

dear Beatrice, Then is courtesy a turncoat. --tpl basic-letter

Custom Templates

You can also write your own letter templates and provide them to Stationery through the --tpl command. To do this, simply make your own template (.mustache) and pass the file in as the parameter to --tpl.

dear Beatrice, Then is courtesy a turncoat. --tpl ./love-letters/my-template.mustache

Templates follow the standard mustache handlebar syntax with the following keywords:

subject - The subject of the letter
body - The body text of the letter
author - The author of the letter

Let's make a more formal letter, say formal-letter.mustache.

Dearest {{ subject }},

{{ body }}

Sincerely,
{{ author }}

Create your own template in any directory and pass it in using --tpl:

dear Beatrice, Then is courtesy a turncoat. --tpl ./templates/formal-letter.mustache

Roadmap

[x] Basic letter templates and save to file
[x] Template engine (allow users to provide path to mustache template)
[x] Multi-word subjects
[x] Configuration: default signatures
[x] Editing utilities
[ ] Searching utilities
[ ] Website
[ ] Provide more templating utilities
[ ] Notetaking
[ ] Multiple output formats
[ ] Copy to clipboard

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme