isksh 0.4.0

A portable POSIX-oriented shell written in Rust
Documentation

isksh

CI crates.io aqua

日本語

isksh is a cross-platform shell written in Rust. It targets the POSIX.1-2024 Shell Command Language and supports practical Bash syntax used by common dotfiles and command-line tools.

The project is under active development and is not yet fully POSIX- or Bash-compatible. See POSIX-COMPATIBILITY.md for known differences.

Install

With Rust and Cargo:

cargo install isksh --locked

Standalone release binaries are available from GitHub Releases.

With aqua from the Standard Registry:

aqua g -i isksss/isksh
aqua install

Usage

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

Running isksh without arguments starts interactive mode when standard input is a terminal; otherwise it reads a script from standard input.

Highlights

  • Commands, pipelines, redirections, here-documents, functions, loops, conditionals, and background jobs
  • POSIX parameter, command, arithmetic, field-splitting, and pathname expansion
  • Interactive editing, history, completion, prompt expansion, and Ctrl+R search
  • Common Bash features including arrays, [[ ... ]], process substitution, aliases, and frequently used built-ins
  • Interactive command abbreviations with fish-style abbr -a NAME EXPANSION
  • Bash-style initialization for Starship, mise, zoxide, Atuin, and fzf
  • Optional zsh compatibility mode with tied/special parameters, functional options, autoloaded and sticky functions, aliases, hooks, completion/ZLE state, extended prompts, arithmetic and conditional expressions, and zsh-oriented built-ins
  • Native terminal handoff for Vim, Neovim, and other full-screen applications
  • UTF-8 scripts with LF or CRLF line endings

Startup files live only under $XDG_CONFIG_HOME/isksh (or $HOME/.config/isksh):

  1. .iskenv for every shell
  2. .iskprofile for login shells (-l, --login, -il, or -li)
  3. .iskrc for interactive shells

ISKSH_MODE defaults to bash. Set ISKSH_MODE=zsh in the process environment or in .iskenv to enable zsh compatibility for the later startup files. Unknown values fall back to bash.

In zsh mode, unquoted scalar parameters remain a single field by default. Use setopt SH_WORD_SPLIT when zsh-compatible field splitting is required. Option names are case-insensitive, ignore underscores, and support a single no prefix inversion.

The compatibility layer includes practical subsets of autoload, functions, zstyle, compinit, compdef, compadd, compset, bindkey, zle, and vared. Interactive completion combines command/file candidates with values registered by compadd; it does not reproduce every zsh module or terminal-editing behavior.

Platforms

Platform Architectures Support
Linux x86_64, aarch64 Tested; fully static musl binaries
Windows 11 x86_64 Tested; static GNU CRT, Windows system DLLs only
macOS x86_64, aarch64 Cross-target compile checks only

Development

Development is containerized; Rust does not need to be installed on the host.

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

check-all runs formatting, Clippy, tests, 100% line-coverage enforcement, cross-target checks, release builds, and static dependency verification. Windows host behavior is tested with:

.\scripts\windows-smoke.ps1

Pushing a vX.Y.Z tag matching the Cargo package version publishes the crate through crates.io Trusted Publishing, then creates the GitHub Release.

License

Licensed under either MIT or Apache-2.0.