CLIの使い方

Memoreru CLI

Memoreru CLIは、手元のパソコンにあるMarkdown・CSV・JSONファイルとMemoreruを同期するコマンドラインツールです。ページの原稿をファイルとして書いてまとめて反映したり、Memoreruのコンテンツを手元にダウンロードしたりできます。

CLIでできること

push: 手元のファイルをMemoreruにアップロード
pull: Memoreruのコンテンツを手元にダウンロード
status / diff: 前回の同期から何を変更したかを反映前に確認
画像の自動反映: Markdownから参照した画像はpush時に自動でアップロード
安全な同期: 複数人で同じテーブルを編集していても、行き違いを反映時に検知

ファイルはそのままGitで履歴管理できるため、コンテンツをファイル資産として運用したい方に向いています。

利用条件

CLIの利用にはAPIキーが必要で、ライトプラン以上でご利用いただけます。機能トライアル期間中も利用できます。

インストール

npmでインストールします。インストールせずに npx で実行することもできます。

# グローバルインストール
npm install -g @memoreru-sdk/cli

# インストールせずに実行
npx @memoreru-sdk/cli --help

memoreru の代わりに省略形の mem も使えます。どちらでも同じように動作します。

はじめの設定

1. ログイン

memoreru login

ブラウザが開くので、いつものMemoreruアカウントでログインしてください。

2. APIキーの作成

memoreru keys create

ログイン済みなら、このコマンドだけでAPIキーを発行できます。

画面から発行することもできます。設定 > セキュリティの「APIキー」カードでアクセス権限を読み取り+書き込みにして作成し、環境変数に設定してください。

export MEMORERU_API_KEY=あなたのAPIキー

基本の流れ

新しくコンテンツを作る場合の流れです。

# 1. テンプレートを生成
memoreru init ./my-page

# 2. 生成されたファイルを編集

# 3. 変更内容を確認
memoreru status ./my-page
memoreru diff ./my-page

# 4. Memoreruに反映
memoreru push ./my-page

すでにMemoreruにあるコンテンツをファイルとして編集したい場合は、pullから始めます。

memoreru pull ./my-data     # ダウンロード
# ファイルを編集
memoreru push ./my-data     # 反映

コマンド一覧

コマンド	説明
`memoreru login`	ブラウザでログインして認証情報を保存
`memoreru logout`	保存した認証情報を削除
`memoreru keys create`	APIキーを作成（`--read-only` で読み取り専用）
`memoreru keys list`	APIキーの一覧を表示
`memoreru keys revoke`	APIキーを無効化
`memoreru init`	コンテンツのテンプレートを生成（`--type` でタイプ指定）
`memoreru pull`	Memoreruのコンテンツを手元にダウンロード
`memoreru push`	手元のファイルをMemoreruにアップロード
`memoreru status`	前回の同期からの変更ファイルを一覧表示
`memoreru diff`	変更内容を差分形式で表示

pullとpushには --preview を付けられます。実際には書き込まず、何が反映されるかだけを確認できます。

ファイルとコンテンツの対応

コンテンツのタイプごとに、手元では次の形式のファイルになります。

コンテンツ	ファイル形式
ページ / スライド	`.md`（画像は `images/` フォルダ）
テーブル	`.csv`
ビュー / グラフ / ダッシュボード	`.json`
フォルダ	ディレクトリ

どのファイルをどのコンテンツとして同期するかは、各ディレクトリの .memoreru.json に記載します。記載したファイルだけが同期対象です。

{
  "readme.md": {
    "content_type": "page",
    "title": "プロジェクト README"
  },
  "tasks.csv": {
    "content_type": "table",
    "title": "タスク一覧"
  }
}

content_type だけが必須です。タイトルのほか、公開範囲・カテゴリ・タグ・サムネイルなどの情報も指定できます。初回のpushが終わると、Memoreru上のコンテンツと紐づけるための情報がこのファイルに自動で書き足されます。

同期の記録用に .memoreru/ フォルダが自動生成されます。Gitで管理する場合は .gitignore に追加してください。

テーブルとCSV

テーブルはCSVファイルとして同期します。1行目が列名、2行目からがデータです。

タイトル,ステータス,優先度
CI構築,完了,高
ドキュメント作成,進行中,中

初回のpushが終わると、各行を識別するための row_id と version の2列が先頭に追加されます（元のファイルは .bak.csv としてバックアップされます）。この2列は編集せず、そのままにしてください。

新しい行を追加するときは、row_id と version を空のままにします。

row_id,version,タイトル,ステータス,優先度
row_abc123,1,CI構築,完了,高
,,テスト追加,未着手,低

2回目以降のpushでは変更した行だけが反映されます。他の人が先に同じ行を更新していた場合は、push時に行き違いとして知らせてくれるので、うっかり上書きしてしまう心配がありません。

画像

Markdownの中で相対パスで参照した画像は、pushのときに自動でアップロードされます。

![スクリーンショット](./images/screenshot.png)

pullのときは、変更のあった画像だけがダウンロードされます。

複数アカウントの使い分け

仕事用と個人用など、複数のアカウントを使い分ける場合はプロファイルを利用します。

memoreru login --profile work     # workという名前で認証情報を保存
memoreru push ./docs --profile work

ディレクトリに .memoreru-config.json を置いておくと、そのディレクトリでの操作に使うプロファイルを固定できます。

{
  "profile": "work"
}

AIアシスタントと組み合わせる

Claude Codeと組み合わせると、「このフォルダをMemoreruに反映して」のように自然言語でCLIを操作できます。CLIに同梱されているスキルをコピーするだけで準備完了です。

cp -r node_modules/@memoreru-sdk/cli/skills/memoreru-cli ~/.claude/skills/

手元のファイルを介さず、テーブルのデータをAIから直接読み書きしたい場合はMCPサーバーが向いています。使い分けの目安は「外部連携の概要」をご覧ください。