メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
認証要件

ほとんどのOctoparse CLIコマンドにはAPIキーが必要です。 APIキーはアカウントを識別し、CLIからOctoparseのタスクやデータにアクセスできるようにします。
ローカルの --task-file や .otd の実行を含め、すべての機能コマンドには有効なAPIキーが必要です。タスクの一覧表示、実行、エクスポートを行う前に octoparse auth login を実行してください。
ログイン前に実行できるのは、セットアップおよび診断コマンドのみです。 
octoparse --help
octoparse --version
octoparse capabilities
octoparse doctor
octoparse browser doctor
octoparse auth

​
APIキーを作成する

OctoparseコンソールでAPIキーを作成します。

API keysページを開く

アカウントセンターでOctoparse APIキーを作成、コピー、管理します。

​
対話形式でログインする

octoparse auth login
利用可能な場合はAPIキーページが開き、貼り付けたキーを検証してローカルに保存します。

​
コピーしたキーでログインする

octoparse auth login <apiKey>
<apiKey> は実際のOctoparse APIキーに置き換えてください。

​
stdinからキーを読み取る

別のツール、シークレットマネージャー、CIシステムからキーをコマンドに渡す場合は、--stdin を使用します。 
<your-api-key> | octoparse auth login --stdin
たとえば、シークレットマネージャーからキーを取得してCLIに渡すことができます。 
op read "op://vault/octoparse/credential" | octoparse auth login --stdin

​
ブラウザを開かない

APIキーページのURLを手動でコピーしたい場合は、--no-open を使用します。 
octoparse auth login --no-open

​
環境変数を使用する

CIや一時的なセッションでは、環境変数でキーを渡します。 
OCTO_ENGINE_API_KEY=xxx octoparse task list --json
必要に応じてAPIのベースURLも上書きできます。 
OCTO_ENGINE_API_BASE_URL=https://example.com OCTO_ENGINE_API_KEY=xxx octoparse task list

​
認証情報の優先順位

Octoparse CLIは次の順序で認証情報を確認します。 
1. OCTO_ENGINE_API_KEY
2. ~/.octoparse/credentials.json
認証情報ファイルは octoparse auth login によって自動的に作成され、CLI起動時に読み込まれます。 macOSとLinuxのデフォルトパス： 
~/.octoparse/credentials.json
Windowsの一般的な対応パス： 
%USERPROFILE%\.octoparse\credentials.json

​
認証ステータスを確認する

ログイン後、CLIが有効なセッションを読み取れることを確認します。 
octoparse auth status
保存された認証情報を削除するには： 
octoparse auth logout
APIキーをGit、スクリプト、ドキュメント、スクリーンショット、共有ログ、CI出力に含めないでください。

​
次のステップ

認証が成功したら、最初のタスクワークフローに進みます。

最初のタスクを実行する

タスクを一覧表示し、確認し、ローカルで実行し、データをエクスポートします。

すべてのコマンドを見る

認証、タスク、ローカル実行、クラウド実行、エクスポート関連のコマンドを確認します。