Welcome to the Crib Ops CLI tool! This guide will help you get started quickly with your new CLI.

For users of different operating systems, we provide specific builds of CribOps CLI. Choose the one that matches your system:

• MacOS Version

  • Download CribOps CLI for MacOS

• Windows Version

  • Download CribOps CLI for Windows

The CLI tool now supports N8N docker compose file generation for quick local install of Crib Ops, N8N as well as combining both the community and licensed verison of Crib Ops with shared postgres db and N8N community edition for convenience.

The CLI is free to download from this repository in the downloads folder. Installer for Windows and Mac. Or just use the docker run commands listed below to run it instantly with no install.

It's also the tool to manage activating a Crib Ops License. Crib Ops provides a hosted SaaS offering that provides an easy to use front door to your webhooks for N8N or other webhook endpoints for automation. It provides durable queues for enhancing availability and scalability of your automation services.

The community edtion of crib ops DOES NOT require a license!

Features coming this week are the ability to automatically add a connection to the included postgres database to your N8N node and adding example workflows leveraging for things like memory and other database functionalty. Credentials for the database are generated upon running the cli and can be referenced via the files written upon generating your compose file.

Once you subscribe to cribops.com, you’ll receive an email with your license.txt file. With our macOS and Windows installers, the CLI is automatically added to your PATH. All you need to do is save your license file to a directory of your choosing and run the setup.

• Prerequisites
• Installation
• Getting Started
  • Using the License File (Crib Ops Only)
  • Passing the License Key as an Argument
• Expected Output
  • Generated Files Tree
  • Example compose.yaml
• Docker Compose Commands
• Troubleshooting & Support

• License File: Upon purchase, you will receive an email with your license.txt.
• Installers: Use the provided macOS or Windows installer which installs the CLI and adds it to your PATH.
• Working Directory: Save your license.txt file into your preferred directory before running the setup.

1. Download and Install:
   Run the macOS or Windows installer for Crib Ops CLI. The installer adds cribops-cli to your system’s PATH. The linux version can be placed manually into an appropriate path of your choosing.

   You can also run the cribops-cli via docker run if you don't wish to install the cli on your os for linux and mac

   macOS/Linux

   docker run --rm -v "$(pwd):/app" -w /app ghcr.io/cloudbedrock/cribops-cli

   Windows Command Prompt

   docker run --rm -v "%cd%:/app" -w /app ghcr.io/cloudbedrock/cribops-cli

   Community Edition Installation (crib ops, N8N and Postgres)

   macOS/Linux

   docker run --rm -v "$(pwd):/app" -w /app ghcr.io/cloudbedrock/cribops-cli setup --unlicensed --include-n8n

   Windows Command Prompt

   docker run --rm -v "%cd%:/app" -w /app ghcr.io/cloudbedrock/cribops-cli --unlicensed --include-n8n

2. Prepare License File:
   Save the attached license.txt file (from your purchase email) in the directory where you will run the CLI.

Simply place your license.txt in your working directory and run the following command in your terminal:

cribops-cli setup

cribops-cli setup --unlicensed --include-n8n

cribops-cli setup -h

The tool will:

• Read your license.txt file.
• Contact the API at https://api.cribops.com/credentials/{licenseKey} to retrieve your credentials.
• Generate secret files and a Docker Compose file for your environment.

Alternatively, you can pass your license key directly:

cribops-cli setup YOUR_LICENSE_KEY_HERE

This bypasses the need for a local license.txt file.

After running the setup, you should see messages similar to:

Secret ACCESS_KEY_ID written to secrets/.accesskeyid
Secret SECRET_ACCESS_KEY written to secrets/.secretaccesskey
Secret CUSTOMER_UUID written to secrets/.customeruuid
Secret CRIBOPS_LICENSE_KEY written to secrets/.cribopslicensekey
Secret CRIBOPS_ITEM_ID written to secrets/.cribopsitemid
Secret SECRET_KEY_BASE written to secrets/.secretkeybase
Secret POSTGRES_PASSWORD written to secrets/.postgrespassword
Secrets successfully written to the secrets directory.
Use these files as secrets in your Docker Compose configuration.
Generated compose.yaml successfully.

If credentials have already been retrieved, you’ll receive a prompt informing you that they can only be retrieved once. In that case, follow the instructions to contact support if needed.

Once setup is complete, your project directory will include files similar to the following tree:

.
├── license.txt
├── compose.yaml
├── secrets
│   ├── .accesskeyid
│   ├── .cribopsitemid
│   ├── .cribopslicensekey
│   ├── .customeruuid
│   ├── .databaseurl
│   ├── .postgrespassword
│   ├── .secretaccesskey
│   └── .secretkeybase
└── .gitignore

Here’s an example of the generated compose.yaml file:

services:
  db:
    image: postgres:17.4
    healthcheck:
      test: ["CMD", "pg_isready", "--username=postgres"]
      interval: 10s
      timeout: 5s
      retries: 5
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    environment:
      POSTGRES_PASSWORD_FILE: /run/secrets/postgrespassword
      PGDATA: /var/lib/postgresql/data/pgdata
    volumes:
      - db_data:/var/lib/postgresql/data
    ports:
      - ${POSTGRES_PORT:-5432}
    secrets:
      - postgrespassword

  cribops:
    image: ${WEB_IMAGE:-ghcr.io/cloudbedrock/cribops:latest}
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    environment:
      DATABASE_URL_FILE: /run/secrets/databaseurl
      SECRET_KEY_BASE_FILE: /run/secrets/secretkeybase
      ACCESS_KEY_ID_FILE: /run/secrets/accesskeyid
      SECRET_ACCESS_KEY_FILE: /run/secrets/secretaccesskey
      CRIBOPS_LICENSE_KEY_FILE: /run/secrets/cribopslicensekey
      CRIBOPS_ITEM_ID_FILE: /run/secrets/cribopsitemid
      CUSTOMER_UUID_FILE: /run/secrets/customeruuid
      PHX_HOST: localhost
      PORT: 4000
      CHECK_ORIGIN: "//localhost:4000"
    ports:
      - "4000:4000"
    command: >
      bash -c "bin/migrate && \
               bin/server"
    depends_on:
      - db
    secrets:
      - secretkeybase
      - databaseurl
      - accesskeyid
      - secretaccesskey
      - cribopslicensekey
      - cribopsitemid
      - customeruuid

volumes:
  db_data:

secrets:
  postgrespassword:
    file: ./secrets/.postgrespassword
  secretkeybase:
    file: ./secrets/.secretkeybase
  databaseurl:
    file: ./secrets/.databaseurl
  accesskeyid:
    file: ./secrets/.accesskeyid
  secretaccesskey:
    file: ./secrets/.secretaccesskey
  cribopslicensekey:
    file: ./secrets/.cribopslicensekey
  cribopsitemid:
    file: ./secrets/.cribopsitemid
  customeruuid:
    file: ./secrets/.customeruuid

After generating your compose.yaml and secret files, you can use Docker Compose to manage your services. Here are some common commands:

• Run in Foreground:

  docker compose up

  This starts all services and streams the logs to your console.

• Run in Detached Mode:

  docker compose up -d

  This starts the services in the background.

• Stop Containers:

  docker compose stop

  This stops all running containers without removing them.

• Take Down Containers and Network:

  docker compose down

  This stops containers and removes the containers, networks, and any created volumes associated with the project.

• View Logs:

  docker compose logs

  To follow logs in real time, use:

  docker compose logs -f

Note: If you’re using the legacy Docker Compose (version 1), replace docker compose with docker-compose.

By following this guide, you should be able to configure your environment quickly and securely. Enjoy using Crib Ops CLI!