Skip to content

Add ksh support for OpenBSD (and mksh/pdksh) #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add ksh support for OpenBSD (and mksh/pdksh) #87

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
210d3b3
Initial plan
Copilot Mar 15, 2026
777b7c4
Add ksh support: detect ksh shells and use POSIX-compatible read comm…
Copilot Mar 15, 2026
4cbcd04
Potential fix for pull request finding
swissspidy Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 48 additions & 10 deletions src/WP_CLI/Shell/REPL.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ private static function create_prompt_cmd( $prompt, $history_path ) {
} elseif ( is_file( '/bin/bash' ) && is_readable( '/bin/bash' ) ) {
// Prefer /bin/bash when available since we use bash-specific commands.
$shell_binary = '/bin/bash';
} elseif ( getenv( 'SHELL' ) && self::is_bash_shell( (string) getenv( 'SHELL' ) ) ) {
// Only use SHELL as fallback if it's bash (we use bash-specific commands).
} elseif ( getenv( 'SHELL' ) && self::is_supported_shell( (string) getenv( 'SHELL' ) ) ) {
// Use SHELL as fallback if it's a supported shell (bash or ksh).
$shell_binary = (string) getenv( 'SHELL' );
} else {
// Final fallback for systems without /bin/bash.
Expand All @@ -137,16 +137,27 @@ private static function create_prompt_cmd( $prompt, $history_path ) {
WP_CLI::error( "The shell binary '{$shell_binary}' is not valid. You can override the shell to be used through the WP_CLI_CUSTOM_SHELL environment variable." );
}

$is_ksh = self::is_ksh_shell( $shell_binary );
$shell_binary = escapeshellarg( $shell_binary );

$cmd = 'set -f; '
. "history -r {$history_path}; "
. 'LINE=""; '
. "read -re -p {$prompt} LINE; "
. '[ $? -eq 0 ] || exit; '
. 'history -s -- "$LINE"; '
. "history -w {$history_path}; "
. 'echo $LINE; ';
if ( $is_ksh ) {
// ksh does not support bash-specific history commands or `read -e`/`read -p`.
// Use POSIX-compatible read and print the prompt via printf to stderr.
$cmd = 'set -f; '
. 'LINE=""; '
. "printf %s {$prompt} >&2; "
. 'IFS= read -r LINE || exit; '
. 'printf \'%s\n\' "$LINE"; ';
} else {
$cmd = 'set -f; '
. "history -r {$history_path}; "
. 'LINE=""; '
. "read -re -p {$prompt} LINE; "
. '[ $? -eq 0 ] || exit; '
. 'history -s -- "$LINE"; '
. "history -w {$history_path}; "
. 'printf \'%s\n\' "$LINE"; ';
}

return "{$shell_binary} -c " . escapeshellarg( $cmd );
}
Expand All @@ -166,6 +177,33 @@ private static function is_bash_shell( $shell_path ) {
return 'bash' === $basename || 0 === strpos( $basename, 'bash-' );
}

/**
* Check if a shell binary is ksh or a ksh-compatible shell (mksh, pdksh, ksh93, etc.).
*
* @param string $shell_path Path to the shell binary.
* @return bool True if the shell is ksh-compatible, false otherwise.
*/
private static function is_ksh_shell( $shell_path ) {
if ( ! is_file( $shell_path ) || ! is_readable( $shell_path ) ) {
return false;
}
$basename = basename( $shell_path );
// Matches ksh, ksh93, ksh88, mksh, pdksh, etc.
return 0 === strpos( $basename, 'ksh' )
|| 'mksh' === $basename
|| 'pdksh' === $basename;
}

/**
* Check if a shell binary is supported (bash or ksh-compatible).
*
* @param string $shell_path Path to the shell binary.
* @return bool True if the shell is supported, false otherwise.
*/
private static function is_supported_shell( $shell_path ) {
return self::is_bash_shell( $shell_path ) || self::is_ksh_shell( $shell_path );
}

private function set_history_file() {
$data = getcwd() . get_current_user();

Expand Down
Loading