isksh 0.1.0

A portable POSIX-oriented shell written in Rust
Documentation

isksh

CI

iskshはRust製のクロスプラットフォームシェルです。Windows、macOS、Linuxで動作する単体バイナリを提供し、POSIX.1-2024 Shell Command Languageとの互換性を目標にしています。

現在はMVP開発段階です。POSIXおよびBashとの完全互換を保証するものではありません。詳細はPOSIX対応表を参照してください。

対象プラットフォーム

OS アーキテクチャ 検証範囲 配布形式
Linux x86_64 / aarch64 ビルド・実行・テスト musl完全静的ELF
Windows 11 x86_64 ビルド・実機実行 静的GNU CRTを使用するEXE
macOS x86_64 / aarch64 cargo check 将来のmacOS CIでリンク確認予定

WindowsバイナリはWindows標準システムDLLを利用します。macOSではOS標準ライブラリまで含めた完全静的リンクは行いません。

主な機能

  • 単純コマンド、変数代入、終了ステータス、位置・特殊パラメータ
  • 単一引用、二重引用、エスケープ
  • パラメータ展開、コマンド置換、算術展開、フィールド分割、パス名展開
  • リダイレクト、here-document、パイプライン、リスト、&&、||
  • 外部コマンド間の並列OSパイプ、PIPESTATUS、set -o pipefail
  • 非同期バックグラウンドジョブ、$!、jobs、wait
  • if、case、for、while、until、グループ、サブシェル、関数
  • POSIX系built-inと、対話モードに必要なシェル状態管理
  • PS1、PS2、複数行入力、履歴、補完、履歴検索、exit、EOFを扱う対話シェル
  • 対話中の外部コマンドへ端末を直接引き渡すTTY実行
  • Bash形式のプロンプトエスケープ、プロンプト内の変数・コマンド・算術展開、PROMPT_COMMAND
  • .iskrcによる起動設定
  • 添字配列・連想配列、[[ ... ]]、プロセス置換などの主要Bash拡張
  • source、declare、typeset、local、shopt、type、mapfile、readarray
  • builtin、help、let、pushd、popd、dirs、cd -、read -r/-a、printf -v

完全なジョブ制御とUnixシグナル処理は未対応です。grep、sed、awkなどの外部ユーティリティは内包せず、実行環境のPATHから呼び出します。

使用方法

isksh SCRIPT [ARG...]
isksh -c COMMAND [NAME [ARG...]]
isksh -s [ARG...]
isksh -i

例:

isksh -c 'name=world; printf "hello %s\n" "$name"'
isksh script.sh first second
printf 'echo hello\n' | isksh -s
isksh -i

引数なしで標準入力が端末の場合、または-iを指定した場合は対話モードになります。スクリプトと変数はUTF-8として扱い、非UTF-8入力はエラーになります。LFとCRLFの両方を受理します。

起動設定

対話モードでは次の優先順で設定ファイルを選びます。

  1. ISKSH_RCで指定したパス
  2. $XDG_CONFIG_HOME/isksh/.iskrc
  3. $HOME/.config/isksh/.iskrc
  4. Windowsでは$USERPROFILE/.config/isksh/.iskrc

上記の.iskrcが存在しない場合は、dotfilesとの互換性のため$HOME/.bashrcを読み込みます。ISKSH_RCを設定した場合は.bashrcへフォールバックせず、空文字列にすると読み込みを無効化できます。

export EDITOR=vim
PS1='isksh> '
alias ll='ls -la'

paths=(src tests scripts)

greet() {
    local name=${1:-world}
    if [[ $name != '' ]]; then
        printf 'hello %s\n' "$name"
    fi
}

.bashrcで利用される一般的な構文を可能な範囲で受理しますが、Bash固有機能は部分互換です。配列スライス、多次元配列、declareの高度な属性、拡張globなどは未対応です。

プロセス置換<(...)と>(...)は全対象OSで動かすため一時ファイルを使用して直列実行します。BashのFIFOまたは/dev/fdを使う非同期実行とはタイミングが異なります。

Vim・Neovim・Starship

対話モードから起動した単独の外部コマンドは、標準入力・標準出力・標準エラーと端末機能を直接引き継ぎます。そのため、vimとnvimはWindows/Linuxのどちらでも通常の全画面UIで利用できます。

vim README.md
nvim README.md

パイプライン、リダイレクト、コマンド置換内では、シェルが入出力を接続または捕捉します。

Starshipは.iskrcへ次を追加します。この方式はStarshipのプロンプトコマンドを直接使用するため、Windows/Linuxで同じ設定を利用できます。

PS1='$(starship prompt --status=$?)'
PS2='$(starship prompt --continuation)'

PS1とPS2では、Bash形式の\u、\h、\H、\w、\W、\s、\v、\V、\j、\n、\r、\e、\$、\nnn、\[、\]を解釈した後、変数・コマンド・算術展開を行います。PROMPT_COMMANDもプライマリプロンプトの直前に実行します。

Starship公式のBash初期化形式も利用できます。

eval "$(starship init bash)"

生成されたBashスクリプトを検出した場合、isksh向けのPS1・PS2設定へ変換します。コマンド実行時間、右プロンプト、DEBUG trapを利用するpreexec処理など、Bash固有フックに依存する一部機能は対象外です。

dotfilesツール互換性

isksss/dotfilesのmise.tomlに掲載されたCLI/TUIは、通常の外部コマンドとしてPATH検索、引数・環境変数・終了コード伝播、パイプ、リダイレクト、対話端末の継承を利用できます。.exe、.com、.cmd、.batを含むWindowsの探索規則にも対応します。

Bash向け初期化は次の形式をiskshの対話機能へ変換します。

ツール 初期化 iskshでの動作
mise eval "$(mise activate bash)" MISE_SHELLとプロンプト時のhook-env更新
Starship eval "$(starship init bash)" PS1・PS2プロンプト
zoxide eval "$(zoxide init bash)" z・ziとディレクトリ登録
Atuin eval "$(atuin init bash)" 初期化を受理し、iskshの永続履歴とCtrl+Rを使用
fzf source <(fzf --bash) 初期化を受理し、iskshのTab補完とCtrl+Rを使用

Atuin/fzfのBash Readline専用widgetはRust製ラインエディタへ直接登録せず、同等操作のisksh標準機能へ置き換えます。各ツール本体、Neovim、lazygit、lazydocker、yazi、zellijなどの全画面UIは端末を直接継承します。

対話履歴と補完

対話端末ではカーソル移動、編集、Tabによるコマンド・パス補完、上下キーによる履歴、Ctrl+Rによる逆方向履歴検索を利用できます。履歴は次の優先順で保存します。

  1. ISKSH_HISTORY
  2. $XDG_STATE_HOME/isksh/history
  3. $HOME/.local/state/isksh/history
  4. Windowsでは$LOCALAPPDATA/isksh/history

Unixではフォアグラウンドの外部コマンド・パイプラインへ端末のプロセスグループを移し、Ctrl+C後もシェルを継続します。Windowsではコンソール制御ハンドラーにより、フォアグラウンド子プロセス実行中のCtrl+Cでシェル自身が終了しないようにします。

ジョブ、パイプ、ディスクリプタ

  • 外部コマンドだけで構成されたパイプラインはOSパイプで並列実行します。
  • built-inや関数を含むパイプラインは、現時点では内部バッファを経由します。
  • &は非同期実行し、$!にはiskshのジョブIDを設定します。これはOSのPIDとは限りません。
  • jobsで状態を表示し、waitまたはwait %IDで完了を待機できます。
  • exec 3>file、exec 4<file、>&3、<&4などの永続ディスクリプタを利用できます。
  • trapはEXIT、INT、TERM、DEBUGの登録・表示・解除に対応します。OSシグナルから任意のtrapを非同期実行する機能は段階実装です。

Windows固有の動作

  • PATHとPATHEXTを使用してコマンドを探索します。
  • .exeと.comは直接起動します。
  • .cmdと.batはcmd.exe経由で起動します。
  • PowerShellスクリプトは自動実行しません。
  • パス区切りには/を推奨します。\を含むパスは引用してください。

開発環境

ホストに必要なのはDockerです。Rust、mise、Clippy、rustfmt、クロスコンパイル用ツールはDebian 13ベースの開発コンテナへ導入されます。

docker compose build dev
docker compose run --rm dev mise run build
docker compose run --rm dev mise run test
docker compose run --rm dev mise run coverage
docker compose run --rm dev mise run check-all

Dev Containerからも同じイメージを利用できます。

利用可能なmiseタスク:

タスク 内容
build 開発ビルド
build-release Linux・Windows向けリリース成果物の生成
test Rustテストとdash差分テスト
coverage 本体ライブラリの行カバレッジ100%を検証
lint Clippyを警告ゼロで実行
fmt-check rustfmt差分を検査
check-targets 全対象ターゲットをコンパイル検査
verify-static Linux・Windows成果物の動的依存を検査
check-all 上記の品質検査を一括実行

リリース成果物

docker compose run --rm dev mise run build-release

dist/へ次のファイルを生成します。

  • isksh-linux-x86_64
  • isksh-linux-aarch64
  • isksh-windows-x86_64.exe
  • 各バイナリの.sha256チェックサム

Windowsホストでの実行確認:

.\scripts\windows-smoke.ps1

vX.Y.Z形式のタグをpushするとGitHub Actionsが全検査とWindowsスモークテストを実行し、成功後にバイナリとSHA-256チェックサムをGitHub Releaseへ公開します。タグのバージョンはCargo.tomlのpackage versionと一致している必要があります。

コントリビューション

CONTRIBUTING.mdを確認し、変更を提出する前に次を実行してください。

docker compose run --rm dev mise run check-all

ライセンス

MIT LicenseまたはApache License 2.0のいずれかを選択できます。