LinuxCommandLibrary

kool

Run development tasks using Docker

TLDR

Create a project using a specific preset

$ kool create [preset] [project_name]
copy

Run a specific script defined in the kool.yml file in the current directory
$ kool run [script]
copy

Start/stop services in the current directory
$ kool [start|stop]
copy

Display status of the services in the current directory
$ kool status
copy

Update to the latest version
$ kool self-update
copy

Print the completion script for the specified shell
$ kool completion [bash|fish|powershell|zsh]
copy

SYNOPSIS

kool <command> [options] [arguments]

PARAMETERS

new
    Creates a new Kool Framework project with the specified name in the current directory. Example: kool new my_app

serve
    Starts a local development server for the current Kool Framework application, typically accessible via a web browser. Example: kool serve

db:migrate
    Runs pending database migrations, updating the application's database schema to its latest version. Example: kool db:migrate

make:model
    Generates a new model class file within the application, often alongside an associated database migration. Example: kool make:model User

help [command]
    Displays comprehensive help information for the main kool command or a specific subcommand. Example: kool help serve

version
    Shows the version of the kool CLI tool and the underlying Kool Framework.

DESCRIPTION

The kool command serves as the command-line interface (CLI) for the Kool Framework, a modern PHP web development framework. It provides a suite of tools designed to streamline and automate common development tasks associated with building and managing Kool Framework applications.
Functionalities include scaffolding new projects, running local development servers, managing database migrations, generating various code components like models, controllers, and views, and inspecting application routes. It significantly enhances developer productivity by abstracting complex configurations and providing a unified interface for framework interactions.
It is important to note that kool is not a standard, pre-installed Linux utility but rather an application-specific executable that becomes available after installing the Kool Framework or its associated CLI package.

CAVEATS

The kool command is not a core component of the Linux operating system. Its availability and functionality depend on a prior installation of the Kool Framework, typically managed via Composer, and a functioning PHP environment on the system. It is specifically designed for interaction with Kool Framework projects.

HISTORY

The kool command emerged as an integral part of the Kool Framework, a modern PHP framework focused on performance and developer experience. Its development has focused on providing a streamlined workflow for web application development, consolidating various tasks into a single, intuitive command-line interface. It has evolved alongside the framework, adding new commands and refining existing ones to support modern web development paradigms and framework features.

SEE ALSO

composer(1), php(1), artisan(1), npm(1)

Copied to clipboard