nimshell

Nimshell is a convenient shell tool that uses Python syntax to replace traditional commands. It serves as an alternative to the Linux shell, Windows PowerShell, and Windows Batch.

Installation

pip install nimshell

Usage

nimshell
nimshell -f NimShell.py

Features

Cross-Platform: Supports Windows, Linux, and macOS, with automatic adaptation to system encoding and path separators. Strategy Pattern for Subprocess Interaction: Features dual modes for Auto-Reply (AutoInteractive) and Manual Interaction (TerminalInteractive), with support for runtime fallback switching. Asynchronous & Non-Blocking: An intelligent subprocess manager built on asyncio that reads stdout in real time and injects into stdin without blocking the main event loop. A quick translation tip: "runtime fallback switching". In software engineering, "fallback" is the most standard and professional term for gracefully degrading or switching to a backup mode when the primary method isn't working or needs to be changed.

Example

from nimshell.Helper import Helper
from nimshell.MyCommands import Commands, PromptInput, StdIn
from nimshell.shell import SshShell

hlp = Helper()

data = hlp.dataset("git")
print("========================")
# print(data["ChainCommand"])


params = []
params.append(StdIn(seq=0, key="name", value="jim").todict())
params.append(StdIn(seq=0, key="age", value="48").todict())
hlp.Append(PARAMS=params)

# prompts = []
# params.update({"username": "admin", "password": "s3cret"})
# hlp.Replace(PARAMS=params)

prompts = []
prompts.append(PromptInput(seq=0, prompt="username", input="admin").todict())
prompts.append(PromptInput(seq=0, prompt="password", input="s3cret").todict())
hlp.Append(PROMPTS=prompts)


hlp.Refresh()

print(hlp["PARAMS"])
print(hlp["PROMPTS"])

ssh = SshShell()
d = ssh.debug()
# print(d)

demo = Commands("demo", r"D:/MyCodeNew/nimshell/demo.exe")
# demo.stdout(lineno=1, sep=" ", pos=0, key="demo")
hlp.Command(demo.name, demo)
# hlp.Command(**demo.todict())

info = hlp.Alias("info", demo.name)

print("=============")
print(demo.todict())

Development

# Clone the repo
git clone https://github.com/pophu/nimshell.git
cd nimshell


# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check src/ tests/

# Type check
mypy src/

# Build
python -m build