https://github.com/lukekarrys/dayone-templates

DayOne CLI with template support.
https://github.com/lukekarrys/dayone-templates

Last synced: 21 days ago
JSON representation

DayOne CLI with template support.

• Host: GitHub
• URL: https://github.com/lukekarrys/dayone-templates
• Owner: lukekarrys
• License: mit
• Created: 2017-01-19T23:49:51.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-14T01:03:25.000Z (over 3 years ago)
• Last Synced: 2024-12-16T18:27:13.987Z (about 1 month ago)
• Language: JavaScript
• Size: 177 KB
• Stars: 6
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - lukekarrys/dayone-templates - DayOne CLI with template support. (JavaScript)

README

        
dayone-templates

======================

[DayOne CLI](http://help.dayoneapp.com/command-line-interface-cli/) with template support.

**Note: this only works with DayOne v2.**

[![NPM](https://nodei.co/npm/@lukekarrys/dayone-templates.png)](https://nodei.co/npm/@lukekarrys/dayone-templates/)

[![Build Status](https://travis-ci.org/lukekarrys/dayone-templates.png?branch=master)](https://travis-ci.org/lukekarrys/dayone-templates)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

[![Greenkeeper badge](https://badges.greenkeeper.io/lukekarrys/dayone-templates.svg)](https://greenkeeper.io/)

## Install

**Prereqs**

```

# Install the dayone2 executable

sudo /Applications/Day\ One.app/Contents/Resources/install_cli.sh

```

**CLI**

```

npm install @lukekarrys/dayone-templates -g

```

**Module**

```

npm install @lukekarrys/dayone-templates --save

```

## Usage

This module is a system for creating DayOne entries that are populated via templates and passing data to those templates.

By default `dayone-templates` will look for templates in `~/.config/dayone-templates`. If you want to point it to somewhere else, use the `dir` option.

So first thing you should do is create some [mustache](https://mustache.github.io/) templates in the templates directory. For this example, let's say there's one in there called `run`.

Templates can have front-matter which can be used to populate the template with default data. When you're creating an entry, you can pass in data which will override that default data.

**~/.config/dayone-templates/run**

```

---

title: Run

tags:

  - run

  - workout

---

# {{title}}

**Workout**

{{workout}}

**Result**

{{result}}

**Notes**

{{notes}}

```

Then you can run the `dayone-templates` command. Specify the `name` of the template you just created, and any additional `tags` you want the entry to have. You can also populate any of the template variables. Also since `title` wasn't passed in, it will use the default `title` from the front-matter.

```sh

dayone-templates \

  --name run \

  --tags intervals \

  --workout "4x400" \

  --result "52, 51, 50, 49" \

  --notes "😄"

```

Then you'll have an entry that looks like this:

![](./output.png)

## CLI API

_See [the real dayone CLI](http://help.dayoneapp.com/command-line-interface-cli/) for a list of all available options. All those options can be passed to `dayone-templates` as well._

### `name` (required)

`String`

The name of the template to use. This should be a file located inside the `dir` option.

### `dir` (optional, default: `~/.config/dayone-templates`)

`String`

The directory to look for templates in.

### LICENSE

MIT