Feature/evo cli bootstrap by yama · Pull Request #392 · modxcms-jp/evolution-jp

yama · 2026-02-07T10:39:26Z

This pull request introduces a minimal CLI framework for Evolution CMS JP Edition, enabling command-line management and development tasks. It establishes a robust foundation for further CLI expansion, including database operations, configuration inspection, cache management, and command generation. The implementation includes a bootstrap process, command routing, helper utilities, and several initial commands, all documented for ease of use.

Core CLI Framework and Bootstrap:

Added the evo entrypoint script, which defines CLI mode, loads the bootstrap, routes commands, and handles unknown commands gracefully (evo, evoR1-R30).
Implemented CLI bootstrap logic to initialize the CMS core, set up environment variables, and prepare for command execution (manager/includes/cli/bootstrap.php, manager/includes/cli/bootstrap.phpR1-R77).
Introduced helper functions for CLI output, error handling, and table name normalization (manager/includes/cli/cli-helpers.php, manager/includes/cli/cli-helpers.phpR1-R44).

Database Management Commands:

Added commands for querying (db-query.php, [1] exporting (db-export.php, [2] importing (db-import.php, [3] listing tables (db-tables.php, [4] describing table structure (db-describe.php, [5] and counting rows with conditions (db-count.php, [6].
Ensured safe import/export with cache exclusion, settings preservation, and explicit confirmation for imports (db-import.php, manager/includes/cli/commands/db-import.phpR1-R125).

Configuration and Cache Commands:

Added commands to show configuration values (config-show.php, [1] and clear cache (cache-clear.php, [2].

Command Generation and Help:

Implemented command generation (make-command) and a help command that lists available commands (help.php, manager/includes/cli/commands/help.phpR1-R20).

Documentation and Integration:

Provided a comprehensive README detailing usage, command arguments, and safety notes (manager/includes/cli/README.md, manager/includes/cli/README.mdR1-R33).
Updated exec plan and skill documentation to reflect CLI capabilities and integration in workflows (.agent/plans/2026-02-07-evo-cli-self-bootstrap.md, [1]; .claude/skills/exec-plan/SKILL.md, [2].

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]

Copilot

Pull request overview

Evolution CMS JP Edition に最小限の CLI エントリポイントとブートストラップを追加し、DB/設定/キャッシュ操作などの初期コマンドを CLI 経由で実行可能にする変更。

ルート evo と manager/includes/cli/bootstrap.php により CLI 実行・初期化・コマンドルーティングを追加
manager/includes/cli/commands/* に DB 操作、設定表示、キャッシュクリア、ヘルプ、コマンド雛形生成を追加
CLI 安定化のためにセッション開始抑止と mb_internal_encoding 呼び出しガードを追加

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
manager/includes/initialize.inc.php	CLI 実行時のセッション開始を抑止
manager/includes/document.parser.class.inc.php	`mb_internal_encoding` を存在チェック付きで呼ぶ
manager/includes/cli/commands/make-command.php	コマンド雛形生成コマンドを追加
manager/includes/cli/commands/help.php	コマンド一覧表示を追加
manager/includes/cli/commands/db-tables.php	テーブル一覧表示を追加
manager/includes/cli/commands/db-query.php	任意 SQL 実行を追加
manager/includes/cli/commands/db-import.php	SQL インポートを追加（確認フラグあり）
manager/includes/cli/commands/db-export.php	SQL エクスポートを追加
manager/includes/cli/commands/db-describe.php	テーブル定義表示を追加
manager/includes/cli/commands/db-count.php	件数カウントを追加
manager/includes/cli/commands/db-console.php	MySQL クライアント起動を追加
manager/includes/cli/commands/config-show.php	設定表示を追加
manager/includes/cli/commands/cache-clear.php	キャッシュクリアを追加
manager/includes/cli/cli-helpers.php	CLI 出力・終了・テーブル名補助を追加
manager/includes/cli/bootstrap.php	CLI 用の CMS 初期化を追加
manager/includes/cli/README.md	CLI の使い方を追加
evo	CLI エントリポイントを追加
.claude/skills/exec-plan/SKILL.md	調査フェーズでの CLI 活用を追記
.agent/plans/2026-02-07-evo-cli-self-bootstrap.md	実行計画ドキュメントを追加

Copilot · 2026-02-07T10:45:29Z

manager/includes/cli/commands/config-show.php

+if (!$args) {
+    $all = config();
+    if (!is_array($all)) {
+        cli_usage('No config available.');
+    }
+    ksort($all);


config() ヘルパーは必須引数 $key を要求する定義なので、引数なし呼び出しは ArgumentCountError で落ちる。全設定を取得したいなら evo()->config(null)（または evo()->config()）を呼ぶか、ヘルパー config() 側のシグネチャを $key = null に変更して引数なしを許容する必要がある。

Copilot · 2026-02-07T10:45:29Z

manager/includes/cli/commands/make-command.php

+$fileName = str_replace(':', '-', $commandName) . '.php';
+$filePath = EVO_CLI_COMMANDS_PATH . $fileName;
+


$commandName をそのままファイル名に変換しているため、"../" や "/" を含む入力で commands/ 配下以外へ書き込みできる。コマンド名を許可パターン（例: 英小文字/数字/コロンのみ等）で検証し、生成後のパスが EVO_CLI_COMMANDS_PATH 配下に収まることを realpath 等で確認してから書き込むようにするべき。

Suggested change

$fileName = str_replace(':', '-', $commandName) . '.php';

$filePath = EVO_CLI_COMMANDS_PATH . $fileName;

// コマンド名は英小文字・数字・コロンのみ許可する

if (!preg_match('/^[a-z0-9:]+$/', $commandName)) {

fwrite(STDERR, "Invalid command name: {$commandName}\n");

exit(1);

}

$fileName = str_replace(':', '-', $commandName) . '.php';

// ベースディレクトリを正規化し、EVO_CLI_COMMANDS_PATH 配下への書き込みに限定する

$baseDir = rtrim(EVO_CLI_COMMANDS_PATH, DIRECTORY_SEPARATOR);

$baseRealPath = realpath($baseDir);

if ($baseRealPath === false) {

fwrite(STDERR, "Invalid commands base path: " . EVO_CLI_COMMANDS_PATH . "\n");

exit(1);

}

$filePath = $baseRealPath . DIRECTORY_SEPARATOR . $fileName;

$targetDirRealPath = realpath(dirname($filePath));

if ($targetDirRealPath === false || strpos($targetDirRealPath, $baseRealPath) !== 0) {

fwrite(STDERR, "Refusing to write outside commands path: {$filePath}\n");

exit(1);

}

Copilot · 2026-02-07T10:45:30Z

evo

+$commandFile = EVO_CLI_COMMANDS_PATH . str_replace(':', '-', $command) . '.php';
+if (is_file($commandFile)) {
+    require $commandFile;
+    exit(0);
+}
+
+fwrite(STDERR, "Unknown command: {$command}\n");
+$helpFile = EVO_CLI_COMMANDS_PATH . 'help.php';


コマンド名を検証せずにファイルパスへ連結しているため、"../" や "/" を含む入力で commands/ 配下以外の PHP を require できる。許可パターンで $command を検証し、解決後パスが EVO_CLI_COMMANDS_PATH 配下に収まる場合のみ読み込むように制限する必要がある。

Suggested change

$commandFile = EVO_CLI_COMMANDS_PATH . str_replace(':', '-', $command) . '.php';

if (is_file($commandFile)) {

require $commandFile;

exit(0);

}

fwrite(STDERR, "Unknown command: {$command}\n");

$helpFile = EVO_CLI_COMMANDS_PATH . 'help.php';

$baseDir = rtrim(EVO_CLI_COMMANDS_PATH, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;

if (preg_match('/^[a-zA-Z0-9:-]+$/', $command)) {

$relativeCommandPath = str_replace(':', '-', $command) . '.php';

$commandFile = $baseDir . $relativeCommandPath;

$realBaseDir = realpath($baseDir);

$realCommandFile = $realBaseDir !== false ? realpath($commandFile) : false;

if (

$realBaseDir !== false &&

$realCommandFile !== false &&

strpos($realCommandFile, $realBaseDir . DIRECTORY_SEPARATOR) === 0 &&

is_file($realCommandFile)

) {

require $realCommandFile;

exit(0);

}

}

fwrite(STDERR, "Unknown command: {$command}\n");

$helpFile = $baseDir . 'help.php';

Copilot · 2026-02-07T10:45:30Z

manager/includes/cli/commands/db-console.php

+$configContent = sprintf(
+    "[client]\nhost=%s\nuser=%s\npassword=%s\ndatabase=%s\n",
+    db()->config['host'],
+    db()->config['user'],
+    db()->config['pass'],
+    db()->config['dbase']
+);
+
+file_put_contents($tmpConfig, $configContent);


DB 設定値をそのままテンポラリ設定ファイルへ埋め込んでいるため、パスワード等に改行が含まれると設定ファイルの構造が壊れる。値の改行除去/エスケープを行い、file_put_contents の戻り値を確認して失敗時は終了するようにした方が安全。

Suggested change

$configContent = sprintf(

"[client]\nhost=%s\nuser=%s\npassword=%s\ndatabase=%s\n",

db()->config['host'],

db()->config['user'],

db()->config['pass'],

db()->config['dbase']

);

file_put_contents($tmpConfig, $configContent);

$host = str_replace(["\r", "\n"], '', (string) db()->config['host']);

$user = str_replace(["\r", "\n"], '', (string) db()->config['user']);

$pass = str_replace(["\r", "\n"], '', (string) db()->config['pass']);

$dbase = str_replace(["\r", "\n"], '', (string) db()->config['dbase']);

$configContent = sprintf(

"[client]\nhost=%s\nuser=%s\npassword=%s\ndatabase=%s\n",

$host,

$user,

$pass,

$dbase

);

$bytesWritten = file_put_contents($tmpConfig, $configContent);

if ($bytesWritten === false) {

fwrite(STDERR, "Failed to write temp config file.\n");

exit(1);

}

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 90b6621b17

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-02-07T10:45:56Z

manager/includes/cli/commands/config-show.php

+<?php
+
+if (!$args) {
+    $all = config();


Avoid calling config() without required key

config:show calls config() with no arguments, but the global helper is declared as function config($key, $default = null) in manager/includes/helpers.php, so this triggers ArgumentCountError on PHP 8+ and the documented php evo config:show path cannot run. Use evo()->config() (which accepts a null key) or pass an explicit key to the helper.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-02-07T10:45:56Z

manager/includes/cli/commands/make-command.php

+$fileName = str_replace(':', '-', $commandName) . '.php';
+$filePath = EVO_CLI_COMMANDS_PATH . $fileName;


Reject path separators in generated command names

make:command builds $filePath directly from user input after only replacing : with -, so names containing ../ or / can escape EVO_CLI_COMMANDS_PATH and overwrite arbitrary files (for example, php evo make:command ../../tmp/pwn). Restrict command names to a safe pattern (e.g. alnum, _, -, :) before writing.

Useful? React with 👍 / 👎.

…ecPlan

… コンテキストの初期化チェックを追加

…に設定。CLI README を更新。

…ュメントを追加

yama added 6 commits February 7, 2026 19:05

core: guard cli init and mbstring

6bfb35e

cli: add evo entrypoint and db commands

8d5a95f

docs: document evo cli

3610eab

docs: expand execplan progress

b804bf0

docs: note cli usage in exec-plan skill

9f27160

cli: add db export/import and improve query

90b6621

Copilot AI review requested due to automatic review settings February 7, 2026 10:39

github-actions bot added the ドキュメント label Feb 7, 2026

Copilot started reviewing on behalf of yama February 7, 2026 10:39 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

chatgpt-codex-connector bot reviewed Feb 7, 2026

View reviewed changes

yama added 16 commits February 11, 2026 13:32

update

1049bd7

update

60f198a

cli: enhance db export functionality and add driver options

c1c2efe

cli: update command priorities and output format guidelines

cc26fae

cli: update exploration focus and add core issues documentation in Ex…

9724379

…ecPlan

doc: add core issues documentation reference in AGENTS.md

334f303

doc: 新しいコア改善課題の記録を追加

6ec013a

cli: 新しいヘルスチェックコマンドを追加

089f039

cli: 新しいログ表示コマンドを追加

9cb298b

cli: データベースエクスポート機能を追加

ecb7077

cli: データベースエクスポートコマンドの引数検証を強化

24b5008

doc: 新しいバックアップおよびログ表示コマンドを追加

2880ab8

cli: health:check, log:show, db:backup コマンドを実装し、CLI README を更新

1c4898f

cli: db:backup コマンドを実装し、バックアップの世代管理を追加。cli_export_database に MODX…

fff288b

… コンテキストの初期化チェックを追加

cli: log:clear コマンドを実装し、イベントログを全削除する機能を追加。誤実行防止のため --yes オプションを必須…

231a9c0

…に設定。CLI README を更新。

docs: PLANS.md の「Surprises & Discoveries」セクションの表現を修正し、リリース手順に関する新しいドキ…

2fac03c

…ュメントを追加

yama merged commit ce71a6f into main Feb 13, 2026
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Feature/evo cli bootstrap#392

Feature/evo cli bootstrap#392
yama merged 22 commits intomainfrom
feature/evo-cli-bootstrap

yama commented Feb 7, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

chatgpt-codex-connector bot Feb 7, 2026

Uh oh!

chatgpt-codex-connector bot Feb 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		$fileName = str_replace(':', '-', $commandName) . '.php';
		$filePath = EVO_CLI_COMMANDS_PATH . $fileName;

-$fileName = str_replace(':', '-', $commandName) . '.php';
-$filePath = EVO_CLI_COMMANDS_PATH . $fileName;
+// コマンド名は英小文字・数字・コロンのみ許可する
+if (!preg_match('/^[a-z0-9:]+$/', $commandName)) {
+    fwrite(STDERR, "Invalid command name: {$commandName}\n");
+    exit(1);
+}
+$fileName = str_replace(':', '-', $commandName) . '.php';
+// ベースディレクトリを正規化し、EVO_CLI_COMMANDS_PATH 配下への書き込みに限定する
+$baseDir = rtrim(EVO_CLI_COMMANDS_PATH, DIRECTORY_SEPARATOR);
+$baseRealPath = realpath($baseDir);
+if ($baseRealPath === false) {
+    fwrite(STDERR, "Invalid commands base path: " . EVO_CLI_COMMANDS_PATH . "\n");
+    exit(1);
+}
+$filePath = $baseRealPath . DIRECTORY_SEPARATOR . $fileName;
+$targetDirRealPath = realpath(dirname($filePath));
+if ($targetDirRealPath === false || strpos($targetDirRealPath, $baseRealPath) !== 0) {
+    fwrite(STDERR, "Refusing to write outside commands path: {$filePath}\n");
+    exit(1);
+}

-$commandFile = EVO_CLI_COMMANDS_PATH . str_replace(':', '-', $command) . '.php';
-if (is_file($commandFile)) {
-    require $commandFile;
-    exit(0);
-}
-fwrite(STDERR, "Unknown command: {$command}\n");
-$helpFile = EVO_CLI_COMMANDS_PATH . 'help.php';
+$baseDir = rtrim(EVO_CLI_COMMANDS_PATH, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+if (preg_match('/^[a-zA-Z0-9:-]+$/', $command)) {
+    $relativeCommandPath = str_replace(':', '-', $command) . '.php';
+    $commandFile = $baseDir . $relativeCommandPath;
+    $realBaseDir = realpath($baseDir);
+    $realCommandFile = $realBaseDir !== false ? realpath($commandFile) : false;
+    if (
+        $realBaseDir !== false &&
+        $realCommandFile !== false &&
+        strpos($realCommandFile, $realBaseDir . DIRECTORY_SEPARATOR) === 0 &&
+        is_file($realCommandFile)
+    ) {
+        require $realCommandFile;
+        exit(0);
+    }
+}
+fwrite(STDERR, "Unknown command: {$command}\n");
+$helpFile = $baseDir . 'help.php';

Comments

Conversation

yama commented Feb 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant