Remote execution CLI for deployment
npm install redep> A secure, streaming deployment tool for Node.js and Docker environments. Real-time logs, multi-server support, and secure execution.
redep is a lightweight, secure Command Line Interface (CLI) designed to simplify remote deployment workflows. It solves the problem of "blind deployments" by establishing a real-time WebSocket connection between your local machine (or CI/CD runner) and your remote servers.
- 📺 Real-time Streaming: Watch your deployment logs (stdout/stderr) stream live to your terminal.
- 🔒 Secure: Uses Token-based authentication and strictly isolated command execution.
- ⚡ Multi-Server: Manage multiple environments (Development, UAT, Production) from a single config.
- 🐳 Docker Ready: Comes with a production-ready Docker image for instant server setup.
- 🛠️ Flexible: Execute any command you define (docker compose, kubectl, shell scripts, etc.).
---
Install globally to use the CLI on your local machine or server.
``bash`
npm install -g redep
Pull the official image for running the server component.
`bash`
docker pull nafies1/redep:latest
---
The server is the agent that runs on your remote machine and executes the deployment commands.
#### Option A: Using Docker (Recommended)
Linux / macOS (Bash):
`bash`
docker run -d \
--name redep-server \
--restart always \
-p 3000:3000 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v $(pwd):/app/workspace \
-e SECRET_KEY=your-super-secret-key \
-e WORKING_DIR=/app/workspace \
-e DEPLOYMENT_COMMAND="docker compose pull && docker compose up -d" \
nafies1/redep:latest
Windows (PowerShell):
`powershell
docker run -d
--name redep-server
--restart always
-p 3000:3000
-v /var/run/docker.sock:/var/run/docker.sock
-v ${PWD}:/app/workspace
-e SECRET_KEY=your-super-secret-key
-e WORKING_DIR=/app/workspace
-e DEPLOYMENT_COMMAND="docker compose pull && docker compose up -d"
nafies1/redep:latest
``
#### Option B: Using npm & PM2
`bashInitialize configuration
redep init serverFollow the prompts to set port, working dir, and secret key
$3
The client runs on your local machine or CI pipeline.
bash
Initialize a server profile
redep init client
? Enter Server Name: prod
? Enter Server URL (Host): http://your-server-ip:3000
? Enter Secret Key: your-super-secret-key
`$3
Trigger a deployment to your configured server.
bash
redep deploy prod
`You will see:
text
(INFO) Connecting to http://your-server-ip:3000...
(SUCCESS) Connected to server. requesting deployment...
(INFO) [10:00:01 AM] Status: Deployment Started
(INFO) [10:00:02 AM] [STDOUT] Pulling images...
(INFO) [10:00:05 AM] [STDOUT] Container recreated.
(SUCCESS) [10:00:06 AM] Status: Deployment Completed
`---
⚙️ Configuration
uses a hierarchical configuration system:1. Environment Variables (Highest Priority)
2. Config File (Managed via CLI)
See Advanced Configuration for full details on environment variables and config management.
---
💻 Development Setup
$3
- Node.js >= 18
- Docker (for testing container builds)
$3
1. Clone the repository:
`bash
git clone https://github.com/nafies1/redep.git
cd redep
`2. Install dependencies:
bash
npm install
`3. Link globally (optional):
bash
npm link
`4. Run tests:
Currently, we rely on manual verification using the
directory.
`bash
# Start server
npm run start -- listen
``---
This project uses GitHub Actions for automation:
- Build & Push Docker Image: Triggered on new release tags. Pushes to Docker Hub.
- Publish npm Package: Triggered on new release tags. Publishes to npm registry.
See .github/workflows/ci-cd.yml for details.
---
- Docker Guide - Full reference for Docker deployment, configuration, and security.
- Troubleshooting Guide - Solutions for common connection and auth issues.
- Advanced Configuration - Deep dive into config options and PM2.
- API Reference - Socket.IO events and protocol details.
---
This project is licensed under the ISC License.