Skip to main content

XmyShell

XmyShell is a shell-like tool built on top of prompt_toolkit which provides a persistent Python runtime. The main process is Python, and shell commands are executed in subprocesses. It provides a persistent Python namespace, inline Python evaluation, and command output capture. It can be useful if you want Python evaluation in a shell or execute shell command conveniently in Python REPL environment.

Get started

Installation

pip install xmyshell

Start

$ xmyshell
XmyShell 0.1.0
Initialized with 296ms.
Username@hostname ➜  ~ 0ms
❯

Learn more through help.

❯ help

Features

Command Line Features

  • Persistent Python namespace across commands (variables, imports, functions)
  • Expand inline Python expressions within {}, using independent namespace.
❯ mkdir {" ".join(f"test{i}" for i in range(10))}
❯ ls
test0  test1  test2  test3  test4  test5  test6  test7  test8  test9
  • Evaluate and print Python expressions with print
❯ print 1 + 1
2
  • Execute Python statements with pyexec
❯ pyexec files = [f for f in os.listdir('.') if f.endswith('.py')]
❯ print len(files)
3
  • Capture command output into a Python variable with =>.
❯ which python => path
❯ print path
/usr/bin/python
❯ cd {dirname(path)}
❯ pwd
/usr/bin
  • Redirect the output of Python commands (print, pyexec) with |>
❯ print "\n".join(str(i) for i in range(100)) |> grep 42 => result
❯ print result
42
  • Built-in source command to run python scripts.
❯ which python
/usr/bin/python
❯ source .venv/bin/activate_this.py
❯ which python
/tmp/test/.venv/bin/python
  • Built-in export command.
❯ pyexec foo = "foo"
❯ export ENV_VAR={foo}bar
❯ print ENV_VAR
foobar
  • Built-in import command.
❯ import numpy as np
❯ from math import *
  • Reload with reload command.
❯ reload
  • Update xmyshell (optionally to a specific version).
❯ udpate

or

❯ update 0.1.3
  • Alias
❯ alias ll='ls -lh'
❯ unalias ll
  • Lists, tuples, generators, etc. will be expanded into shell arguments. E.g. {["arg1", "arg2 xxx"]} will be expanded into arg1 'arg2 xxx'

Here is an example (though there are other ways to do this, it is just an example )

❯ pip install {cat("requirements.txt").splitlines()}
  • Syntax highlighting via prompt_toolkit
  • Powerful auto-completion, history search, and automatic bracket/quote pairing
  • Startup configuration: ~/.xmyshell/config.py loaded at launch
  • Cross-platform (Windows, Linux, macOS)

Built-in Helper Functions

  • getlogin() Returns the current username.

  • getcwd() Returns the absolute path of the current working directory.

  • dirname(path) Returns the parent directory of a path.

  • basename(path) Returns the final component of a path.

  • cat(file) Shortcut for open(file).read().

  • alias(altname, target) Same as the command.

  • unalias(altname) Same as the command.

Reserved global varibles

  • exit_code The exit code of the last command.

  • exec_duration The duration which last command took.

  • SHOW_WELCOME Toggle whether to show welcome message when staring.

  • SHELL_CMD Shell command line prefix, defaults to ["cmd", "/c"] on Windows and ["bin/sh", "-c"] on other OS.

  • HOME_DIR The home directory, similar to ~.

  • PROFILE The path of config file.

Keyboard Shortcuts

  • ↑↓ -> Navigate through command history.
  • → -> Apply selected history entry to the prompt.
  • Ctrl+R -> Reverse incremental searching (history).
  • Ctrl+Z -> Undo.
  • Ctrl+Y -> Redo.
  • Ctrl+D -> Exit XmyShell.
  • Auto bracket/parenthesis/quote pairing

Stubs

You can write your xmyshell script with these imports:

from xmyshell.themes import ... # themes
from xmyshell.stubs import ...  # stubs for built-in names

Limitations

XmyShell is Python‑first. This brings power, but also intentional trade‑offs.

  • No source for shell scripts — source executes Python files via runpy.run_path(). Shell scripts (e.g., venv/bin/activate) won't work; use activate_this.py instead.

  • No deactivate — This is a shell function, not a real command. Virtual environments can be deactivated by reloading environment (reload) or manually restarting a session.

  • Shell scripts cannot modify the current environment — Every external command runs in a fresh subprocess; cd, export, aliases, and function definitions inside a script are lost on exit.

  • No pipelines between built‑in commands — print and pyexec do not support |. Use Python variables to pass data.

  • External command overhead — Each subprocess spawns with minor delays.

Why? XmyShell is NOT a Bash replacement. It's a Python‑native environment for those who want Python's power at the command line.

Metadata

Release files for xmyshell 0.2.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xmyshell 0.2.16
File Size Uploaded Provenance Actions
xmyshell-0.2.16.tar.gz 53.4 kB Without provenance Details for xmyshell-0.2.16.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for xmyshell 0.2.16
File Interpreter ABI Platform Actions
xmyshell-0.2.16-py3-none-any.whl Python 3 none any Details for xmyshell-0.2.16-py3-none-any.whl

Total release size: 108.6 kB

Release files / xmyshell-0.2.16.tar.gz

Download URL xmyshell-0.2.16.tar.gz
Size 53.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0c8678699c98a9df21296c55f623e76e9955390fd878760e06a22b743cdec8bd
BLAKE2b-256 checksum
How to use checksums
c31e2a9b8b7dc24c0e1ede7d1da7a9d7ddfa8ebeff02829ac6aff92d878fe01e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / xmyshell-0.2.16-py3-none-any.whl

Download URL xmyshell-0.2.16-py3-none-any.whl
Size 55.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ef0b3528c87cd443cdd3f911d231b10053c997343dde4b6776839ffc3751bdaa
BLAKE2b-256 checksum
How to use checksums
bf24f0093148acd2051874668f25a8adb6e7ffbcb594a7a3dfa917185514380a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for xmyshell 0.2.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.16 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page