Metadata-Version: 2.4
Name: rushdeploy
Version: 1.0.4
Summary: CLI tool to manage your self-hosted RushDeploy PaaS account.
Author-email: RushDeploy Team <team@rushdeploy.com>
License: MIT
Project-URL: Homepage, https://rushdeploy.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# RushDeploy CLI (Python Package)

A zero-dependency Python command-line utility to manage your self-hosted RushDeploy PaaS account.

---

## Installation

Install the package globally via pip:

```bash
pip install rushdeploy
```

---

## Quickstart

### 1. Authenticate with your server
Generate a CLI token in Settings inside the Web Dashboard and log in:
```bash
rushdeploy login <token>
```


### 2. Check System Health & Quotas
```bash
# Displays workspace quotas and host telemetry (for admins)
rushdeploy status
```

### 3. Deploy a project
Deploy a public Git repository:
```bash
rushdeploy deploy git https://github.com/my-username/my-react-app.git --branch main --type react
```

---

## Commands Reference

* **`rushdeploy login <token>`**: Authenticate CLI session.
* **`rushdeploy logout`**: Clear local auth details.
* **`rushdeploy whoami`**: View details of the active user profile.
* **`rushdeploy status`**: Render resource metrics cards.
* **`rushdeploy plans`**: Show plan pricing quotas.
* **`rushdeploy projects`**: List active projects.
* **`rushdeploy repos`**: List repos in connected GitHub profile.
* **`rushdeploy deploy git <url>`**: Trigger deployment from Git URI.
* **`rushdeploy deploy repo <owner/repo>`**: Trigger deployment from connected GitHub repo.
* **`rushdeploy deploy wordpress <name> --email <e>`**: Provision a new WordPress site instance.
* **`rushdeploy project <slug> start|stop|redeploy`**: Control container run state.
* **`rushdeploy project <slug> stats`**: Stream CPU & RAM telemetry.
* **`rushdeploy project <slug> logs`**: Tail container build and running output.
* **`rushdeploy project <slug> env [set|remove]`**: Configure environment variables.
* **`rushdeploy project <slug> autoscale`**: Read/write auto-scaling properties.
* **`rushdeploy project <slug> autodeploy <on|off>`**: Toggle webhook push deployments.
