Yam’s Peace Blog

この記事では、Joplin CLIを使ってUbuntu環境で効率的にメモを管理する方法を解説します。インストール方法、Dropboxやローカルファイルシステムを同期先として使う設定、それから基本的な使い方について解説します。 Joplinをターミナルから操作したいLinuxユーザーの参考になればと思います。

1. UbuntuへのJoplin CLIインストール方法

まずは、Joplin CLIをUbuntuにインストールします。JoplinはNode.jsベースのツールで、npmを使ってインストールします。

• Node.jsのインストール

  まず、Node.jsとnpmがインストールされていない場合は、以下のコマンドでインストールします。

  sudo apt update
  sudo apt install nodejs npm
  

• Joplin CLIのインストール

  次に、Joplin CLIをインストールします。 ~/.joplin-bin ディレクトリにインストールすることで、環境を汚さない設定を行います。

  NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
  

  インストールが完了すると、Joplin CLIを使えるようになります。

• パスの設定

  Joplin CLIをどこからでも使えるようにするため、パスを設定します。以下のコマンドを .bashrc や .zshrc に追加します。

  export PATH="$HOME/.joplin-bin/bin:$PATH"
  

  設定を反映するために、ターミナルを再起動するか、次のコマンドを実行します。

  source ~/.bashrc  # or source ~/.zshrc
  

  ---

2. Dropboxやローカルファイルシステムを同期先とする設定方法

Joplin CLIでノートを保存・同期するには、Dropboxやローカルファイルシステムを同期先として設定する必要があります。ここでは、両方の方法を紹介します。

Dropboxを同期先に設定する方法

• 同期ターゲットをDropboxに設定

  次のコマンドでDropboxを同期ターゲットに設定します。

  joplin config sync.target 7
  

• Dropboxの認証を行う

  次に、Joplin CLIをDropboxに接続します。まず、 joplin sync を実行すると、Dropboxの認証ページへのリンクが表示されます。

  joplin sync
  

• 認証コードの入力

  ブラウザでリンクを開き、DropboxにログインしてJoplinを認証します。認証後に表示されるコードをコピペしてターミナルに入力し、同期を開始します。ノートの数が多いとかなり時間がかかります。

ローカルファイルシステムを同期先に設定する方法

ローカルのフォルダを同期先として使う場合は、以下の設定を行います。

• 同期ターゲットをローカルファイルシステムに設定

  次のコマンドで同期ターゲットをローカルファイルシステムに設定します。

  joplin config sync.target 2
  

• 同期先フォルダを設定

  ローカルのディレクトリを指定します。例えば、 ~/joplin-sync というディレクトリを同期先にする場合は次のように設定します。

  joplin config sync.2.path ~/joplin-sync
  

• 同期を実行

  設定が完了したら、同期を実行します。

  joplin sync
  

  ---

3. 基本的なJoplin CLIコマンドの使い方

Joplin CLIでは、さまざまな操作がターミナルから行えます¹。以下にいくつかの基本的なコマンドを紹介します。

ノートブックを切り替える

現在作業中の(current)ノートブックを切り替えるには以下のコマンドを使います。

joplin use "ノートブック名"

use はlinuxの cd コマンドにあたります。Joplin CLIのコマンドはcurrentノートブック配下のノートが対象となりますので、 use コマンドの出番は多いです。ノートブック名、ノートのタイトルにスペースが含まれていなければダブルクォートは不要です。

ノートの作成

新しいノートを作成するには、以下のコマンドを使います。

joplin mknote "新しいノートのタイトル"

このコマンドの前に joplin use "ノートブック名" でcurrentなノートブックを指定しておきます。

ノートの一覧表示

ノート一覧を表示するには、次のコマンドを使います。ここでもまず use コマンドを発行しておきます。

joplin use "ノートブック名"
joplin ls

currentノートブック中のノートを表示します。 -l オプションをつけると詳細一覧が表示されます：

$ joplin use Health
$ joplin ls -l
kdqld 04/10/2024 10:41 体重管理プロジェクト
253hd 04/10/2024 10:39 1byone 体重計・体成分計の使い方
yah3k 29/09/2024 11:37 体重管理ダイヤグラム
　：

なお、ノートブックの一覧を表示するには ls / と入力します。

ノートの編集

ノートを編集するには以下を実行します。デフォルトのエディタは nano です。

joplin use "ノートブック名"
joplin edit "ノート名"

エディタを Emacs に変更するには、次のコマンドを実行します。

joplin config editor "emacs"

入力した"ノート名"(=hogehoge)がcurrentノートブックに存在しない場合には、

"hogehoge" というノートはありません。作成しますか？ (Y/n)

というメッセージが表示され Y を入力すると指定されたエディタが起動します。エディタを終了すると「ノートは保存されました。」というメッセージが表示されます。

ノートのインポート

MarkdownファイルをJoplinにインポートするには、次のコマンドを使用します。

joplin import --format md /path/to/file.md "ノートブック名"

この例では、“ノートブック名"の中に file という名前のノートが作られます。 currentノートブックに

ノートのタイトルを変更

joplin set "ノート名" title "新しいノート名"

ここで title はノートのプロパティ名です。 joplin help set でプロパティ名の一覧が表示されます。実際の操作例は次のとおりです。

$ joplin ls -l
4f4f9 09/10/2024 15:59 file

$ joplin set 'file' title 'new note'
$ joplin ls -l
4f4f9 09/10/2024 15:59 new note
$ joplin sync upgrade

joplin sync upgrade で、同期先を最新バージョンにアップグレードしています。

まとめ

このチュートリアルでは、Joplin CLIのインストール方法、Dropboxやローカルファイルシステムを同期先に設定する方法、そして基本的なコマンドの使い方を解説しました。

Joplin CLIを導入した目的は、Ubuntu PCで作成したデータやチャートをモバイル端末のJoplinで即時的にモニターできるようにするためでした。Joplin CLIのコマンドはささやかなものですが、十分に所期の目的は達成できました。便利になりました。

Acknowledgement

本記事はChatGPTを参考にさせていただきました。ありがとうございました。

Footnotes: