create-habeetat

Create a new Habeetat Platform instance with a single command.

Quick Start

npm create habeetat my-platform

Or with a specific version:

npm create habeetat@dev my-platform

What it does

1. Checks prerequisites (Docker, Node.js)
2. Prompts for configuration (domain, admin email, password, organization)
3. Scaffolds a project directory with all necessary files
4. Generates Docker Compose, Nginx, and environment configuration

Options

npm create habeetat [name] [options]

Options:
  --domain <domain>           Domain name (e.g., example.com)
  --admin-email <email>       Admin email
  --admin-password <password> Admin password
  --organization <name>       Organization name
  --no-ssl                    Disable SSL (HTTPS)
  --skip-start                Don't start after scaffolding
  --tag <tag>                 Docker image tag (default: this package's version, which the
                              release pipeline keeps equal to the platform image tag)
  --registry <registry>       Docker registry/namespace for the platform images
                              (default: docker.io/capriisland; env: HABEETAT_DOCKER_REGISTRY)

Generated Project

my-platform/
  habeetat.json            # Platform configuration
  .env                     # Environment variables (secrets)
  docker-compose.yml       # Docker service definitions
  nginx/platform.conf      # Nginx reverse proxy config
  package.json             # With @habeetat/cli dependency
  README.md

After Creation

cd my-platform
npx habeetat up       # Start the platform
npx habeetat status   # Check service health
npx habeetat logs -f  # Follow logs

Requirements

• Docker >= 20.0 with Compose V2
• Node.js >= 18

License

MIT