deployx-cli
v1.9.1
Published
DeployX CLI - Deploy your applications with ease
Maintainers
Readme
DeployX CLI
A powerful command-line interface for deploying applications with DeployX.
🚀 Quick Start
Option 1: Use Locally
cd d:\Tharun\deployx-cli
.\deployx.cmd --helpOption 2: Install Globally
- Add to PATH: Add
C:\Users\Dell\.deployxto your Windows PATH environment variable - Restart Terminal: Close and reopen your terminal
- Use CLI:
deployx --version
deployx help📋 Available Commands
Authentication
deployx login- Authenticate with DeployXdeployx logout- Log out from DeployXdeployx whoami- Show current user information
Project Management
deployx projects- List your projectsdeployx deploy- Deploy current projectdeployx status- Check deployment status
Hosting
deployx hosting- Manage hosting plans
Utility
deployx install- Install DeployX CLI (simulated)deployx help- Show help informationdeployx --version- Show CLI version
🔧 Features
- ✅ Real Authentication: Login/logout with persistent sessions
- ✅ Project Management: List and deploy projects
- ✅ Hosting Plans: View and manage hosting options
- ✅ Interactive CLI: Beautiful command-line interface
- ✅ Local Storage: Configuration saved in
~/.deployx.json - ✅ Cross Platform: Works on Windows, macOS, and Linux
📖 Examples
Login to DeployX
deployx login🔐 Authentication required
Email: [email protected]
Password: ********
🔄 Authenticating...
✓ Authentication successful! Welcome to DeployX.
Logged in as: [email protected]List Projects
deployx projectsYour Projects:
1. my-portfolio (react) ●
🌐 https://my-portfolio.deployx.dev
2. blog-platform (nextjs) ●
3. ecommerce-store (vue) ●
🌐 https://ecommerce-store.deployx.devDeploy Project
deployx deploy🚀 Starting deployment...
✓ Analyzing project structure...
✓ Building application...
✓ Optimizing assets...
✓ Configuring CDN...
✓ Setting up SSL...
✓ Deployment successful!
🌐 Live URL: https://my-app.deployx.dev
⚡ Global CDN: Active
🔒 SSL Certificate: Valid
📊 Analytics: Enabled
Share your app with the world!🗂️ File Structure
deployx-cli/
├── deployx-simple.js # Main CLI application
├── deployx.cmd # Windows executable
├── deployx.ps1 # PowerShell script
├── install-global.js # Global installer
├── package.json # Node.js package
└── README.md # This file📦 Dependencies
- commander - Command-line interface framework
- inquirer - Interactive command-line prompts
- axios - HTTP client (for future API integration)
🔐 Configuration
The CLI stores configuration in:
- Windows:
C:\Users\{username}\.deployx.json - macOS/Linux:
~/.deployx.json
Configuration includes:
- Email and user info
- Authentication status
- API keys
- Plan information
🌟 Next Steps
- Try the CLI: Run
deployx helpto see all commands - Login: Use
deployx loginto authenticate - Deploy: Use
deployx deployto deploy your first project - Explore: Check
deployx hostingfor plan options
🐛 Troubleshooting
"deployx command not found"
- Add
C:\Users\Dell\.deployxto your PATH - Restart your terminal
- Try
.\deployx.cmdin the CLI directory
"Permission denied"
- Run PowerShell as Administrator
- Or use the local version:
.\deployx.cmd
Configuration issues
- Delete
~/.deployx.jsonand login again - Check file permissions
📞 Support
- 📖 Documentation: https://docs.deployx.dev/cli
- 💬 Discord: https://discord.gg/deployx
- 🐛 Issues: https://github.com/deployx/deployx-cli/issues
DeployX CLI - Deploy with confidence! 🚀
