Metadata-Version: 2.1
Name: kmux.py
Version: 0.1
Summary: Tmux launcher for kubernetes
Home-page: https://github.com/hq6/kmux
Author: Henry Qin
Author-email: root@hq6.me
License: MIT
Platform: All platforms that tmux runs on.
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: smux.py (>=0.1.8)


kmux
====================

A tmux launcher for Kubernetes that creates one pane per pod, sets the env
variables ``POD``, ``KUBE_CONTEXT``, and ``KUBE_NAMESPACE`` and runs the commands in
the given input file in every pane.

Dependencies
========================================

* Python3.8+
* smux
* tmux (any version)

Installation
========================================

Run the following command::

    pip3 install kmux.py

Usage
========================================

0. Create a new file, either from scratch or by copying Sample.kmux.
1. Type in the commands that you want to run, likely dependent on the
   selected POD.::

     ---------
     command1
     command2
     command3

  Note that a pane does not necessary need to run any commands.

3. Run ``kmux.py <input_file_name>``. By default, this will run the commands
   in the input file against all pods in the current Kubernetes context.
   You may also specify a target context with the command line option
   ``--kube_context``. It will exhibit undefined behavior if there is no
   current context and no context has been specified.



