@staxless/cli
v2.5.0
Published
Staxless CLI - Setup and manage your SaaS boilerplate
Maintainers
Readme
Staxless CLI
Build Simple. Scale Smarter.
The official CLI for Staxless - the production-ready SaaS boilerplate.
Installation
npm install -g @staxless/cliQuick Start
# Initialize your project
staxless init
# Start development
staxless dev start
# View logs
staxless dev logs -f
# Deploy to production
staxless prod deployCommands
Setup
| Command | Description |
|---------|-------------|
| staxless init | Initialize Staxless development environment |
| staxless setup:prod | Configure GitHub secrets for production |
| staxless setup:frontend | Configure frontend branding and styles |
Development
| Command | Description |
|---------|-------------|
| staxless dev start | Start all services with rebuild |
| staxless dev up | Start all services |
| staxless dev down | Stop all services |
| staxless dev logs [-f] [service] | View service logs |
| staxless dev status | Show running services |
| staxless dev reset | Full reset (stop, clean, rebuild) |
Production
| Command | Description |
|---------|-------------|
| staxless prod deploy | Deploy to production |
| staxless prod remove | Remove deployment |
| staxless prod status | Show deployment status |
| staxless prod logs [service] | View production logs |
Code Quality
| Command | Description |
|---------|-------------|
| staxless lint | Run linter |
| staxless lint --fix | Auto-fix linting issues |
| staxless format | Format code |
| staxless test | Run test suite |
Utilities
| Command | Description |
|---------|-------------|
| staxless doctor | Check prerequisites and configuration |
| staxless status | Show project status |
| staxless update | Check for CLI updates |
| staxless help [topic] | Get detailed help |
Help Topics
staxless help # Overview
staxless help init # Initialization guide
staxless help dev # Development commands
staxless help prod # Production deployment
staxless help deployment # Full deployment guide
staxless help oauth # OAuth setup
staxless help payments # Stripe integration
staxless help secrets # Managing secrets
staxless help docker # Docker & containers
staxless help troubleshootingPrerequisites
- Node.js 18+ - nodejs.org
- Git - git-scm.com
- GitHub CLI - cli.github.com
- Docker - docker.com
# Authenticate with GitHub
gh auth loginServices
When running staxless dev start, the following services are available:
| Service | Port | Description | |---------|------|-------------| | Frontend | 3000 | Next.js application | | API Gateway | 8000 | Kong API Gateway | | Auth Service | 8080 | Authentication | | User Service | 8082 | User management | | Stripe Service | 8083 | Payments | | Email Service | 8084 | Transactional email | | MongoDB | 27017 | Database | | Kafka | 9092 | Event streaming |
Global Options
--verbose Enable verbose output
--debug Enable debug mode
--dry-run Preview changes without executing
--non-interactive Run without prompts
-c, --config Path to configuration fileLinks
Made with care by Staxless
