インストール

Hubを起動する

SDKやutilsで作ったUIを表示するには、アプリと同じPCでHubを起動します。LinuxまたはmacOSとNode.js 22以上があれば、任意のディレクトリで実行できます。

npx @omochi-ui/cli hub

**http://127.0.0.1:5555/**を開きます。画面はCLIに同梱され、ローカルGatewayも自動起動します。リポジトリのclone、Bun、Rustのコンパイル、別のフロントエンドサーバーは不要です。Hubを使う間はターミナルを動かしておきます。

同じPCのアプリを使うだけなら、Gatewayを別に起動する必要はありません。別のPCのアプリを接続するときはリモート接続を参照してください。

インストールして使う

繰り返し使う場合はCLIをインストールできます。

npm install -g @omochi-ui/cli
omochi-ui hub

Rust環境では、最新のstable Rust/Cargoでインストールできます。

cargo install omochi-cli --locked
omochi-ui hub

Cargoパッケージ名はomochi-cli、実行コマンドはomochi-uiです。どちらの配布方法でもHub・Gateway・ダッシュボードが含まれます。SDKのomochi-uiクレートとは別です。

SDKやutilsをインストールしてもHubは起動しません。SDKアプリはその言語のSDKを使い、Hubは上のコマンドで起動します。utilsは別ターミナルでnpx @omochi-ui/utils ...として使えます。常設する場合はnpm install -g @omochi-ui/utils、またはcargo install omochi-utils --lockedでインストールします。

npm版はビルド済みバイナリを取得するのでRustは不要です。optional dependenciesを有効にしてください。対応環境はLinux（glibc）・macOSのx64/arm64で、ネイティブサービスはWindows未対応です。npmとCargoの公開バージョンは異なる場合があります。利用できるオプションはhub --helpで確認してください。

次は最初のUIでSurfaceを表示します。

ネイティブ配布アーカイブ

GitHub ReleasesからOS・CPUに合うアーカイブと.sha256を取得し、チェックサムを確認して展開します。

./install.sh  # 既定の配置先は $HOME/.local/bin
omochi-ui hub

アーカイブにはomochi-uiとomochi-utils、ビルド済みダッシュボードが含まれます。バイナリの実行にBun・Node.js・Python・Rustは不要ですが、起動するアプリには各言語の実行環境が必要です。Linux版はglibc向けで、macOS版は署名・公証されていません。

現在のソースからビルド

Omochi本体を開発する場合や同梱サンプルを動かす場合の手順です。LinuxまたはmacOS、Bun 1.4.3以上、最新のstable Rust/Cargoを用意してください。Pythonの例にはPython 3.11以上とuvが必要です。

git clone https://github.com/omochi-ui/omochi.git
cd omochi
bun install --frozen-lockfile
bun run build

SDK・ブラウザ側パッケージとネイティブCLIをビルドします。この手順にNode.jsは不要です。Unixソケットによる検出にはUnix系環境が必要で、ネイティブサービスは現在Windowsに対応していません。