Skip to main content

Server to aid shell navigation

Project description

ShellServer

It's a mix of Starship and Zoxide but faster.

On Starship, every 'Enter' keystroke spawns a new process, which may cause a lag between prompts.
Zoxide will raise a new process every time you call it.
ShellServer raises the server only in the first shell creation and will communicate with your shell on every 'Enter' keystroke.

But if your hardware gives you a fluid shell experience using Starship, I recommend that you keep with it because it's way more customizable.

Features

Prompt with a fast glance at what is in directory

Bloated
This is the most bloated prompt that you will get. It will indicate the existence of Python, C, C++, Lua, Node and PowerShell files on directory.
The compilers searched are GCC and G++.

No lag from spawning processes

Fast

Better 'cd'

p, pz
Note: fzf is a dependency to use 'pz'

Switching Theme

Switch-Theme Can take four arguments: all, system, terminal, and blue.
terminal: Toggles Windows Terminal default theme between 'Tango Dark' and 'Solarized Light'.
system: Toggles system wide Dark Mode.
blue: Toggles 'Blue light reduction'.
all: Same as not passing arguments. Do all the above.

Searching history

history

Listing directory

lss

CLI

The server knows how many clients it haves and will know if you quit shell with 'exit'
but if window is closed on 'X' it may outlive the shell.

usage: shellserver [-h] {kill,clear}

positional arguments:
  {kill,clear}  "kill" to kill the server, "clear" to clear the cache.

options:
  -h, --help    show this help message and exit

Requirements

  • Python 3.10+
  • PowerShell 6.2 (I think)
  • Any NerdFont (I use MesloGS NF)

Installation

Currently, ShellServer will work only in PowerShell on Windows. A few things must change to make it work on Linux, so make an Issue if you want to use it. There are plans to get it to Xonsh

> pip install shellserver  # or pip install --user shellserver
> Install-Module ShellServer -Scope CurrentUser

In your PowerShell profile:

# By the beginning of the file
pythonw -m shellserver  # note the 'w'

# By the end of the file
Import-Module ShellServer

Known Issues

  • Git status brackets might give wrong values for now. ShellServer won't parse the 'git status' command because it would threaten performance. It deals with files directly.
  • Prompt might be unstructured on a small window.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shellserver-0.0.4.tar.gz (17.9 kB view hashes)

Uploaded Source

Built Distribution

shellserver-0.0.4-py3-none-any.whl (19.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page