Skip to content

コマンド一覧

esa-cliのコマンド一覧です。学習順序に従って段階的にコマンドを学ぶことができます。

初めての方には以下の順序で学習することをお勧めします:

  1. 初期設定 - 最初に実行する必要があります
  2. 記事一覧 - 記事の確認から始めましょう
  3. 記事作成 - 新しい記事を作成しましょう
  4. 記事取得 - 記事のダウンロードを学びましょう
  5. 記事更新 - 記事の更新を学びましょう
  6. 記事一括移動 - 一括処理を学びましょう
コマンド説明詳細
setup初期設定詳細を見る
list記事一覧表示詳細を見る
create記事作成詳細を見る
fetch記事ダウンロード詳細を見る
update記事更新詳細を見る
コマンド説明詳細
move記事一括移動詳細を見る
fetch-all記事一括ダウンロード下記参照
update-all記事一括更新下記参照

条件に一致する記事を一括でダウンロードします。

Terminal window
esa-cli fetch-all [オプション]

主なオプション:

  • --category - カテゴリでフィルタ
  • --tag - タグでフィルタ
  • --query - 検索ワードでフィルタ
  • --user - 作成者でフィルタ
  • --limit - 取得件数制限(デフォルト: 10)

使用例:

Terminal window
# 特定のカテゴリの記事を一括ダウンロード
esa-cli fetch-all --category 開発
# 特定のタグの記事を一括ダウンロード
esa-cli fetch-all --tag API
# 取得件数を制限して一括ダウンロード
esa-cli fetch-all --category 開発 --limit 5

複数の記事を一括で更新します。

Terminal window
esa-cli update-all [パターン] [オプション]

主なオプション:

  • pattern - ファイルパターン(例: “123-.md”、デフォルト: “.md”)
  • --message - 更新メッセージ
  • --no-wip - WIP状態を解除
  • --category - カテゴリを変更
  • --force - 確認なしで実行

使用例:

Terminal window
# 現在のディレクトリの全記事を一括更新
esa-cli update-all
# 特定のパターンの記事を一括更新
esa-cli update-all "123-*.md"
# 確認なしで一括更新
esa-cli update-all --force

設定ファイルは ~/.esa-cli-config.json に保存されます。

{
"team_name": "your-team-name",
"access_token": "your-token"
}
  • team_name - esaのチーム名(サブドメイン)
  • access_token - esaのアクセストークン

以下の環境変数を使用できます:

  • ESA_TEAM - チーム名
  • ESA_TOKEN - アクセストークン
  • E001 - 設定ファイルが見つかりません
  • E002 - アクセストークンが無効です
  • E003 - 記事が見つかりません
  • E004 - ファイルの形式が不正です
  • E005 - ネットワークエラー