Skip to content

Latest commit

 

History

History
96 lines (79 loc) · 5.19 KB

File metadata and controls

96 lines (79 loc) · 5.19 KB

CLI リファレンス

devbase の全コマンドの構文、オプション、使用例をまとめたリファレンスです。コマンドグループごとにファイルを分けています。

ファイル 内容
トップレベルコマンド init / status / bin/rc
project グループ コンテナのライフサイクル管理・一覧(up / down / login / ps / logs / scale / build / rebuild / open / profile / list)と非推奨の container グループ
env グループ 環境変数の管理(init / sync / list / set / get / delete / edit / project / keygen / encrypt / decrypt / exec / token / rekey / doctor / export / import)
plugin グループ プラグインの管理(list / install / uninstall / update / info / sync / migrate / repo *)
snapshot グループ スナップショットの管理(create / list / restore / copy / delete / rotate)

コマンド体系

devbase のコマンドは 4 つのグループとトップレベルコマンドで構成されています。

graph TD
    A[devbase] --> B[init]
    A --> C[status]
    A --> D[project]
    A --> E[env]
    A --> F[plugin / pl]
    A --> G[snapshot / ss]
    D --> D1["up / down / ps / logs / scale / open [name]"]
    D --> D3["login [index]"]
    D --> D4["build [image] / rebuild [name]"]
    D --> D5["profile up / down / list [name]"]
    D --> D2["list [--no-interactive]"]
    E --> E1[init / sync / list / set / get / delete / edit / project]
    E --> E2[keygen / encrypt / decrypt / exec / token / rekey / doctor]
    E --> E3[export / import]
    F --> F1[list / install / uninstall / update / info / sync / migrate]
    F --> F2[repo add / repo remove / repo list / repo refresh]
    G --> G1[create / list / restore / copy / delete / rotate]
Loading

container グループは非推奨になりました。 旧 devbase container <sub> は devbase project <sub> のエイリアスとして当面動作しますが、実行時に非推奨警告を 表示します(移行期間後のリリースで削除予定)。新しいコマンドは project を使用してください。

グループエイリアス

各グループには短縮形が用意されています。

グループ名 エイリアス 備考
plugin pl
snapshot ss
container ct 非推奨(project へ移行してください)

ショートカットコマンド

頻繁に使用するプロジェクト操作はトップレベルから直接実行できます。これらは project グループに自動転送されます。

ショートカット 転送先
devbase up [name] devbase project up [name]
devbase down [name] devbase project down [name]
devbase login [index] devbase project login [index]
devbase build [image] bin/devbase の cmd_build(シェル実装)※
devbase ps [name] devbase project ps [name]
devbase scale [name] <num> devbase project scale [name] <num>
devbase rebuild [name] devbase project rebuild [name]
devbase open [name] devbase project open [name]
devbase list devbase project list

Note: logs はトップレベルシノニムを持ちません。devbase project logs を使用してください。

profile について: devbase project profile up|down|list もトップレベルシノニムを持ちません。 [name] は受け付けますが、3 番目の引数に up / down / list が来るためラッパーでは位置で 解決できず、名前の解決は Python 側が行います。詳細は project グループの「プロジェクト名指定」を参照してください。

※ build の転送先について: devbase build(既定 / --no-cache / --project-no-cache)は他の ショートカットのように project グループ(Python 実装)へ転送されるのではなく、bin/devbase の シェル実装 cmd_build に直接委譲されます。base イメージの段階ビルド等を CWD で行う必要があるため です(プロジェクト名の指定 devbase build <project> はラッパーの cd で解決)。 devbase build <image>($DEVBASE_ROOT/containers/<image> の単体ビルド)と devbase build --expires[=DAYS](作成日の判定が必要)は Python 経路(project build)へ委譲されます。 containers/ と projects/ の両方にある名前はイメージとして扱います。devbase build --help は ビルドせずに使い方を出します。

ユニークプレフィックスマッチング

コマンド名が一意に特定できる場合、先頭の数文字だけで実行できます。

# 以下は全て同じコマンド
devbase plugin list
devbase pl list
devbase p l
devbase pl l

Note: 一意に特定できない場合は候補が表示されます。