Workflowy CLI

ターミナル、スクリプト、AIエージェントからWorkflowyを使用します。


Workflowy CLI(wf)は、Workflowyアカウントの読み取り、検索、整理、編集を行うオープンソースのコマンドラインツールキットです。高速アクセス用のローカルキャッシュ、自動化コマンド、スクリプトやエージェント向けの機械可読出力、組み込みMCPサーバーが含まれています。

ソースコードと最新リリースはWorkflowy CLIのGitHubリポジトリにあります。

できること

  • ターミナルからWorkflowyアカウントを読み取り、検索する
  • 項目を追加、更新、移動、完了、削除する
  • @inbox@today@tomorrowなどの組み込み場所を使用する
  • ブックマークとパスを使ってアカウント内の特定部分を指定する
  • アウトラインをエクスポートし、ToDoやタグを検索して、最近の変更を確認する
  • 複数のWorkflowyアカウントを接続し、アカウントごとに別のローカルキャッシュを保持する
  • スクリプトやAIエージェント向けに構造化JSONを返す
  • MCP対応のAIツールをWorkflowyに直接接続する

必要なもの

インストール方法

macOSとLinux

次のコマンドをターミナルにコピーして貼り付けます。

curl -fsSL https://github.com/rodolfo-terriquez/workflowy-cli/releases/latest/download/install.sh | bash

Windows

次のコマンドをPowerShellにコピーして貼り付けます。

irm https://github.com/rodolfo-terriquez/workflowy-cli/releases/latest/download/install.ps1 | iex

インストーラーはOSとプロセッサを検出し、最新のビルド済みバージョンをダウンロードして、可能な場合はwfコマンドをPATHに追加します。

Workflowyアカウントを接続する

インストール後に次のコマンドを実行します。

wf login
wf cache:sync
wf doctor

wf loginはWorkflowy APIキーを表示せずに入力を求めます。wf cache:syncは高速な読み取りと検索のためにアウトラインのローカルコピーをダウンロードします。wf doctorはログイン、設定、キャッシュ、インストールを確認します。

CLIを使い始める

場所を読み取るか、アカウントを検索します。

wf node:read @inbox
wf node:read @today --depth 3
wf search "quarterly planning"
wf targets

項目を追加して管理します。

wf node:add @inbox "Draft project brief" --type todo
wf node:complete "@inbox/Draft project brief"
wf node:move "@today/Review roadmap" @inbox
wf node:update "@inbox/Follow up" --note "Waiting on a reply"

対象を受け取るコマンドでは、組み込み場所、wf targetsが返すブックマーク、項目ID、または@today/Meetings/Launch reviewのようなパスを使用できます。

すべてのコマンドを確認するにはwf --helpを実行します。各コマンドのオプションを確認するには、そのコマンドの後に--helpを追加します。

ローカルの結果を最新に保つ

ほとんどの読み取りコマンドと検索コマンドは、ローカルのSQLiteキャッシュを自動的に使用します。Workflowyアカウントの最新コピーが必要なときに同期してください。

wf cache:sync

キャッシュを使用しない1回限りのリクエストでは、対応するコマンドに--liveを追加します。

wf node:read @inbox --live
wf search "launch notes" --live

複数のアカウントを接続する

ログイン時に各アカウントへ短いローカル名を付けます。

wf login --account personal
wf login --account work
wf account:list
wf account:switch work
wf account:current

アカウントごとに独自のローカルキャッシュが保持されます。既定のアカウントを変更せずに、1つのコマンドだけで使用するアカウントを選択できます。

wf --account personal cache:sync
wf --account work node:add @inbox "Follow up with the team"

スクリプトやAIエージェントでCLIを使用する

--agentを追加すると、構造化された結果とエラーを含む機械可読JSONが返されます。

wf search "project roadmap" --agent
wf node:read @today --depth 3 --agent

CLIにはローカルMCPサーバーも含まれています。

wf mcp

インストールしたwfバイナリを引数mcpで実行するようMCPクライアントを設定します。サーバーがCLIと同じアカウントとキャッシュを使用できるように、最初にwf loginwf cache:syncを実行してください。設定例と高度なMCPオプションについては、Workflowy CLI READMEを参照してください。

CLIを更新する

次のコマンドで新しいリリースを確認またはインストールします。

wf self:update --check
wf self:update

セキュリティとトラブルシューティング

  • APIキーがシェル履歴に保存されないよう、wf loginの対話形式の入力を使用してください。
  • 検索結果が古い場合は、wf cache:syncを実行するか--liveを使用してください。
  • コマンドが別のアカウントを使用している場合は、wf account:currentを確認し、wf account:switch <name>で切り替えてください。
  • インストール後にwfが見つからない場合は、新しいターミナルを開き、インストール先ディレクトリがPATHに含まれていることを確認してください。
  • インストール、認証、設定、キャッシュを確認するにはwf doctorを実行してください。
  • バグや機能リクエストは、リポジトリのGitHub Issuesに投稿してください。

次の記事
Workflowy APIでAIエージェントを構築する
カスタムエージェント、アプリケーション統合、自動化が必要な場合は、Workflowy APIを直接使用します。