Skip to content

epics-containers/stdio-socket

Repository files navigation

CI Coverage PyPI License

stdio_socket

Share the stdio of a process on a unix socket.

This package has 3 entrypoints:

  • stdio-expose: launch a process and share its stdio on a unix socket
  • console: connect to a socket to get a console into the above process
  • pptty: wrap a process in a psuedo tty (used by stdio-expose)
Source https://github.com/epics-containers/stdio-socket
PyPI pip install stdio-socket
Releases https://github.com/epics-containers/stdio-socket/releases

Server CLI

 Usage: stdio-expose [OPTIONS] COMMAND                                      
                                                                            
 Expose the stdio of a process on a socket at unix:///tmp/stdio.sock.

 This allows a local process to connect to stdio of the running process.
 Use Ctrl+C to disconnect from the socket.
 The following command will connect to the socket and provide interactive
 access to the process:     socat UNIX-CONNECT:/tmp/stdio.sock -,raw,echo=0
 or use the built in client:     console

╭─ Arguments ──────────────────────────────────────────────────────────────╮
│ *    command      TEXT  Command to run and expose stdio [default: None]  │
│                         [required]                                       │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────╮
│ --socket         PATH  The filepath to the socket to use                 │
│                        [default: /tmp/stdio.sock]                        │
│ --version              print the version number and exit                 │
│ --help                 Show this message and exit.                       │
╰──────────────────────────────────────────────────────────────────────────╯

Client CLI

 Usage: console [OPTIONS]                                                   
                                                                            
 Connect to a socket and pass stdio to/from that socket


╭─ Options ────────────────────────────────────────────────────────────────╮
│ --socket         PATH  The filepath to the socket to use                 │
│                        [default: /tmp/stdio.sock]                        │
│ --version              print the version number and exit                 │
│ --help                 Show this message and exit.                       │
╰──────────────────────────────────────────────────────────────────────────╯

Pseudo TTY CLI

 Usage: pptty [OPTIONS] COMMAND                                             
                                                                            
 Use the pty library to wrap a process in psuedo tty


╭─ Arguments ──────────────────────────────────────────────────────────────╮
│ *    command      TEXT  Command to run and expose stdio [default: None]  │
│                         [required]                                       │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                              │
╰──────────────────────────────────────────────────────────────────────────╯

About

Expose a process stdio on a unix socket

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •