Metadata-Version: 2.1
Name: colab-xterm
Version: 0.2.0
Summary: Open a terminal in colab, including the free tier.
Home-page: https://github.com/InfuseAI/colab-xterm
Project-URL: Bug Tracker, https://github.com/InfuseAI/colab-xterm/issues
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# colab-xterm
Colab-xterm allows you to open a terminal in a cell.

# Usage

1. Install package and load the extension
    ```
    !pip install colab-xterm
    %load_ext colabxterm
    ```
2. Open a terminal
    ```
    %xterm
    ```
3. Enjoy!

Try it out in the demo notebook. 

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/infuseai/colab-xterm/blob/main/demo.ipynb)

# Features
- TTY support
- Does not block your kernel

# Options

```
%xterm height=1000 port=10001
```

option | description
-------|-----------
height | The height of the terminal panel
port | The server port

# Screenshots
![](assets/colab-xterm.png)
