Metadata-Version: 2.1
Name: burrow-cli
Version: 0.1.3
Summary: Burrow command line app, you can launch a fractional GPU contaienr with this app, and share a link of the container to your friends, you and your friends can work colloratively together
Author: Vurtne Saerdna
Author-email: vurtnesaerdna@gmail.com
Requires-Python: >=3.9.0,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: docker (>=7.0.0,<8.0.0)
Requires-Dist: requests (==2.31.0)
Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
Description-Content-Type: text/markdown

# Share part of your GPU with your friends!

* With Burrow, you can share part of your GPU with your friends with a single link! 🚀🔗
* Work collaboratively in the same terminal, especially thanks to sshx.io 👨‍💻👩‍💻
* With security in mind, Burrow uses sandbox Docker containers, so your friends can't access your local files. 🛡️🐳🔒

# Install
## Prerequises
* Burrow requires Docker to run. It will install Docker on your local machine if it's not already installed. The automated Docker installation only works on Ubuntu; if you are using other Linux distributions, you will need to install Docker yourself first.
## Install with a script
Run the installation script(Only tested on Ubuntu)
```
curl -sSL https://raw.githubusercontent.com/incomingflyingbrick/burrow-cli/main/install_burrow.sh | sudo sh
```

# Quick Start
Launch a sharable GPU container with 3GB GRAM
```shell
burrow start 3gi
```

List all running burrow container
```
burrow list
```

# Development

* This project is developed using Poetry and Typer
* Python version 3.12.3
