Ktor CLI is a command-line tool that brings the capability to create and run Ktor applications from the command line.
You can install Ktor CLI tools on macOS using Homebrew as follows:
- Add a Ktor repository using the
brew tap
command:brew tap ktorio/ktor
- Install Ktor CLI tools using
brew install
:brew install --build-from-source ktor\
On Linux, you can install Ktor CLI tools using snap:
snap install --beta --classic ktor
You can get a list of Ktor commands available to you by typing ktor --help
.
To create a new Ktor project, pass a project name to the ktor generate
command:
ktor generate ktor-sample
This command generates a simple Ktor project that uses the Gradle build system with Kotlin DSL.
To run the existing Ktor application, use the ktor start
command.
This command accepts the name of the directory where the project is placed:
ktor start ktor-sample
With the default configuration, the terminal should show the following message:
[main] INFO ktor.application - Responding at http://0.0.0.0:8080
This means that the server is ready to accept requests at the http://0.0.0.0:8080 address.