v0.21

cli

はじめに

dframeworkにはdstrnバイナリ経由でアクセス可能なコマンドラインインターフェースが含まれています。新しいプロジェクトのスキャフォールディング、データベースの管理、アプリケーションファイルの生成、アーキテクチャの分析、および対話型シェルの実行を行うコマンドを提供します。

dstrn init、dstrn help(または--help)、dstrn version(または-v、--version)を除くすべてのコマンドは制限されておりconfig/app.jsを含む有効なdframeworkプロジェクトディレクトリ内での実行が必要です。

1dstrn help
2dstrn help serve
3dstrn migrate --help
4dstrn --version

dstrn help <command>にコマンド名を渡すか任意のコマンドに--help / -hを付加するとその特定のコマンドに関する使用法、引数、オプションが表示されます。

利用可能なコマンド

スキャフォールディング

コマンド 説明
dstrn init <dir> 最小限のプロジェクトをスキャフォールディング
dstrn serve 現在のディレクトリでサーバーを実行
dstrn tinker [code] 対話型replシェルを開く、またはコードを直接実行
dstrn key:generate ランダムな暗号化キーを生成

データベース

コマンド 説明
dstrn migrate 保留中のすべてのマイグレーションを実行
dstrn migrate:status マイグレーションの状態を表示
dstrn migrate:rollback 最後のマイグレーションバッチをロールバック
dstrn migrate:make <name> 新しいマイグレーションテンプレートを作成(命名パターンからテーブル名を推論)
dstrn seed [name] データベースシーダーを実行
dstrn seed:make <Name> 新しいシーダーテンプレートを作成
dstrn drop [--force] 本番環境以外で確認(または--force)付きでデータベース内のすべてのテーブルを削除(本番環境では常に無効)
dstrn advisor [--apply] インデックスのないリレーションを検査しマイグレーションを生成

ジェネレーター

コマンド 説明
dstrn make:model <Name> 新しいモデルを作成
dstrn make:controller <Name> 新しいコントローラーを作成
dstrn make:middleware <Name> 新しいミドルウェアを作成
dstrn make:command <Name> 新しいコンソールコマンドを作成
dstrn make:job <Name> 新しいバックグラウンドジョブを作成
dstrn make:component <Name> public/js/componentsに新しいクライアントwebコンポーネント(dComponent)を作成

システム

コマンド 説明
dstrn run <CommandName> console/commandsからユーザーコマンドを実行
dstrn dispatch <JobName> [--payload=] オプションのjsonペイロードを使用して現在のプロセスでジョブを直接実行
dstrn logs:clear 日付フィルタリング付きでログファイルをクリアまたはアーカイブ
dstrn deploy 本番デプロイおよびサービス設定を生成
dstrn cert ssl証明書を検査および管理
dstrn cert:obtain let's encryptのssl証明書を取得
dstrn cert:renew 期限切れの近いssl証明書を更新
dstrn cert:status 証明書の有効性と有効期限の詳細を表示
dstrn docs:publish プロジェクトにフレームワークドキュメントを公開

ネイティブ

コマンド 説明
dstrn simulate --<platform> プラットフォームシミュレーターで実行
dstrn build --<platform> 本番バイナリをビルド
dstrn make:plugin <Name> クロスプラットフォームのネイティブプラグインをスキャフォールディング
dstrn native:status ネイティブ設定と準備状態を表示
dstrn native:doctor 完全な環境診断を実行
dstrn native:clean [--<platform>] ネイティブビルドアーティファクトをクリーンアップ

アーキテクチャ

コマンド 説明
dstrn graph アプリケーションの依存関係グラフを表示
dstrn lint アーキテクチャ違反を検出
dstrn dead 到達不能なデッドコードを検出
dstrn doctor プロジェクトの品質スコアを算出
dstrn lang:lint 翻訳パリティとビューキーをチェック

プロジェクトの作成

initコマンドは標準のディレクトリ構造、デフォルト設定ファイル、サンプルのルート、および基本的なビューを含む新しいプロジェクトをスキャフォールディングします。

1dstrn init my-app

サーバーの実行

serveコマンドは現在のディレクトリでアプリケーションサーバーを起動します。

1dstrn serve

これによりアプリケーション設定がロードされすべてのルートファイルがインポートされソケットサーバーが起動しスケジューラーが開始されhttpリクエストの待受が開始されます。起動バナーにはアプリケーションのurlとポートが表示されます。

--hostおよび--portを使用してカスタムホストまたはポートを指定できます:

1dstrn serve --host=0.0.0.0 --port=3000

値を指定せずに単独フラグとして--hostを指定するとサーバーを0.0.0.0にバインドしてローカルネットワークに公開します:

1dstrn serve --host

tinker

tinkerコマンドは対話型replシェルを提供するかすべてのモデルと完全なアプリケーションコンテキストを事前ロードした状態でインラインコードを直接実行します。

対話型シェル

引数なしでコマンドを実行して対話型セッションを開始します:

1dstrn tinker
1dframework> const users = await User.all();
2dframework> users.length
342
4dframework> await User.where('role', 'admin').get();

シェルはコマンド履歴をプロジェクトルートの.dframework_historyに永続化します。すべてのフレームワークファサード(DB、Config、Session、Auth、Logなど)およびモデルがコンテキスト内で利用可能です。

インラインコード実行

位置引数としてコードを直接渡すか--execute(-e)フラグを使用して対話型セッションを開始せずにコードを評価しフォーマットされた結果を即座に出力します:

1dstrn tinker "await User.count()"
2dstrn tinker "await DB.table('users').where('status', 'active').get()"
3dstrn tinker --execute="await User.find(1)"
4dstrn tinker -e "const u = await User.first(); return u.email;"

インライン実行はトップレベルのawait式と複数文ブロックをサポートします。models/内のすべてのモデルは実行開始前にグローバルスコープにロードされます。

データベースアドバイザー

advisorコマンドはデータベーススキーマ、カラム定義、アクティブなクエリ履歴を検査し外部キー、中間テーブル、頻繁にフィルタリングされるカラムの組み合わせにおける欠落インデックスを検出します。

1dstrn advisor
1 database index advisor found 2 recommendation(s):
2
3 table: tracks
4 index: idx_tracks_album_id (album_id)
5 reason: unindexed foreign key column
6
7 table: track_artists
8 index: idx_track_artists_track_id_artist_id (track_id, artist_id)
9 reason: frequently filtered column pair (track_id, artist_id) lacks composite index
10
11run "dstrn advisor --apply" to generate and execute migrations automatically

推奨されるすべてのインデックスを含むタイムスタンプ付きマイグレーションを自動的にスキャフォールディングして実行するには--applyフラグを渡します:

1dstrn advisor --apply
1 generating and running migrations
2 created migration: database/migrations/2026_10_28_120000_add_idx_tracks_album_id.js
3 created migration: database/migrations/2026_10_28_120001_add_idx_track_artists_track_id_artist_id.js
4 all migrations applied successfully

生成された各マイグレーションファイルはtable.index()およびtable.dropIndex()呼び出しを含むupおよびdown関数をエクスポートしdstrn migrate:rollbackによる完全なロールバックサポートを可能にします。

スケジュールタスクと手動実行

console/commandsに配置されるスケジューラーコマンドを作成できます。これらのタスクは設定されたスケジュールで自動的に実行されるほかdstrn runを使用してオンデマンドで手動実行することもできます。

コマンドの作成

make:commandジェネレーターを使用して新しいコマンドファイルをスキャフォールディングします:

1dstrn make:command PruneExpiredSessions

これによりconsole/commands/PruneExpiredSessionsCommand.jsが作成されます(ジェネレーターは省略時に自動的にCommandサフィックスを付加します)。生成されたファイルは実行ロジックを記述するasync handle(args, options)メソッドを持つデフォルトクラスをエクスポートします。タスクはすべてのフレームワークグローバル(DB、Log、Config、モデル)に直接アクセスできます:

1export default class PruneExpiredSessionsCommand {
2 async handle(args, options) {
3 const isDryRun = this.hasOption('dry-run');
4 const batchSize = parseInt(this.option('batch', 500), 10);
5 const targetTable = this.argument(0, 'sessions');
6
7 if (isDryRun) {
8 Log.info(`previewing session cleanup for ${targetTable} in batches of ${batchSize}`);
9 return;
10 }
11
12 const cutoff = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
13 await DB.table(targetTable).where('updated_at', '<', cutoff).delete();
14 Log.info('expired sessions pruned');
15 }
16}

コマンドの実行

runコマンドを使用してターミナルからオンデマンドで任意のコマンドを実行できます:

1dstrn run PruneExpiredSessions

シェルのタブ補完を容易にするため.jsで終わるファイル名も受け付けられます:

1dstrn run PruneExpiredSessions.js

手動実行時にパラメータを渡すにはタスク名の後に指定します。オプションとフラグは位置引数とともに--key valueまたは--key=value形式で渡すことができます:

1dstrn run PruneExpiredSessions sessions --batch=1000 --dry-run
2# or
3dstrn run PruneExpiredSessions sessions --batch 1000 --dry-run

dframeworkはcli引数を自動的にパースしコマンドインスタンスにヘルパーメソッドを注入します:

メソッド / プロパティ 説明
this.option('name', fallback) --name valueまたは--name=valueからオプション値を取得
this.hasOption('name') --dry-runなどのフラグが渡された場合にboolean trueを返す
this.argument(index, fallback) 0から始まるインデックスで位置引数を取得
this.options パースされたすべてのオプションとフラグを含む辞書
this.arguments すべての位置引数を含む配列
options(第2パラメータ) handle(args, options)に直接渡されるパース済みオプションオブジェクト

dframeworkはconsole/commands/PruneExpiredSessionsCommand.js(またはPruneExpiredSessions.js)からクラスをインポートしてインスタンス化しhandle(args, options)を呼び出し完了時に経過実行時間を報告します。

console/commands内のタスクはスケジューラーによっても使用されます。console/Schedule.jsでスケジュール設定された場合スケジューラーはhandle([], {})を呼び出しthis.option()は設定されたフォールバック値を安全に返します。

ジョブのディスパッチ

dstrn dispatchを使用してコマンドラインからオンデマンドでジョブを直接実行できます(キューイングを行わず現在のプロセスで同期的に実行されます):

1dstrn dispatch CleanupExpiredSessionsJob

シェルのタブ補完を容易にするため.jsで終わるファイル名も受け付けられます:

1dstrn dispatch CleanupExpiredSessionsJob.js

--payloadフラグを使用してjsonペイロードを渡すことができます:

1dstrn dispatch SendWelcomeEmailJob.js --payload '{"userId": 1}'

ログ管理

logs:clearコマンドは日付範囲フィルタリング、環境ターゲティング、アーカイブ、プレビューモードを備えた柔軟なログファイル管理を提供します:

1dstrn logs:clear
2dstrn logs:clear --env=prod
3dstrn logs:clear --before=2026-01-01
4dstrn logs:clear --after=2026-05-01 --archive
5dstrn logs:clear --preview
フラグ 説明
--env=prodまたは--env=dev 特定の環境ログディレクトリを対象にする
--before=YYYY-MM-DD 指定日より前のログをクリア
--after=YYYY-MM-DD 指定日より後のログをクリア
--archive 一致した各ログをarchivesサブディレクトリ内に.gz形式で個別圧縮し元のファイルを削除
--preview 実際の処理を行わずに影響を受けるファイルを表示

デプロイと証明書

アプリケーションのデプロイ

deployコマンドはネイティブtlsを使用したベアメタルデプロイ(デフォルト)、caddyを使用したリバースプロキシ(--proxy)、またはcloudflareを使用したエッジルーティング(--edge)のための本番設定を生成します。

1dstrn deploy --domain=api.example.com --email=admin@example.com
2dstrn deploy --proxy --domain=api.example.com
3dstrn deploy --edge --domain=api.example.com
4dstrn deploy --domain=api.example.com --email=admin@example.com --dry-run
5sudo dstrn deploy --domain=api.example.com --email=admin@example.com --install
フラグ 説明
--domain=<domains> カンマ区切りの対象ドメイン
--email=<email> let's encrypt証明書のacme登録メールアドレス
--proxy 直接tlsの代わりにcaddyリバースプロキシ設定を生成
--edge cloudflareガイダンス付きの平文http設定を生成
--port=<port> カスタムアプリケーションポート(デフォルトは8250、直接tlsの場合は443)
--user=<user> systemdサービスのシステムユーザー(デフォルトは現在のユーザー)
--dir=<dir> 作業ディレクトリのパス
--dry-run ディスクに書き込まずに生成される設定をコンソールでプレビュー
--install 設定ファイルをシステムパスに直接書き込む(root権限が必要)

証明書の管理

certコマンドファミリーは証明書の発行、更新、状態監視を処理します。

1dstrn cert:obtain --domain=api.example.com --email=admin@example.com
2dstrn cert:obtain --domain=api.example.com --email=admin@example.com --staging
3dstrn cert:renew --domain=api.example.com --email=admin@example.com
4dstrn cert:status
コマンド 説明
dstrn cert インストールされているssl証明書を検査および管理
dstrn cert:obtain --domain=example.com --email=admin@example.com 新しいlet's encryptのssl証明書を取得
dstrn cert:renew --domain=example.com --email=admin@example.com 30日以内に期限切れになる証明書を更新
dstrn cert:status インストールされている証明書の有効性と有効期限を表示

アーキテクチャアナライザー

dframeworkにはアプリケーションの完全な依存関係グラフを構築する静的解析エンジンが含まれています。これはgraph、lint、dead、doctor、lang:lintコマンドを駆動します。

依存関係グラフ

graphコマンドはアプリケーションがどのように接続されているかを視覚的に表現します。すべてのhttpルートとソケットワイヤ、ディスパッチ先となるコントローラー、通過するミドルウェア、およびそれらのコントローラーが依存するモデルを表示します。

1dstrn graph
1http routes
2get /users (users.index)
3 └─ AuthMiddleware
4 └─ UserController (User)
5 └─ index()
6
7post /users (users.store)
8 └─ AuthMiddleware
9 └─ UserController (User)
10 └─ store()
11
12socket routes
13chat:message
14 └─ AuthMiddleware
15 └─ ChatController (Message)
16 └─ onMessage()

機械可読な出力を行うには--jsonフラグを渡します:

1dstrn graph --json

これにより外部の可視化ツールに適したnodes配列とedges配列を含む完全なグラフがjsonオブジェクトとして出力されます。

アーキテクチャlint

lintコマンドはアプリケーション内の構造的な違反を検出します。

IMPORTANT

`dstrn lint`は厳密なアーキテクチャ境界を適用します: コントローラーは他のコントローラーに依存してはならず、モデルはコントローラーに依存してはならず、ミドルウェアはコントローラーに依存してはならず、ルートはモデルに直接依存してはならず、ジョブは直接インポートすべきではありません(代わりにJob.dispatch経由でディスパッチします)。

1dstrn lint

違反が見つかった場合それぞれが説明とともに出力されます。

1 ERROR controller UserController depends on controller AdminController
2 controllers may not depend on controllers

デッドコード検出

deadコマンドは登録されたすべてのルート、ソケットワイヤ、スケジュールされたタスク(console/Schedule.js)から到達可能性分析を実行します。依存関係グラフを走査し参照されていないコントローラー、モデル、ジョブ、ミドルウェアを報告します。

1dstrn dead
1 ERROR found 2 unreachable components
2
3unused controller
4 LegacyController
5
6unused model
7 TempModel

データベーステーブルは生クエリを通じてアクセスされる可能性があるため分析から除外されます。

プロジェクトdoctor

doctorコマンドは3つの要素に基づいて0から100までの品質スコアを計算します:

1dstrn doctor
1 OK health score 95 out of 100
2
3deductions
4 dead code minus 5 (1 unreachable components)

90点以上は成功、70点から89点は情報、70点未満はエラーとして表示されます。

翻訳lint

lang:lintコマンドは設定されているすべての言語にわたって翻訳キーを検証しビューやコード全体の参照を検証します。2つのカテゴリの問題をチェックします:

1dstrn lang:lint

問題が見つかった場合コマンドは正確なファイル、行番号、欠落しているロケールを報告します:

1 ERROR found 2 translation issues
2
3missing translations in views and code
4 views/index.d:4
5 key 'ui.tagline' is missing in [ja]
6
7asymmetric translation keys across locales
8 locale: ja
9 missing 'ui.tagline' (defined in: en)

すべての翻訳が完全でビューの使用状況と一致している場合は成功ステータスが返されます。

辞書内に未使用の翻訳キーが存在する場合に非ゼロの終了コードで失敗させるには--strictを渡します:

1dstrn lang:lint --strict

コンパイラ

dframeworkにはフロントエンドランタイムアセットをバンドルおよび最小化するビルド時コンパイラが含まれています。

javascriptコンパイル

jsコンパイラはフレームワークのコアクライアントサイドファイル(メインランタイム、ネイティブブリッジ、カスタムエレメント、ユーティリティ関数)とpublic/js/componentsにあるユーザー定義コンポーネントファイルを連結します。結合された出力は3回の圧縮パス、関数名のマングリング、トップレベルのマングリングにより最小化されます。結果はstorage/framework/public/js/dstrn.jsに書き込まれます。

デバッグモードが有効なlocal環境では__DF_DEBUG__グローバルがtrueに設定されクライアントランタイムでデバッグ専用コードパスが有効になります。本番環境ではこれらのパスはデッドコード削除中に除去されます。

cssコンパイル

cssコンパイラはフレームワークのベーススタイル、ユーティリティクラス、アイコンフォント、コンポーネントスタイルを連結します。次にprefix\:classnameパターンを使用して6つのブレークポイント(sm、md、lg、xl、xxl、ultra)にわたって各ユーティリティクラスのレスポンシブバリアントを生成します。public/css/componentsのユーザー定義コンポーネントcssファイルも出力に含まれます。

最終的な出力はコメントの除去、空白の圧縮、不要なセミコロンの削除、ゼロ単位サフィックスの削除によって最小化されます。結果はstorage/framework/public/css/dstrn.cssに書き込まれます。