hawiyat-client
Version:
Official CLI tool for managing Hawiyat installations
87 lines (64 loc) • 1.42 kB
Markdown
# Hawiyat Client
A command-line client for interacting with the Hawiyat platform to manage dokploy installations and deployments.
## Installation
### Via NPM (Recommended)
\`\`\`bash
npm install -g hawiyat-client
\`\`\`
### Via Binary
1. Download the latest release
2. Run the installation script:
\`\`\`bash
sudo ./install.sh
\`\`\`
## Usage
### Initialize the system
\`\`\`bash
hawiyat init
\`\`\`
### Login
\`\`\`bash
hawiyat login user@example.com password123
\`\`\`
### Install dokploy
\`\`\`bash
sudo hawiyat install
\`\`\`
### Update dokploy
\`\`\`bash
sudo hawiyat update
\`\`\`
### Show information
\`\`\`bash
hawiyat info
hawiyat account-info
\`\`\`
### Logout
\`\`\`bash
hawiyat logout
\`\`\`
## Commands
- `init` - Initialize the system with hawiyat
- `login <email> <password>` - Login to hawiyat platform
- `logout` - Logout from hawiyat platform
- `install` - Install dokploy using hawiyat installer (requires sudo)
- `update` - Update dokploy to latest version (requires sudo)
- `info` - Show client and system information
- `account-info` - Show account information
- `--help` - Show help message
## Development
### Build
\`\`\`bash
npm run build
\`\`\`
### Publish
\`\`\`bash
npm run publish
\`\`\`
## Requirements
- Linux operating system
- Node.js 14+ (for npm installation)
- curl (for system info gathering)
- sudo privileges for install/update operations
## License
MIT License