rushdeploy 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,67 @@
+# RushDeploy CLI (Node.js Package)
+
+A zero-dependency Node.js command-line utility to manage your self-hosted RushDeploy PaaS account.
+
+---
+
+## Installation
+
+Install the package globally via npm:
+
+```bash
+npm install -g 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 Workspace Status
+```bash
+# Displays workspace resource quotas and allocations
+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 workspace`**: Display resource usage limits and quotas.
+* **`rushdeploy help`**: Show the CLI help dialog.
+
+### Deployments
+* **`rushdeploy deploy git <url> [opts]`**: Trigger deployment from a Git clone URL.
+  * *Options: `--name <name>`, `--branch <branch>`, `--type <framework>`*
+* **`rushdeploy deploy repo <owner/repo> [opts]`**: Trigger deployment from your connected GitHub account.
+  * *Options: `--name <name>`, `--branch <branch>`, `--type <framework>`*
+* **`rushdeploy deploy wordpress <name> --email <e> [opts]`**: Provision a new WordPress site instance.
+  * *Options: `--title <title>`, `--user <user>`, `--password <pass>`*
+
+### Project Control
+* **`rushdeploy project <slug> start|stop|redeploy`**: Control container run state.
+* **`rushdeploy project <slug> visit`**: Open the project's URL in your default browser.
+* **`rushdeploy project <slug> stats`**: Stream container CPU & RAM telemetry.
+* **`rushdeploy project <slug> logs`**: Tail container build and running output.
+  * *Options: `--lines <N>`*
+* **`rushdeploy project <slug> env [set|remove]`**: Configure environment variables.
+* **`rushdeploy project <slug> autoscale`**: Read/write auto-scaling replica properties.
+* **`rushdeploy project <slug> autodeploy <on|off>`**: Toggle webhook push deployments.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rushdeploy",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CLI tool to manage your self-hosted RushDeploy PaaS account.",
   "main": "bin/index.js",
   "bin": {
@@ -17,4 +17,4 @@
   ],
   "author": "RushDeploy Team",
   "license": "MIT"
-}
+}