dayone2md

README

Dayone To Markdown

TODO

• https://github.com/ncruces/go-sqlite3

Export Dayone to Markdown.

dayone2md is a CLI application that can create a directory a markdown files from entries in Dayone. Use either a Dayone JSON archive or read directly from the Dayone database. Currently only MacOS is supported.

Features

• Input sources:
  • JSON export archive
  • read directly from the Dayone database
• Photos: download embedded photos and rewrite photo links
• Wikilinks: rewrite links to other entries as wikilinks
• Templates: supports external templates
• Title: separate out first line of posts as a title to format as desired
• In-place updates to output folder
• Conditional updates: only write files to output folder that differ from source
• Option to keep files in the output folder that do not exist at the source
• Flag to group posts by day in a single file
• Flag to alter sort order within day when grouped by day
• Installation: static binary without dependencies on external libraries

🚀 Install

brew install kwo/tools/dayone2md

💡 Usage

Usage:
  dayone2md [OPTIONS]

Application Options:
  -j, --journal=      journal name to export
  -i, --input=        input file, either the DayOne.sqlite database file or the JSON export zip file
  -o, --output=       output directory
  -t, --template=     name of the template to use, either the path of an external template file or the name of a built-in template: main or
                      full (default: main)
  -g, --group         group entries by day, one file per day, multiple entries per file
  -r, --reverse       reverse chronological sort order for entries within a file, useful only if entries are grouped by day
      --keep-orphans  do not remove files in the output directory that lack a matching entry in the input file
      --version       print version and exit
  -v, --verbose       show verbose output, list multiple times for even more verbose output

Help Options:
  -h, --help          Show this help message

Example Usage

dayone2md -i "$HOME/Library/Group Containers/5U8NS4GX82.dayoneapp2/Data/Documents/DayOne.sqlite" -o $HOME/Documents/Journal -j Journal -g -vv

OR

dayone2md -i "$HOME/Desktop/09-07-2023_8-30-PM.zip" -o $HOME/Documents/Journal -j Journal -g -vv

Input Sources

JSON Export archive

Follow these instructions to export entries from the Dayone app to a JSON archive.

Then, use the archive location as the import source, for example:

dayone2md -i "$HOME/Desktop/09-07-2023_8-30-PM.zip" ...

Database

The Dayone database on a Mac is located at

$HOME/Library/Group Containers/5U8NS4GX82.dayoneapp2/Data/Documents/DayOne.sqlite

To export entries directly from the database, use this location as the import source, like this:

dayone2md -i "$HOME/Library/Group Containers/5U8NS4GX82.dayoneapp2/Data/Documents/DayOne.sqlite" ...

The database is opened in readonly mode and an export can be performed while the Dayone app is open. Also, note that for premium users that are synchronizing data from multiple devices, the Dayone app must be run once before exporting to retrieve entries from the Dayone cloud service.

Disclaimer: be careful by keeping a backup of your data. As stated in the license, this software assumes no liability for data loss.

🧑‍💻 development

once:

brew install goreleaser golangci-lint
go install -v golang.org/x/vuln/cmd/govulncheck@latest

ongoing:

goreleaser release --clean --snapshot
./dist/dayone2md_darwin_arm64/dayone2md --version -vv

similar projects

• joshuacoles/Dayone-Export
• quantumgardener/dayone-to-obsidian

Documentation

Index

• func Convert(ctx context.Context, opts Options) error
• type Entry
• type Journal
• type Location
• type Metadata
• type Options
• type Photo
• type Weather

Functions

func Convert

func Convert(ctx context.Context, opts Options) error

Convert export DayOne entries to markdown.

Types

type Entry

type Entry struct {
	CreationDate        time.Time `json:"creationDate"`
	ModifiedDate        time.Time `json:"modifiedDate"`
	Date                time.Time `json:"-"` // CreationDate with timezone applied
	TimeZone            string    `json:"timeZone"`
	Duration            int       `json:"duration"`
	Pinned              bool      `json:"isPinned"`
	Starred             bool      `json:"starred"`
	AllDay              bool      `json:"isAllDay"`
	UUID                string    `json:"uuid"`
	Title               string    `json:"-"` // calculated
	Text                string    `json:"text"`
	Tags                []string  `json:"tags,omitempty"`
	Photos              []Photo   `json:"photos,omitempty"`
	Location            *Location `json:"location,omitempty"`
	Weather             *Weather  `json:"weather,omitempty"`
	EditingTime         float64   `json:"editingTime,omitempty"`
	CreationDevice      string    `json:"creationDevice,omitempty"`
	CreationDeviceType  string    `json:"creationDeviceType,omitempty"`
	CreationDeviceModel string    `json:"creationDeviceModel,omitempty"`
	CreationOSName      string    `json:"creationOSName,omitempty"`
	CreationOSVersion   string    `json:"creationOSVersion,omitempty"`
}

type Journal

type Journal struct {
	Metadata *Metadata `json:"metadata"`
	Entries  []Entry   `json:"entries"`
}

type Location

type Location struct {
	Label     string  `json:"userLabel"`
	Address   string  `json:"placeName"`
	City      string  `json:"localityName"`
	State     string  `json:"administrativeArea"`
	Country   string  `json:"country"`
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
	Altitude  float64 `json:"altitude"`
}

type Metadata

type Metadata struct {
	Version string `json:"version"`
}

type Options

type Options interface {
	GetJournalName() string
	GetInputLocation() string
	GetOutputDirectory() string
	GetTemplate() string
	IsGroupByDay() bool
	IsSortReverse() bool
	IsRemoveOrphans() bool
}

type Photo

type Photo struct {
	Date                 string    `json:"date"`
	Filename             string    `json:"filename"`
	FileSize             int       `json:"fileSize"`
	Height               int       `json:"height"`
	Identifier           string    `json:"identifier"`
	IsSketch             bool      `json:"isSketch"`
	MD5                  string    `json:"md5"`
	Type                 string    `json:"type"`
	Width                int       `json:"width"`
	AppleCloudIdentifier string    `json:"appleCloudIdentifier,omitempty"`
	CameraMake           string    `json:"cameraMake,omitempty"`
	CameraModel          string    `json:"cameraModel,omitempty"`
	CreationDevice       string    `json:"creationDevice,omitempty"`
	Duration             int       `json:"duration,omitempty"`
	ExposureBiasValue    int       `json:"exposureBiasValue,omitempty"`
	Favorite             bool      `json:"favorite,omitempty"`
	FocalLength          string    `json:"focalLength,omitempty"`
	FStop                string    `json:"fnumber,omitempty"`
	LensMake             string    `json:"lensMake,omitempty"`
	LensModel            string    `json:"lensModel,omitempty"`
	Location             *Location `json:"location,omitempty"`
	OrderInEntry         int       `json:"orderInEntry,omitempty"`
}

type Weather

type Weather struct {
	Conditions         string    `json:"conditionsDescription"`
	MoonPhase          float64   `json:"moonPhase"`
	MoonPhaseCode      string    `json:"moonPhaseCode"`
	PressureMB         float64   `json:"pressureMB"`
	RelativeHumidity   int       `json:"relativeHumidity"`
	SunriseDate        time.Time `json:"sunriseDate"`
	SunsetDate         time.Time `json:"sunsetDate"`
	TemperatureCelsius float64   `json:"temperatureCelsius"`
	VisibilityKM       float64   `json:"visibilityKM"`
	WeatherCode        string    `json:"weatherCode"`
	WeatherServiceName string    `json:"weatherServiceName"`
	WindBearing        int       `json:"windBearing"`
	WindSpeedKPH       float64   `json:"windSpeedKPH"`
}