Copy

はじめに

BoxLang をインストールし、テンプレートをクローンし、データベースを設定して、ログイン画面を開きます。

guides setup

このページ内

システム要件
BoxLang のインストール
macOS & Linux
Windows
アプリをスキャフォールドする
アプリを開く

はじめに

システム要件

Java 21+(JDK または JRE)
BoxLang 1.17+
CommandBox 7+(bx-cli)
Node.js 22+(Vite フロントエンド用)
サポートされているデータベース: MySQL 8+(デフォルト)、MariaDB、PostgreSQL、SQLite、Oracle、または MSSQL
任意の OS

BoxLang のインストール

macOS & Linux

# macOS & Linux
/bin/bash -c "$(curl -fsSL https://install.boxlang.io)"

# ...with automatic Java 21 installation
curl -fsSL https://install.boxlang.io | bash -s -- --with-jre

Windows

powershell -NoExit -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://install-windows.boxlang.io'))"

複数の BoxLang バージョンを切り替える必要がある場合は、代わりに BVM を使用してください。

curl -fsSL https://install-bvm.boxlang.io | bash

bvm install latest && bvm use latest

インストールを確認します。

boxlang --version

通常の CommandBox ではなく bx-cli を使用してください

CBGenesis は BoxLang テンプレートです。標準の Lucee ベースの CommandBox ディストリビューションはインストールしないでください。クイックインストーラーまたは BVM で BoxLang をインストールしたら、BoxLang ネイティブの CLI モジュールをインストールします。これは box install、box server、box migrate、box testbox を実行する前に必要です。

install-bx-module bx-cli

BoxLang CLI が有効になっていることを確認します。

box version

Lucee ベースの CommandBox ディストリビューションを現在使用している開発者は、必要なモジュールの最新バージョンが実行されるよう、キャッシュされたアーティファクトをクリーンにしてください。

box artifacts clean

インストール後に box が見つからない場合は、ターミナルを再起動するか、インストーラーが報告したディレクトリを PATH に追加してください。

アプリをスキャフォールドする

まず box と入力して CommandBox シェルに入ります。

最新の ColdBox CLI をインストールする

install coldbox-cli

CBGenesis アプリを作成する

coldbox create app name="my-app" skeleton="cbgenesis"

Node の依存関係をインストールする

!npm install

データベースの認証情報と設定を更新する

お好みのテキストエディタで .env ファイルを開き、データベースの認証情報を適宜更新してください。このテンプレートは MySQL 向けに事前設定されています。MySQL、MariaDB、PostgreSQL、MSSQL がサポートされ、テストされているデータベースターゲットです。server.json の onServerInitialInstall は、box server start を初めて実行したときに、DB_DRIVER 設定(bx-${DB_DRIVER}、デフォルトは bx-mysql)に一致する JDBC ドライバーモジュールをインストールします。他のデータベースを使用するには、その最初のサーバー起動前に .env で DB_DRIVER を設定してください。

マイグレーションとシード

.env を設定したら、以下のコマンドを実行してデータベースを初期化し、シードします。設定されたデータベースに CLI を接続するために必要なドライバーが自動的にダウンロードされるはずです。接続に問題がある場合は、正しい DB_DRIVER が設定されており、対応する JDBC ドライバーモジュールがインストールされていることを確認してください。

migrate init
migrate up --seed

シーダーは何を作成しますか?

resources/database/seeds/AdminData.bx は、組み込みの 20 個の権限をすべて持つ Admin ロールと、1 人の管理者ユーザーを作成します。

フィールド	値
メールアドレス	`admin@cbgenesis.com`
パスワード	`test`(リセット保留)

このアカウントはリセット保留としてシードされているため、test でサインインしてもセッションは得られません - 実際のパスワードを選ぶためのパスワードリセットフォームに直接送られます。これは意図的なものです。ブートストラップ用のハッシュはこのリポジトリに含まれており、公開されています。本番稼働チェックリストを参照してください。

AI スキルを更新する

CBGenesis は .agents/ に事前設定された AI ガイドライン、スキル、エージェントファイルを同梱しているため、GitHub Copilot、Cursor、Claude Code などのアシスタントは正確な ColdBox と BoxLang のコンテキストを取得できます。これらは、スキャフォールドの手順でインストールした coldbox-cli モジュールによって生成されます。ガイドラインとスキルがインストール済みのモジュールと一致するように、スキャフォールド後に更新してください。

coldbox ai refresh

CommandBox モジュールをインストール、更新、削除するたびに coldbox ai refresh を再実行して、モジュール固有のガイドラインとスキルを反映させてください。

AI 連携機能を確認・管理する

coldbox ai --help         # Discover the available AI commands
coldbox ai info           # Show installed guidelines, skills, agents, and MCP servers
coldbox ai skills list    # List the available skills
coldbox ai agents --help  # Add, update, or remove AI agent configuration files

サーバーを起動する

server start

これは BoxLang CLI のサーバーコマンドです。初回実行時に、server.json に記載された BoxLang モジュール(bx-esapi、bx-password-encrypt、bx-mail、bx-orm、DB_DRIVER で選択された JDBC ドライバー、bx-image)がインストールされます。

サーバーを一度起動した後にドライバーを切り替える

onServerInitialInstall はサーバーの初回起動時にのみ発火するため、後から DB_DRIVER を変更しても自動的には新しいドライバーが再インストールされません。再度起動する前に server forget(サーバーのインストール状態をクリアします)を実行し、新しいドライバーがインストールされるようにしてください。