Skip to content
Keel

CLI Overview

The keel CLI accelerates development by providing scaffolding, code generation, and project management for ss-keel-core applications.

Installation

Section titled “Installation”
Terminal window
# Coming soon
go install github.com/slice-soft/ss-keel-cli@latest

Commands

Section titled “Commands”

keel new

Section titled “keel new”

Scaffold a new project interactively:

Terminal window
keel new my-api

Planned prompts:

  • Module path (e.g. github.com/myorg/my-api)
  • Port and environment defaults
  • Select addons to include (database, cache, auth, etc.)
  • Docker / docker-compose setup
  • GitHub Actions CI template

keel generate

Section titled “keel generate”

Generate boilerplate for common components:

Terminal window
keel generate controller users
keel generate module orders
keel generate dto CreateUserDTO
SubcommandGenerates
controller <name>Controller struct with CRUD routes skeleton
module <name>Module with Register() and wired controller
dto <name>DTO struct with common validation tags

keel dev

Section titled “keel dev”

Start the development server with hot-reload:

Terminal window
keel dev
# or
keel dev --port 8080

keel build

Section titled “keel build”

Build the application binary:

Terminal window
keel build
keel build --output ./bin/server

Project Generator

Section titled “Project Generator”

A web-based project generator is also planned, inspired by create.astro.build. Configure your stack through a UI and download a ready-to-run project.

Planned features:

  • Pick your database addon (ss-keel-gorm, ss-keel-mongo)
  • Pick your cache addon (ss-keel-redis)
  • Pick your auth strategy (ss-keel-jwt, ss-keel-oauth)
  • Docker and CI/CD templates included
  • Download as a .zip or push directly to a new GitHub repo