Pit Officer

Pit Officer

ウェブサイト：officer.openpit.dev

Pit Officer を使うと、取引口座の管理、リスク制限の設定、ブローカーへの接続、ウェブパネルからの注文送信ができます。OpenPit のリスクエンジンは、Officer が取引接続を通じて注文を送信する前に、各注文をチェックします。取引ソフトウェアや AI エージェントから Officer を利用することもできます。

実行

画面を見ながら進められるガイドについては、動画ガイドをご覧ください。

Officer はご自身のコンピューター上で動作し、ウェブブラウザーから利用します。Docker を使えば、ビルドやプログラミングツールのインストールをせずに、Windows、macOS、Linux で同じ完成済みアプリケーションを実行できます。

Docker をまだお持ちでない場合は、Docker のインストールガイドに従ってください。Docker Desktop を起動し、実行中と表示されるまで待ちます。Linux では Docker Engine も使用できます。クイックスタートをご覧ください。

コマンドを入力するウィンドウであるターミナルを開きます。Windows ではスタートメニューから PowerShell、macOS では Terminal、Linux ではお使いのターミナルアプリケーションを開いてください。以下のコマンドをコピーして貼り付け、Enter キーを押します。コマンドはどのシステムでも同じです。

docker run -d --name pit-officer --restart unless-stopped -p 127.0.0.1:8787:8787 -v pit-officer-data:/data ghcr.io/openpitkit/officer:latest

latest は Officer の最新の安定版です。初回実行時には Officer がダウンロードされるため、数分かかることがあります。その後、バックグラウンドで実行されるので、ターミナルを閉じてもかまいません。設定や記録は、pit-officer-data という名前のストレージにコンピューター上で保存され、Officer を停止または再起動しても保持されます。

準備ができているか確認するには、次を実行します。

docker ps --filter name=pit-officer

STATUS 列に (healthy) と表示されたら、ブラウザーで http://127.0.0.1:8787 を開き、ブックマークに追加します。(health: starting) と表示された場合は、数秒待ってからもう一度確認してください。パネルの準備ができたら、アカウント、リスク制限、接続を設定できます。

このアドレスの 127.0.0.1 はご自身のコンピューターを示し、8787 はパネルにアクセスするために使うポート番号です。別のポートを使うには、長いコマンドを実行する前に選択します。たとえば、-p 127.0.0.1:8787:8787 を -p 127.0.0.1:8788:8787 に置き換えてから、http://127.0.0.1:8788 を開きます。最後の 8787 は変更しないでください。これは Docker 内で Officer が使う番号です。

Officer を停止するには、docker stop pit-officer を実行します。再び起動するには、docker start pit-officer を実行してブックマークを開きます。これらのコマンドは初回インストール後に使います。長いコマンドを繰り返し実行する必要はありません。

リリース前の変更を試すには、代わりに edge ビルドを実行します。これは、開発中の最新バージョンのうち、チェックに合格したものです。頻繁に変更され、動作しない場合もあるため、安定版のインストールとは別に、専用の名前、ポート、ストレージを割り当ててください。

docker run -d --name pit-officer-edge --restart unless-stopped -p 127.0.0.1:8788:8787 -v pit-officer-edge-data:/data ghcr.io/openpitkit/officer:edge

次に http://127.0.0.1:8788 を開き、上記のコマンドでは pit-officer の代わりに pit-officer-edge を使います。

インストール方法、既存のインストール先のポート変更方法、パネルが開かない場合の対処については、クイックスタートをご覧ください。

ビルド

前提条件：OpenPit の Go バインディングが cgo 経由で必要とする C ツールチェーン、Go、ダッシュボードバンドル用の Node と npm。ツールのバージョンは .github/ci-versions.env で固定されています。

リポジトリのルートから、Go がコンパイル済みアセットを埋め込めるように、バイナリより先にダッシュボードをビルドします。

npm --prefix web ci
npm --prefix web run build
CGO_ENABLED=1 go build -o pit-officer ./cmd/pit-officer

Windows では、シェルで CGO_ENABLED=1 を設定し、go build -o pit-officer.exe ./cmd/pit-officer でビルドしてから、./pit-officer.exe を実行します。

ソースから実行

Pit Officer は、serve、mcp、dashboard、healthcheck の4つのサブコマンドを備えた単一のバイナリです。ビルド後、リポジトリのルートから実行します。

./pit-officer serve       # serve the dashboard, REST API, and HTTP MCP
./pit-officer dashboard   # in another terminal, open the running instance
./pit-officer mcp         # alternatively, run a local stdio MCP server

サブコマンド、環境変数、フラグ、認証モデルについては、設定リファレンスを参照してください。REST と MCP の統合については、API に関する注記を参照してください。

ローカルコンテナのビルド

docker-compose.yml の設定を使って、ローカルのコンテナイメージをビルドして実行するには、次の手順を実行します。

. ./.github/ci-versions.env
docker build --build-arg GO_VERSION="$CI_GO" -t pit-officer:local .
docker compose up

Just の省略コマンド（任意）

Just を使うと、上記の手動手順をより手早く実行できます。レシピの実行には Python 3 も必要です。完全なチェックでは、開発に関する注記で説明されているとおり、golangci-lint と Semgrep も使用します。

just frontend-ci-install  # npm ci in web/ from the committed lockfile
just build                # build the SPA, then the pit-officer binary
just run-serve            # build and serve
just dashboard            # open the running instance in the browser
just run-mcp              # build and run a local stdio MCP server
just docker-build         # build the pit-officer:local container image
just check                # format checks, linters, Semgrep, tests, frontend bundles

インポート可能なパッケージから独自の Officer を組み立てる方法、ローカルの Pit チェックアウトを使ったビルド方法、デバッグ用の各種バリアントについては、開発に関する注記を参照してください。

ライセンス

Apache License 2.0。詳細は LICENSE を参照してください。