基本的な使い方

初めての方でも迷わず使えるよう、よく使うコマンドを紹介します。

記事の一覧表示

最新の記事を一覧表示します。

esa-cli list

カテゴリやタグで絞り込みも可能です。

# カテゴリで絞り込み
esa-cli list --category "開発/ドキュメント"

# タグで絞り込み
esa-cli list --tag "API"

記事の検索

タイトルや本文にキーワードを含む記事を検索できます。

esa-cli list --query "検索キーワード"

作成者での絞り込み

自分が作成した記事を絞り込んで表示できます。

esa-cli list --user "自分のユーザー名"

記事のダウンロード

記事番号を指定してMarkdownファイルとしてダウンロードします。

esa-cli fetch 123

フィルタリングと組み合わせて最新記事をダウンロードできます。

esa-cli fetch --category 開発 --latest

記事の更新

ローカルで編集したMarkdownファイルから記事を更新できます。

esa-cli update 123-article-title.md

オプションを組み合わせて効率的に更新できます。

# 123-article-title.md を開発カテゴリに変更して更新
esa-cli update 123-article-title.md --category 開発 --message "カテゴリを変更"

# WIP状態を解除して更新
esa-cli update 123-article-title.md --no-wip

リモート変更の安全な更新

チームで記事を編集する際、他の人が更新した内容を誤って上書きすることを防ぐ機能があります。

# 更新時にリモート変更があれば警告が表示されます
esa-cli update 123-article-title.md

警告が表示された場合：

• リモート記事の最終更新日時が表示されます
• 上書きするかどうか確認できます
• yで更新、Nでキャンセルが選択できます

カテゴリ・タグの活用

記事作成や更新時に --category や --tag オプションを使うことで、記事を整理できます。

次のステップ

基本的な操作に慣れたら、以下の機能を試してみてください：

• 一括処理: 高度な使い方で一括ダウンロード・更新を学ぶ
• 記事の整理: カテゴリの一括移動で記事を効率的に整理
• 自動化: シェルスクリプトでの自動化例を参考にする
• 実務シナリオ: 日報のアーカイブ化や本文の一括修正など、実務でよく使うパターンを参考にする

ユースケース

• ドキュメント管理: プロジェクトの設計書やAPI仕様をesaで一元管理
• ナレッジ共有: チームのTipsや手順書を素早く投稿・更新
• 定期バックアップ: 記事を定期的にローカルへダウンロード

詳細なコマンド仕様はコマンドリファレンスを参照してください。