devbase の初回セットアップから日常的な開発ワークフローまでを解説します。
devbase を利用するには、以下のソフトウェアがホストマシンにインストールされている必要があります。
| ソフトウェア | 最低バージョン | 確認コマンド |
|---|---|---|
| Docker Engine | 20.10 以上 | docker --version |
| Docker Compose | v2.x 以上 | docker compose version |
| Bash | 4.0 以上 | bash --version |
| Zsh（代替） | 5.0 以上 | zsh --version |
| Python | 3.10 以上 | python3 --version |
| Git | 最新推奨 | git --version |
Note: Docker Desktop を使用している場合、Docker Engine と Docker Compose の両方が含まれています。Linux では Docker Engine を直接インストールし、Docker Compose プラグインを追加してください。
git clone https://github.com/devbasex/devbase.git
cd devbase./bin/devbase initinit コマンドは以下を自動実行します。
bin/devbaseを PATH に追加（~/.bashrc/~/.zshrcに追記）- シェル補完スクリプトの登録（Tab 補完が有効になる）
- プラグイン設定ファイル
plugins.ymlの作成
# Bash の場合
source ~/.bashrc
# Zsh の場合
source ~/.zshrcNote: 新しいターミナルを開いても同様に反映されます。
devbase init を実行すると、サンプルレジストリ devbasex/devbase-samples が自動登録されます。追加のレジストリは以下のように登録します。
devbase plugin repo add user/repoGitHub のショートハンド（user/repo）形式で指定できます。完全な URL も使用可能です。
# 登録済みリポジトリの確認
devbase plugin repo list詳細・追加方法は プラグインレジストリ を参照してください。
# 利用可能なプラグインの確認
devbase plugin list --available
# プラグインのインストール
devbase plugin install <name>インストールされたプラグインは projects/ ディレクトリ配下にプロジェクトとして展開されます。
cd projects/<project>devbase env init対話式のウィザードが起動し、以下を順に設定します。
- グローバル環境変数（AWS 認証、GCP 認証、Git 認証など）
- プロジェクト固有の環境変数
詳細は 環境変数ガイド を参照してください。
devbase build初回はベースイメージのビルドに時間がかかります（ネットワーク速度に依存）。2回目以降はキャッシュが利用されるため高速です。
devbase up起動時に自動スナップショットが作成されます（詳細は スナップショットガイド を参照）。
devbase loginデフォルトでは 1 番目のコンテナにログインします。複数コンテナ環境では番号を指定できます。
devbase login 2セットアップ完了後の日常的な開発フローは以下のとおりです。
graph TD
A[devbase up] --> B[devbase login]
B --> C[コンテナ内で作業]
C --> D{作業終了?}
D -->|いいえ| C
D -->|はい| E[exit でコンテナから退出]
E --> F[devbase down]
F --> G[自動ローテーション実行]
# プロジェクトディレクトリに移動
cd devbase/projects/<project>
# コンテナ起動（自動スナップショット作成）
devbase up
# コンテナにログイン
devbase login# コンテナの状態確認（別ターミナルから）
devbase ps
# ログの確認
devbase container logs -f
# 2番目のコンテナにログイン（並行作業）
devbase login 2# コンテナから退出
exit
# コンテナ停止・削除（自動ローテーション実行）
devbase downstatus コマンドで環境の全体像を確認できます。
devbase status表示される情報:
- コンテナの状態（起動中 / 停止中）
- インストール済みプラグイン
- 環境変数の設定状況
- スナップショットの状態
devbase をセットアップすると、以下のようなディレクトリ構成になります。
devbase/
├── bin/
│ └── devbase # メインエントリポイント
├── projects/
│ └── <project>/ # プラグインから作成されるプロジェクト
│ ├── plugin.yml # プラグイン定義
│ ├── compose.yml # Docker Compose 設定
│ ├── env # プロジェクト設定（Git 管理）
│ └── .env # プロジェクト機密情報（gitignore）
├── backups/ # スナップショット保存先（全プロジェクト共通）
├── .env # グローバル環境変数（gitignore）
└── plugins.yml # プラグイン設定
- CLI リファレンス -- 全コマンドの詳細な使い方
- 環境変数ガイド -- 環境変数の3レベル構造とコレクター
- コンテナ操作ガイド -- 並行開発やボリュームの詳細
- スナップショットガイド -- バックアップと復元の仕組み
- トラブルシューティング -- 問題が発生したとき