autosite-client
Version:
Client package for deploying React apps to Autosite servers
83 lines (54 loc) • 1.46 kB
Markdown
# AutoSite Client
A CLI tool for easily deploying React applications to AutoSite deployment servers.
## Installation
```bash
# Install globally
npm install -g autosite-client
# Or use with npx (recommended)
npx autosite-client [command]
```
## Usage
### Setup Your Deployment Configuration
```bash
npx autosite-client setup
```
This will prompt you to enter:
- The server URL (e.g., http://yourdomain.com:8080)
- Your API key for deployment authorization
### Deploy Your React Application
```bash
# Navigate to your React project directory
cd your-react-project
# Build your project (if needed)
npm run build
# Deploy your application
npx autosite-client deploy
```
The tool will automatically detect your build directory and deploy your application to the configured server.
### Check Server Status
```bash
npx autosite-client status
```
This will show the status of your server and deployment information.
### View or Update Configuration
```bash
# Show current configuration
npx autosite-client config --show
# Clear configuration
npx autosite-client config --clear
```
## Advanced Usage
### Specify Custom Build Directory
```bash
npx autosite-client deploy --dir dist
```
### Create Development Package for Testing
```bash
npx autosite-client dev-package
```
This creates a deployment package without uploading it, useful for testing.
## Requirements
- Node.js 12 or higher
- A running AutoSite deployment server
## License
MIT