devbase は Docker ベースの開発環境管理ツールです。プラグインシステムによる柔軟な拡張、環境変数の安全な管理、増分スナップショットによるデータ保護を提供します。
graph TD
A[devbase] --> B[コンテナ管理]
A --> C[環境変数管理]
A --> D[プラグインシステム]
A --> E[スナップショット]
B --> B1[ライフサイクル管理<br/>up / down / login]
B --> B2[並行開発<br/>scale / 複数コンテナ]
B --> B3[イメージ階層<br/>base / general / php 等]
C --> C1[3レベル構造<br/>グローバル / プロジェクト設定 / プロジェクト機密]
C --> C2[自動コレクター<br/>AWS / GCP / Git / API キー]
C --> C3[ソースファイル同期<br/>ハッシュベース変更検出]
D --> D1[リポジトリ管理<br/>GitHub ショートハンド対応]
D --> D2[インストール / 更新 / 削除]
E --> E1[増分バックアップ<br/>GNU tar + zstd]
E --> E2[世代管理<br/>自動ローテーション]
E --> E3[安全な復元<br/>自動バックアップ付き]
| 機能 | 説明 |
|---|---|
| コンテナ管理 | Docker Compose ベースのコンテナライフサイクル管理。複数コンテナの並行開発をサポート |
| 環境変数管理 | グローバル / プロジェクト設定 / プロジェクト機密の 3 レベル構造。AWS / GCP 等の認証情報を自動収集 |
| プラグインシステム | GitHub リポジトリからのプラグインインストール。プロジェクトテンプレートの共有・再利用 |
| スナップショット | GNU tar の増分バックアップによるデータ保護。世代管理と自動ローテーション |
日常的な開発作業で devbase を利用するための情報です。
| ドキュメント | 内容 |
|---|---|
| はじめに | 前提条件、初回セットアップ、日常ワークフロー |
| CLI リファレンス | 全コマンドの構文・オプション・使用例 |
| プラグインレジストリ | 公開・社内レジストリの一覧と追加方法 |
| 環境変数ガイド | 3レベル構造、コレクター、ソース同期 |
| コンテナ操作ガイド | ライフサイクル、並行開発、ボリューム構造 |
| スナップショットガイド | 増分バックアップ、世代管理、復元手順 |
| トラブルシューティング | カテゴリ別の問題と解決策 |
推奨の読み順:
graph LR
A[はじめに] --> B[CLI リファレンス]
B --> C[環境変数ガイド]
B --> D[コンテナ操作ガイド]
B --> E[スナップショットガイド]
C --> F[トラブルシューティング]
D --> F
E --> F
独自のプラグインを開発・公開するための情報です。利用者向けドキュメントを一通り読んでから参照してください。
| ドキュメント | 内容 |
|---|---|
| プラグイン開発クイックスタート | 最小構成プラグインの作成手順 |
| plugin.yml リファレンス | プラグイン定義ファイルの全フィールド |
| compose.yml ガイドライン | Docker Compose 設定のベストプラクティス |
devbase 本体のコードベースに貢献するための情報です。
| ドキュメント | 内容 |
|---|---|
| アーキテクチャ | ディレクトリ構造、モジュール設計、データフロー |
| コントリビューション | 開発環境構築、コーディング規約、PR ルール |
| 拡張ガイド | 新コマンド・コレクター・イメージの追加方法 |
docs/
├── README.md ← このファイル（ドキュメント索引）
├── user/ ← 利用者向け
│ ├── getting-started.md ← はじめに
│ ├── cli-reference.md ← CLI リファレンス
│ ├── plugin-registries.md ← プラグインレジストリ
│ ├── environment-variables.md ← 環境変数ガイド
│ ├── container-operations.md ← コンテナ操作ガイド
│ ├── snapshot-guide.md ← スナップショットガイド
│ └── troubleshooting.md ← トラブルシューティング
├── plugin-dev/ ← プラグイン開発者向け
│ ├── quickstart.md ← クイックスタート
│ ├── plugin-yml-reference.md ← plugin.yml リファレンス
│ └── compose-yml-guidelines.md ← compose.yml ガイドライン
└── developer/ ← devbase 開発者向け
├── architecture.md ← アーキテクチャ
├── contributing.md ← コントリビューション
└── extending.md ← 拡張ガイド
| やりたいこと | 参照先 |
|---|---|
| devbase を初めてインストールする | はじめに |
| コマンドの使い方を調べる | CLI リファレンス |
| 環境変数を設定する | 環境変数ガイド |
| 複数コンテナで並行開発する | コンテナ操作ガイド |
| データをバックアップ・復元する | スナップショットガイド |
| エラーが発生した | トラブルシューティング |
| プラグインを作りたい | プラグイン開発クイックスタート |
| devbase 本体に貢献したい | コントリビューション |
| リソース | URL |
|---|---|
| GitHub リポジトリ | devbasex/devbase |
| Issue トラッカー | GitHub Issues |
本ドキュメント群では以下の表記規則を使用します。
| 表記 | 意味 |
|---|---|
固定幅フォント |
コマンド、ファイル名、環境変数名 |
<山括弧> |
必須パラメータ（実際の値に置き換える） |
[角括弧] |
省略可能なパラメータ |
A | B |
A または B のいずれか |
Note: 補足情報や参考情報を示します。
Warning: 注意が必要な操作や、データ損失の可能性がある操作を示します。
devbase を初めて使う場合の最短手順です。詳細は はじめに を参照してください。
# 1. クローンと初期化
git clone https://github.com/devbasex/devbase.git && cd devbase
./bin/devbase init
source ~/.bashrc
# 2. プラグインのインストール
devbase plugin repo add user/repo
devbase plugin install <name>
# 3. プロジェクトのセットアップ
cd projects/<project>
devbase env init
devbase build
# 4. 開発開始
devbase up
devbase login| ソフトウェア | 最低バージョン |
|---|---|
| Docker Engine | 20.10 以上 |
| Docker Compose | v2.x 以上 |
| Bash / Zsh | 4.0 以上 / 5.0 以上 |
| Python | 3.10 以上 |
| Git | 最新推奨 |