> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Olostep CLI の使用

> コマンド構造、出力、JSON、グローバルフラグ、環境変数、終了コード。

## コマンド構造

```bash theme={null}
olostep <group> <command> [arguments] [flags]
```

コマンドは、作業対象によってグループ化されています。例えば、`olostep keys list` や `olostep monitors pause <monitor_id>` です。主要なウェブデータコマンドには、作成コマンドを実行するショートカットがあります：

| ショートカット | 実行内容 |
| - | - |
| `olostep scrape <url>` | `olostep scrape create <url>` |
| `olostep search "<query>"` | `olostep search create "<query>"` |
| `olostep map <url>` | `olostep map create <url>` |
| `olostep crawl <url>` | `olostep crawl create <url>` |
| `olostep answer "<task>"` | `olostep answer create "<task>"` |
| `olostep extract <url>` | `olostep extract run <url>` |

`olostep whoami` は `olostep account info` と同じです。

## ヘルプを取得

```bash theme={null}
olostep --help                  # 各コマンドグループ
olostep monitors --help         # グループ内のコマンド
olostep monitors create --help  # 1つのコマンドの引数とフラグ
olostep help export logs        # 実行内容でコマンドを探す
```

`olostep help <words>` は、名前や説明にすべての単語を含むコマンドを一覧表示します。ヘルプはサインインなしで動作します。

## 出力

CLI は出力先に応じて出力を選びます：

| 出力先 | 取得内容 |
| - | - |
| ターミナル | フォーマットされた Markdown：見出し、テーブル、色。エラーには赤が使用されます。 |
| パイプやファイル、または `NO_COLOR` が設定されている場合 | 色なしのプレーンテキストとして同じ Markdown。 |
| 任意の宛先で `--json` を使用 | スクリプトやエージェント用の正確な JSON。 |

エラーは stderr に送られるため、stdout をパイプしてもデータに混ざることはありません。

`FORCE_COLOR=0` または `TERM=dumb` が設定されている場合も色はオフになります：

```bash theme={null}
NO_COLOR=1 olostep credits balance
```

### JSON

ヘルプに記載されているコマンドに `--json` を追加：

```bash theme={null}
olostep scrape https://example.com -f markdown --json
```

Olostep を呼び出すコマンドは1つの JSON オブジェクトを返します：

```json theme={null}
{
  "operation": "<operation>",
  "mode": "executed",
  "data": {},
  "warnings": []
}
```

| フィールド | 説明 |
| - | - |
| `operation` | 実行された操作。 |
| `mode` | `read`、`executed`、`dry_run`、`browser`、`unavailable` のいずれか。 |
| `data` | 結果。形状はコマンドに依存します。 |
| `warnings` | 結果について知っておくべきこと、例えば部分的なデータ。何もない場合は空です。 |

人間が読める出力ではなく、JSON を解析してください。人間用の出力はバージョン間で変更される可能性があります。

### フィールドを選択

`--fields` は指定したフィールドのみを保持します。フィールドはカンマで区切り、ネストされたフィールドにはドットを使用します。選択した各フィールドは、指定したパスの下に表示されます：

```bash theme={null}
olostep whoami --json --fields mode,warnings
```

```json theme={null}
{"mode":"read","warnings":[]}
```

ネストされたフィールドを選ぶには、まず完全な `--json` 出力を一度確認し、`data.<field>` として名前を指定します。`--fields` は `--json` なしでも動作し、テーブルにそのフィールドのみを表示します。

### jq にパイプする

```bash theme={null}
olostep credits balance --json | jq '.data'
olostep crawl pages <crawl_id> --json | jq '.data'
```

## 値を渡す

| フラグの種類 | 渡し方 | 例 |
| - | - | - |
| テキストまたは数値 | フラグの後に | `--country US`, `--max-pages 50` |
| 繰り返し可能なリスト | フラグを繰り返すか、カンマで区切る | `-f markdown -f html` または `-f markdown,html` |
| JSON | インライン JSON、または `@` とファイルパス | `--metadata '{"project":"q3"}'` または `--items @urls.json` |
| ブール値 | フラグのみ | `--include-subdomain` |
| 固定選択 | ヘルプに表示される値の1つ | `--days 7`, `--format csv` |

位置指定の URL やクエリもフラグとして渡すことができます。例えば `olostep scrape create --url-to-scrape https://example.com` や `olostep search create --query "olostep"` です。

## 変更を加えるコマンド

何かを作成、変更、削除するコマンドやクレジットを使用するコマンドは、ヘルプでその旨を示します。これらは次のことをサポートします：

| フラグ | 内容 |
| - | - |
| `--dry-run` | CLI が行う呼び出しを表示し、何も送信しません。 |
| `--preview` | Olostep に変更をプレビューするよう依頼し、実際には行いません。 |
| `--yes` | 確認をスキップします。削除や上書きの可能性があるコマンドは、確認するターミナルがない場合に `--yes` が必要です。これがないと、コード `4` で終了します。 |

```bash theme={null}
olostep monitors delete <monitor_id> --dry-run
olostep monitors delete <monitor_id> --yes
```

クレジットを使用するコマンド、例えば `scrape`、`search`、`map`、`crawl`、`answer`、`extract`、`batch create`、`monitors create`、`monitors run`、`agents run` は、ヘルプで `This consumes credits` または `consumes credits` と表示されます。

## グローバルフラグ

これらのフラグはすべてのコマンドで動作します：

| フラグ | 説明 |
| - | - |
| `-h`, `--help` | コマンドのヘルプを表示して終了します。 |
| `--server <url>` | 使用する Olostep CLI サーバー。デフォルトは `https://cli.olostep.com/mcp`。 |
| `--token <token>` | 保存されたサインインの代わりにこのトークンを使用します。詳細は [Authentication](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents) を参照。 |
| `--refresh-tools` | キャッシュされたコピーの代わりに、サーバーから現在のコマンドとその入力リストを取得します。 |

これらのフラグは、ヘルプに表示されているすべてのコマンドで動作します：

| フラグ | 説明 |
| - | - |
| `--json` | JSON を出力：スクリプトやエージェント用。 |
| `--fields <a,b>` | カンマで区切られたこれらのフィールドのみ（ネストされたものは `a.b`）。 |
| `--dry-run` | 行う呼び出しを表示し、何も送信しません。 |
| `--preview` | 何も変更せずにプレビューします。 |
| `--yes` | 先に確認しません（ターミナルがない場合に必要）。 |

## 環境変数

| 変数 | 説明 |
| - | - |
| `OLOSTEP_TOKEN` | 保存されたサインインの代わりに使用するトークン。同じく `--token`。 |
| `OLOSTEP_SERVER` | サーバー URL。同じく `--server`。 |
| `OLOSTEP_HOME` | インストールスクリプトが CLI を配置する場所。デフォルトは `~/.olostep`。絶対パスでなければなりません。 |
| `NO_COLOR` | 任意の値で色をオフにします。 |
| `XDG_CONFIG_HOME` | CLI はサインインを `$XDG_CONFIG_HOME/olostep` に保持します。デフォルトは `~/.config/olostep`。 |
| `CI` | 更新通知をオフにします。 |

## 終了コード

| コード | 意味 |
| - | - |
| `0` | 完了。 |
| `1` | コマンドが失敗しました。メッセージは stderr にあります。 |
| `2` | コマンドまたは引数が間違っています。 |
| `3` | サインインが必要です。`olostep login` を実行するか、`OLOSTEP_TOKEN` を設定してください。 |
| `4` | コマンドには `--yes` が必要です。 |
| `5` | サーバーに接続できませんでした。 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.