Skip to content

README.md

Latest commit

 

History

History
257 lines (195 loc) · 7.99 KB

README.md

File metadata and controls

257 lines (195 loc) · 7.99 KB
 /$$$$$$   /$$$$$$  /$$$$$$$  /$$$$$$$$ /$$$$$$$  /$$       /$$$$$$  /$$     /$$
/$$__  $$ /$$__  $$| $$__  $$| $$_____/| $$__  $$| $$      |_  $$_/ |  $$   /$$/
| $$  \__/| $$  \__/| $$  \ $$| $$      | $$  \ $$| $$        | $$    \  $$ /$$/ 
| $$      |  $$$$$$ | $$  | $$| $$$$$   | $$$$$$$/| $$        | $$     \  $$$$/  
| $$       \____  $$| $$  | $$| $$__/   | $$____/ | $$        | $$      \  $$/   
| $$    $$ /$$  \ $$| $$  | $$| $$      | $$      | $$        | $$       | $$    
|  $$$$$$/|  $$$$$$/| $$$$$$$/| $$$$$$$$| $$      | $$$$$$$$ /$$$$$$     | $$    
 \______/  \______/ |_______/ |________/|__/      |________/|______/     |__/

License Version Node.js PRs Welcome


"The Future of Deployment is Here" - Fast, Friendly, and Hyper-Modern Web Deployment

⚡ [ QUICK START ] [ FEATURES ] [ DOCS ] ⚡

🌟 Features

🎮 Command Interface

╔══════════════════════════════════════════════╗
║  NEXT-GEN COMMAND SYSTEM                     ║
║  Intuitive • Powerful • Future-Ready         ║
╚══════════════════════════════════════════════╝
  • RUN ⚡ Smart command execution
  • COPY 📦 Seamless file replication
  • MOVE 🚀 Efficient file transfer
  • WORKDIR 🌐 Dynamic directory navigation

🎯 Deployment Options

╔══════════════════════════════════════════════╗
║  DEPLOYMENT MATRIX                           ║
║  Choose Your Style • Your Way • Your Future  ║
╚══════════════════════════════════════════════╝
  • FILES 📂 Smart file deployment
  • COMMANDS ⚡ Remote command execution
  • HYBRID 🔄 Full-spectrum deployment
  • IGNORE 🎯 Precision filtering

🛡️ Security Suite

╔══════════════════════════════════════════════╗
║  SECURITY PROTOCOLS                          ║
║  Safe • Secure • Reliable                    ║
╚══════════════════════════════════════════════╝
  • SSH 🔐 Advanced encryption
  • SFTP 📡 Secure file transfer
  • KEYS 🔑 Smart authentication
  • CONFIG ⚙️ Flexible configuration

🔍 Browse Mode

╔══════════════════════════════════════════════╗
║  INTERACTIVE FILE MANAGEMENT                 ║
║  Browse • Manage • Execute                   ║
╚══════════════════════════════════════════════╝
# 🌟 Enter Browse Mode
$ csdeploy browse

# 📂 Available Commands:
ls                          # List files and directories
cd <dir>                    # Change directory
pwd                         # Show current path
mkdir <dir1> [dir2...]     # Create directories
rmv <file1> [file2...]     # Remove files
rmv -f <dir1> [dir2...]    # Remove directories
rmv -all                   # Remove everything in current path
cp <src> <dest>            # Copy files
mv <src> <dest>            # Move/rename files
run <command>              # Execute remote commands

🎯 Browse Examples

# 📁 Directory Management
mkdir assets images css     # Create multiple directories
cd assets                  # Navigate to directory
pwd                        # Show current location

# 🗑️ File Operations
rmv file1.txt file2.txt    # Remove multiple files
rmv -f folder1 folder2     # Remove multiple directories
rmv -all                   # Clean current directory

# 📦 File Transfer
cp source.js dest.js       # Copy files
mv old.css new.css        # Move/rename files

# ⚡ Remote Execution
run npm install           # Run npm commands
run git pull             # Execute git commands

🛡️ Browse Features

╔══════════════════════════════════════════════╗
║  BROWSE MODE CAPABILITIES                    ║
║  Interactive • Secure • Powerful             ║
╚══════════════════════════════════════════════╝
  • BROWSE 🔍 Interactive file navigation
  • CREATE 📁 Multi-directory creation
  • REMOVE 🗑️ Batch file/directory removal
  • COPY 📦 Secure file copying
  • MOVE 🚀 Smart file relocation
  • EXECUTE ⚡ Remote command execution
  • LIST 📋 Tree-style file listing
  • NAVIGATE 🌐 Seamless directory traversal

🚀 Quick Start

# 🌟 Begin Your Journey
$ npm install -g csdeploy

# ✨ Status: Ready for Action!
# 🎮 Type 'csdeploy' to start

💫 Setup Guide

# 🎮 Initialize Your Project
$ csdeploy init

# ✨ Created:
#   📁 .cscc-deploy/config.json  # Your command center
#   📝 .cscc-ignore             # Smart filters
#   🎯 .deploycommands          # Action sequences

📝 Command Examples

# 🌟 Your Deployment Script
WORKDIR ./your-awesome-project

# 🚀 Get Your Code
RUN git clone https://github.com/your/amazing-project.git

# ✨ Deploy Your Files
COPY ./dist/* ./public/
# or
MOVE ./build/* ./live/

🎮 Commands

🚀 Deploy

# 🌟 Launch Your Project
$ csdeploy deploy

# ✨ Choose Your Style:
> 📂 Files only     # Smart file sync
> ⚡ Commands only  # Remote execution
> 🔄 Full deploy    # Complete sync

⚙️ Configuration

# 🛠️ Update Settings
$ csdeploy edit

# 📊 View Status
$ csdeploy status

🌐 Configuration

{
  "host": "your-awesome-server.net",
  "username": "power-user",
  "privateKey": ".ssh/deploy-key",
  "remotePath": "public/",
  "localPath": "./Project",
  "passphrase": "your-secure-key",
  "type": "SSH"
}

💻 Requirements

╔══════════════════════════════════════════════╗
║  SYSTEM REQUIREMENTS                         ║
║  Future-Ready • Performance • Reliability    ║
╚══════════════════════════════════════════════╝
  • OS 🖥️ Any modern system
  • NODE ⚡ v18.0.0 or newer
  • ACCESS 🔑 SSH/FTP credentials
  • SPACE 💾 Minimal storage needed

🌟 Join Us

╔══════════════════════════════════════════════╗
║  BE PART OF THE FUTURE                       ║
║  Create • Innovate • Deploy                  ║
╚══════════════════════════════════════════════╝
  1. FORK 🌟 Join the project
  2. CREATE ✨ Make something amazing
  3. COMMIT 💫 Share your vision
  4. PUSH 🚀 Launch your code
  5. PR 🎯 Connect with us

Created with ❤️ by Mehdi Harzallah