Metadata-Version: 2.4
Name: shwim
Version: 26.2.0
Summary: Encrypted, peer-to-peer terminal sharing for two people.
Author-email: meejah <meejah@meejah.ca>
License: The MIT License (MIT)
        
        Copyright (c) 2023 meejah
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
License-File: LICENSE
Keywords: fowl,magic-wormhole
Classifier: Framework :: Twisted
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: fowl>=25.7.0
Requires-Dist: magic-wormhole>=0.20.0
Provides-Extra: dev
Requires-Dist: cuvner; extra == 'dev'
Requires-Dist: dulwich; extra == 'dev'
Requires-Dist: gpg; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pip-tools; extra == 'dev'
Requires-Dist: readme-renderer; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/x-rst

ShWiM
=====

``SHell WIth Me`` lets a “host” share their terminal with a “guest” peer
on another computer.

This combines the cryptography of `Magic Wormhole
<http://magic-wormhole.io>`_ (via `Fowl
<https://github.com/meejah/fowl>`_) and the terminal-sharing of
`tty-share <https://tty-share.com/>`_ into a secure, end-to-end
encrypted, **peer-to-peer terminal sharing application**.

.. image:: media/logo-shell-256.png
    :width: 256px
    :align: right
    :alt: the ShWiM logo, the chicken head from Fowl's logo peeking out of a conch-looking shell



Getting Started
---------------

To install, use ``pip install shwim`` (see longer instructions below).
This should enable you to run ``shwim --help``.

The *Host* computer runs ``shwim`` by itself, producing a
``<magic-code>``. The *Guest* computer runs ``shwim <magic-code>``.

You are now sharing a single terminal running on “host”. **Beware**: the
guest can type, run commands, etc. so only do this with humans you would
hand your local keyboard over to.

The Host may pass ``--read-only`` to ignore input from the Guest.

.. image:: media/shwim-light.png
    :width: 1095px
    :align: right
    :alt: The ShWiM terminal UI running, showing a connection to the mailbox server, generated code but no peer yet


Slightly Longer Explanation
---------------------------

Once the two things happen (i.e. “shwim” on the host and “shwim ” on
the guest), there is a secure tunnel between both computers. The host
will decide a random port and run ``tty-share`` as a server; the guest
will run ``tty-share`` as a client.

On both computers, ``tty-share`` will be running as a subprocess with
correct options to do networking via Magic Wormhole only. All raw-mode
terminal I/O is forwarded to this ``tty-share`` process so things like
curses etc work as expected.

Once either side exits, the networking forwarding is done – there is no
long-term credential sharing or any other network set preserved or
altered on the “host” nor “guest” computers.
