jrnlは日々の記録をつけるのに役立つジャーナルアプリ的なコマンドです．

目次

  1. インストール
  2. 執筆
  3. 履歴
    1. 簡略表示
    2. 直近n件
    3. 期間指定
    4. 日付指定
  4. タグ
    1. タグ付け
    2. タグ一覧
  5. 削除・修正
  6. 検索
    1. 単語検索
    2. タグ検索
  7. 複数ジャーナル
    1. 設定
    2. ジャーナルごとの記事の履歴
    3. ジャーナルの一覧
  8. エクスポート
    1. 形式
    2. 出力先
  9. その他

インストール

macOSならHomebrewから

brew install jrnl

でインストールできます．
python製で，他のプラットフォームでは

pip install jrnl

からインストールします．

執筆

単に

jrnl

とするだけで，入力画面に移ります．
1行目はタイトルとなり，以下本文となります．

日時を指定する場合は，jrnl 日時: 文章という構成にします．

jrnl today at 3am: 文章

日時は様々に指定できます．

  • 昨日 yesterday
  • 曜日 last friday
  • 年月日 2020/10/24 24 october 2020
  • 時刻 2020-10-24 10:00

履歴

簡略表示

短く一覧するには，

jrnl --short

とします．

直近n件

直近n件の記事は

jrnl -n

のようにすることで表示できます．
ここでnは自然数です．

直前の記事であれば

jrnl -1

となります．

期間指定

今日までの記事であれば

jrnl -to today

と書くことができます．

昨年から3月までの記事だと，

jrnl -from "last year" -to march

です．

日付指定

1日前を指定するのであれば

jrnl -on yesterday

と書けます．

タグ

タグ付け

文中で単語を@で始めることにより，その単語がタグ付けされます．

例えば，

i am a @cat

とすると，catという単語にタグが付きます．

タグ一覧

jrnl --tags

削除・修正

ある日時までの記事を削除するとすれば，

jrnl -to 日時 --delete

です．

修正は--deleteに代えて--editで行えます．

検索

単語検索

wordという単語を検索する場合，

jrnl -contains "word"

と書きます．

タグ検索

tagという名前のタグを検索する場合，

jrnl @tag

とします．

タグのAND検索は

jrnl @tag1 -and @tag2

です．

複数ジャーナル

設定

設定ファイルを

vim ~/.config/jrnl/jrnl.yaml

で編集します．

YAML形式でjournalsの項目を編集します．

journals: 
  default: ~/journal.txt

となっているところを，例えば，

journals: 
  default: ~/journal.txt 
  d: 
    journal: ~/diary.md
    display_format: md

とします．

このとき，jrnl dで呼び出せるジャーナルが作成され，それはdiary.mdというファイルにマークダウン形式で書き込まれます．

作成したYAMLファイルでの設定を有効化するにはconfig-fileオプションを使い，

jrnl --config-file ~/.config/jrnl/jrnl.yaml

とします．

なお，デフォルトのジャーナルは

jrnl

で変わらず呼ばれます．

ジャーナルごとの記事の履歴

次のように，別のジャーナル上でも通常通りオプションを指定して記事を確認することができます．

例えば，dで呼ばれるジャーナルを作成しているとすれば，

jrnl d -1

でそのジャーナルで最後に作成した記事を表示することができます．

ジャーナルの一覧

listオプションで，設定したジャーナルの一覧を表示できます．

jrnl --list

このオプションは，次のように始動キーとジャーナルファイルの格納場所を表示します．

Journals defined in config (~/.config/jrnl/jrnl.yaml)
 * default -> ~/.local/share/jrnl/journal.txt
 * d       -> ~/.local/share/jrnl/diary.txt

エクスポート

形式

--formatオプションで形式を指定します．
デフォルトのプレーンテキストなら--format txtです．

形式には以下があります．

  • text（txtでも可）
  • markdown（mdでも可）
  • json
  • xml
  • yaml（※出力時はディレクトリを指定すること）

出力先

--file ファイル名とするとファイルへの書き出し，--file ディレクトリ名/とすると指定ディレクトリ内に個々の記事を指定した形式で書き出しとなります．

jrnl --format txt > filename.txt

のようにリダイレクトによる出力も可能です．

その他

暗号化や記事の読み込み，テンプレートの使用も可能です．