@cribops/create

⚠️ WORK IN PROGRESS - This package is under active development. APIs and commands may change.

CLI tool for creating and deploying projects on the Cribops platform.

Installation

npm install -g @cribops/create

This provides two commands:

• create-cribops (or npm create @cribops) - Create new projects
• cribops - Full CLI for deploy, manage, and advanced operations

Quick Start

# Create a new project
npm create @cribops my-site --template=static/astro

# Login to Cribops
cd my-site
cribops login --cli-key ck_xxx

# Deploy
cribops deploy

Commands

Project Creation

# Interactive mode
npm create @cribops

# With project name
npm create @cribops my-site

# With template
npm create @cribops my-site --template=static/astro

# Non-interactive mode
npm create @cribops my-site --template=static/html -y

Authentication

# Login with CLI key
cribops login --cli-key ck_xxx

# Login with custom URL (for development)
cribops login --cli-key ck_xxx --url https://cribops.cloudbedrock.com

# Check auth status
cribops whoami

# Logout
cribops logout

Deployment

# Deploy current project
cribops deploy

# Link to existing site
cribops link

Site Management

# List all sites
cribops sites list

# Create a new site
cribops sites create

# Delete a site
cribops sites delete <site-id>

Advanced Commands

These commands require cribops-ctl (Go binary) to be installed:

# Shell into a container
cribops exec

# Database tunnel
cribops db tunnel

# Stream logs
cribops logs

If cribops-ctl is not installed, the CLI will prompt you to download it.

Supported Site Types

| Type | Description | Frameworks | |------|-------------|------------| | static | S3 + CloudFront static hosting | Astro, HTML, Hugo, Next.js, Vite | | wordpress | Managed WordPress on ECS | - | | php | Containerized PHP app | Basic PHP | | laravel | Laravel on ECS | Laravel | | n8n | Workflow automation | n8n |

Templates

Static Sites

npm create @cribops my-site --template=static/astro
npm create @cribops my-site --template=static/html
npm create @cribops my-site --template=static/hugo
npm create @cribops my-site --template=static/nextjs
npm create @cribops my-site --template=static/vite

Configuration

CLI Key

Get your CLI key from the Cribops dashboard:

1. Go to Settings > API Keys
2. Create a new key with "CLI access" permission
3. Copy the key (starts with ck_)

Project Configuration

The CLI creates a cribops.json file in your project:

{
  "$schema": "https://cribops.com/schema/cribops.json",
  "siteType": "static",
  "framework": "astro",
  "siteId": "uuid-after-deploy",
  "build": {
    "command": "npm run build",
    "outputDirectory": "dist",
    "installCommand": "npm install"
  }
}

Credentials Storage

Credentials are stored in:

• macOS: ~/Library/Preferences/cribops-cli-nodejs/config.json
• Linux: ~/.config/cribops-cli-nodejs/config.json
• Windows: %APPDATA%/cribops-cli-nodejs/config.json

GitHub Actions

For static sites, the CLI generates a GitHub Actions workflow (.github/workflows/deploy.yml) that:

1. Builds your site
2. Uploads to S3
3. Invalidates CloudFront cache

Required secrets (set by Cribops when you connect your repo):

• CRIBOPS_AWS_ACCESS_KEY_ID
• CRIBOPS_AWS_SECRET_ACCESS_KEY
• CRIBOPS_S3_BUCKET
• CRIBOPS_CLOUDFRONT_DISTRIBUTION_ID

cribops-ctl

For advanced operations (database access, container exec, migrations), install cribops-ctl:

macOS:

# Download signed installer
open https://cribops.com/downloads/cribops-ctl-macos.pkg

Windows:

# Download signed installer
https://cribops.com/downloads/cribops-ctl-windows.msi

Linux:

curl -L https://cribops.com/downloads/cribops-ctl-linux-amd64 -o cribops-ctl
chmod +x cribops-ctl
sudo mv cribops-ctl /usr/local/bin/

License

MIT