Skip to content

shell-pool/homebrew-shpool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

homebrew-shpool

Homebrew tap for shpool, a lightweight persistent shell session manager for macOS.

Warning

Linux is the primary supported platform. macOS support is functional but some features are still being worked on. See the platform support notes in the main repository for the current state.

Installation

brew tap shell-pool/shpool
brew install shpool

To have the daemon start automatically at login:

brew services start shpool

SSH configuration

The typical use case is connecting to a Mac running shpool from a remote machine. Add a block to ~/.ssh/config on your client:

Host = main edit
    Hostname remote.host.example.com

    RemoteCommand /opt/homebrew/bin/shpool attach -f %k
    RequestTTY yes

Then ssh main or ssh edit will create or reattach to a named session. %k expands to the host alias used on the command line.

Note

SSH's RemoteCommand runs in a non-login shell that does not source your profile, so shpool won't be on $PATH. Use the full path to the binary as shown above. Run which shpool on the host if it's installed somewhere other than /opt/homebrew/bin.

Configuration

shpool can be configured via ~/.config/shpool/config.toml. See CONFIG.md in the main repository for the full list of options.

More information

  • shpool repository — source, full documentation, and Linux installation instructions
  • Wiki — tips, troubleshooting, and advanced usage

About

Repo to enable brew tap shell-pool/shpool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages