コマンド一覧
esa-cliのコマンド一覧です。学習順序に従って段階的にコマンドを学ぶことができます。
初めての方には以下の順序で学習することをお勧めします:
- 初期設定 - 最初に実行する必要があります
- 記事一覧 - 記事の確認から始めましょう
- 記事作成 - 新しい記事を作成しましょう
- 記事取得 - 記事のダウンロードを学びましょう
- 記事更新 - 記事の更新を学びましょう
- 記事一括移動 - 一括処理を学びましょう
コマンド一覧
Section titled “コマンド一覧”基本コマンド
Section titled “基本コマンド”コマンド | 説明 | 詳細 |
---|---|---|
setup | 初期設定 | 詳細を見る |
list | 記事一覧表示 | 詳細を見る |
create | 記事作成 | 詳細を見る |
fetch | 記事ダウンロード | 詳細を見る |
update | 記事更新 | 詳細を見る |
高度なコマンド
Section titled “高度なコマンド”コマンド | 説明 | 詳細 |
---|---|---|
move | 記事一括移動 | 詳細を見る |
fetch-all | 記事一括ダウンロード | 下記参照 |
update-all | 記事一括更新 | 下記参照 |
一括処理コマンド
Section titled “一括処理コマンド”fetch-all
Section titled “fetch-all”条件に一致する記事を一括でダウンロードします。
esa-cli fetch-all [オプション]
主なオプション:
--category
- カテゴリでフィルタ--tag
- タグでフィルタ--query
- 検索ワードでフィルタ--user
- 作成者でフィルタ--limit
- 取得件数制限(デフォルト: 10)
使用例:
# 特定のカテゴリの記事を一括ダウンロードesa-cli fetch-all --category 開発
# 特定のタグの記事を一括ダウンロードesa-cli fetch-all --tag API
# 取得件数を制限して一括ダウンロードesa-cli fetch-all --category 開発 --limit 5
update-all
Section titled “update-all”複数の記事を一括で更新します。
esa-cli update-all [パターン] [オプション]
主なオプション:
pattern
- ファイルパターン(例: “123-.md”、デフォルト: “.md”)--message
- 更新メッセージ--no-wip
- WIP状態を解除--category
- カテゴリを変更--force
- 確認なしで実行
使用例:
# 現在のディレクトリの全記事を一括更新esa-cli update-all
# 特定のパターンの記事を一括更新esa-cli update-all "123-*.md"
# 確認なしで一括更新esa-cli update-all --force
設定ファイル
Section titled “設定ファイル”設定ファイルは ~/.esa-cli-config.json
に保存されます。
{ "team_name": "your-team-name", "access_token": "your-token"}
設定項目の説明
Section titled “設定項目の説明”team_name
- esaのチーム名(サブドメイン)access_token
- esaのアクセストークン
以下の環境変数を使用できます:
ESA_TEAM
- チーム名ESA_TOKEN
- アクセストークン
エラーコード
Section titled “エラーコード”E001
- 設定ファイルが見つかりませんE002
- アクセストークンが無効ですE003
- 記事が見つかりませんE004
- ファイルの形式が不正ですE005
- ネットワークエラー