tripush
v1.0.0
Published
CLI tool for Tripush - Multi-tenant Travel Website Hosting Platform
Maintainers
Readme
Tripush CLI
Official CLI tool for Tripush - Multi-tenant Travel Website Hosting Platform.
Installation
npm install -g tripushQuick Start
1. Configure API Key
First, get your API key from Tripush Dashboard, then configure the CLI:
tripush config --api-key YOUR_API_KEY2. Deploy Your Travel Website
Deploy a travel website from a local directory:
tripush deploy ./my-trip-websiteThe CLI will guide you through:
- Choosing a site name
- Selecting a subdomain
- Picking a domain
3. List Your Sites
View all your hosted sites:
tripush list4. Delete a Site
Remove a site:
tripush delete SITE_IDCommands
tripush config
Configure your API key.
Options:
-k, --api-key <apiKey>- Your API key
Example:
tripush config --api-key abc123...tripush deploy <directory>
Deploy a travel website.
Arguments:
directory- Path to your website directory
Options:
-n, --name <name>- Site name-s, --subdomain <subdomain>- Subdomain-d, --domain <domain>- Domain ID
Example:
# Interactive mode
tripush deploy ./my-trip
# With options
tripush deploy ./my-trip --name "My Trip" --subdomain mytrip --domain 1tripush list
List all your hosted sites.
Example:
tripush listtripush delete <siteId>
Delete a site.
Arguments:
siteId- Site ID to delete
Example:
tripush delete 123Environment Variables
TRIP_API_URL- API endpoint (default:https://api.tripush.com)
Example:
export TRIP_API_URL=http://localhost:13000
tripush deploy ./my-tripFeatures
- ✅ Easy Deployment - Deploy travel websites with a single command
- ✅ Interactive Setup - Guided prompts for site configuration
- ✅ Subdomain Validation - Automatic validation of subdomain availability
- ✅ Progress Feedback - Beautiful progress indicators during deployment
- ✅ Secure Storage - API keys stored securely in local config
- ✅ Multi-domain Support - Choose from available domains
Requirements
- Node.js >= 14.0.0
- npm or yarn
Development
Clone Repository
git clone https://github.com/dustink66/tripush.git
cd tripush/cliInstall Dependencies
npm installLink for Local Development
npm linkNow you can use tripush command locally.
Test
# Set local API URL
export TRIP_API_URL=http://localhost:13000
# Configure API key
tripush config --api-key YOUR_LOCAL_API_KEY
# Deploy test site
tripush deploy ./test-siteDirectory Structure
Your travel website directory should contain:
my-trip-website/
├── index.html # Home page
├── prepare.html # Preparation page
├── budget.html # Budget page
├── notes.html # Notes page
├── styles.css # Styles
├── app.js # JavaScript
└── assets/ # Images and other assets
├── photos/
└── icons/API Key Permissions
Your API key needs the following permissions:
- Create sites
- List sites
- Delete sites
- Access domain list
Get your API key from: https://tripush.com/api-keys
Troubleshooting
Invalid API Key
# Verify your API key
tripush config --api-key YOUR_API_KEYSubdomain Already Taken
Choose a different subdomain during deployment.
Deployment Failed
Check:
- Directory exists and contains valid files
- API key is valid
- Network connection is stable
- API server is running
Support
- Documentation: https://tripush.com/docs
- Issues: https://github.com/dustink66/tripush/issues
- Email: [email protected]
License
MIT © Tripush Team
