メインコンテンツまでスキップ

Shodo CLIリファレンス

このリファレンスでは、Shodo CLIで使用できるコマンドラインインターフェースおよびそのオプション・フラグについて説明します。

コマンド​

Shodo CLIは以下のコマンドを提供しています。

$ shodo login​

Shodo APIを使用するためにShodo CLIにログイン情報を入力しローカルに保存します。

注記

すべての設定は ~/.config/shodo/credentials に保存されますが、 XDG_CONFIG_HOME の環境変数を使用して場所を上書きできます。
また、 SHODO_API_TOKEN と SHODO_API_ROOT の環境変数を使用することによってログイン情報を保存せずに直接APIを利用することも可能です。

オプション​

  • --profile : 任意のプロファイル名を指定します。何も入力しない場合は default です。

使用例​

基本的な使用例
$ shodo login
APIルート：https://api.shodo.ink/@{organization}/{project}/
APIトークン：
プロファイル名を指定する使用例
$ shodo login --profile my-profile
APIルート：https://api.shodo.ink/@{organization}/{project}/
APIトークン：

$ shodo lint​

ファイルやユーザーからの入力された日本語の文章をAI校正し修正案を表示します。

引数​

  • FILENAME : 校正するファイルのパスを指定します。

オプション​

  • --html : 校正する日本語がHTML形式であることを指定します。
  • --output : 出力方式を選択します。 text もしくは json が指定可能です。未選択の場合は text が使用されます。
  • --profile : 任意のプロファイル名を指定します。何も入力しない場合は default です。

使用例​

テキストファイルを指定した使用例
$ shodo lint README.md
Linting...
1:11 もしかして：変換ミス
     飛行機の欠便があり、運行（→ 運航）状況が変わった。 バ
HTMLファイルを指定した使用例
$ shodo lint index.html --html
Linting...
2:17 もしかして：変換ミス
     飛行機の欠便があり、運行（→ 運航）状況が変わった。</
出力方式をjsonに指定した使用例
$ shodo lint README.md --output json
Linting...
[
  {
    "code": "ai_recommend",
    "message": "もしかして：変換ミス",
    "severity": "error",
    "to": {
      "line": 0,
      "ch": 12
    },
    "index": 24,
    "index_to": 26,
    "score": 0.9935401082038879,
    "before": "運行",
    "after": "運航",
    "operation": "replace",
    "meta": {},
    "from": {
      "line": 0,
      "ch": 10
    },
  }
]
ファイルを指定せずに入力で日本語の文章を校正する使用例
$ shodo lint
飛行機の欠便があり、運行状況が変わった。
Linting...
1:11 もしかして：変換ミス
     飛行機の欠便があり、運行（→ 運航）状況が変わった。

入力を終了して校正リクエストを行いたい場合は、Windowsの場合は Ctrl + Z、Mac、Linuxの場合は Ctrl + D を入力してください。

$ shodo download​

API連携を設定しているプロジェクト内のすべての投稿と画像をダウンロードします。

備考

API連携プランを使用している場合、このコマンドは使用できません。

オプション​

  • --target : ダウンロードするディレクトリを指定します。未指定の場合は docs にダウンロードされます。
  • --in-tree : フォルダーに分類されている投稿のみを指定します。
  • --profile : 任意のプロファイル名を指定します。何も入力しない場合は default です。

使用例​

基本的な使用例
$ shodo download
Downloaded docs/Shodoお知らせ/Shodoの校正APIがHTML形式での入力に対応しました.md
Downloaded Image docs/Shodoお知らせ/images/189_1.png
Downloaded Image docs/Shodoお知らせ/images/189_2.png
Downloaded Image docs/Shodoお知らせ/images/189_3.png
Downloaded Image docs/Shodoお知らせ/images/189_4.png
Downloaded docs/未分類/ShodoのAPIが公開されました.md
Downloaded Image docs/Shodoお知らせ/images/127_1.png
Downloaded Image docs/Shodoお知らせ/images/127_2.png
Downloaded Image docs/Shodoお知らせ/images/127_3.png
Downloaded Image docs/Shodoお知らせ/images/127_4.png
ダウンロード先を指定した使用例
$ shodo download --target my-docs
Downloaded my-docs/Shodoお知らせ/Shodoの校正APIがHTML形式での入力に対応しました.md
Downloaded Image my-docs/Shodoお知らせ/images/189_1.png
Downloaded Image my-docs/Shodoお知らせ/images/189_2.png
Downloaded Image my-docs/Shodoお知らせ/images/189_3.png
Downloaded Image my-docs/Shodoお知らせ/images/189_4.png
Downloaded my-docs/未分類/ShodoのAPIが公開されました.md
Downloaded Image my-docs/Shodoお知らせ/images/127_1.png
Downloaded Image my-docs/Shodoお知らせ/images/127_2.png
Downloaded Image my-docs/Shodoお知らせ/images/127_3.png
Downloaded Image my-docs/Shodoお知らせ/images/127_4.png
フォルダに分類された投稿のみの使用例
$ shodo download --in-tree
Downloaded my-docs/Shodoお知らせ/Shodoの校正APIがHTML形式での入力に対応しました.md
Downloaded Image my-docs/Shodoお知らせ/images/189_1.png
Downloaded Image my-docs/Shodoお知らせ/images/189_2.png
Downloaded Image my-docs/Shodoお知らせ/images/189_3.png
Downloaded Image my-docs/Shodoお知らせ/images/189_4.png