README.md

Ktor CLI

The ktor tool allows generating Ktor applications through the command line interface.

For a web interface, visit https://start.ktor.io.

Installing

Linux and macOS

The tool can be installed via Homebrew:

brew install ktor

Windows

The tool can be installed via WinGet:

winget install JetBrains.KtorCLI

Prerequisites

To build the tool, the go compiler needs to be installed first. You can find the installation guide on the official website.

Building

To build an executable, issue the following command in the root directory of the repository:

go build github.com/ktorio/ktor-cli/cmd/ktor

If the build is successful, the ktor executable should appear in the current directory. Also, the go command can be issued through Docker using an official Go image:

docker run --rm -v "$PWD":/usr/src/build -w /usr/src/build golang:1.21 git config --global --add safe.directory . && go build -v github.com/ktorio/ktor-cli/cmd/ktor

Running

To run the tool without making an intermediate build, execute the following command:

go run github.com/ktorio/ktor-cli/cmd/ktor # followed by CLI args

Effectively, the go run github.com/ktorio/ktor-cli/cmd/ktor line can replace the ktor executable in the below commands.

Create a project

To create a new Ktor project, pass a project name to the ktor new command:

ktor new ktor-sample

The -v option can be used to enable verbose output:

ktor -v new ktor-project

Create a project in an interactive mode

To create a new project in the interactive mode, simply use the new command without a project name:

ktor new

Get the version

To get the version of the tool, use the --version flag or the version command:

ktor --version
ktor version

Get the usage info

To get the help page about the tool usage, use the --help flag or the help command:

ktor --help
ktor help

HTTP proxy

To use a proxy server while making requests to the generation server, set the HTTPS_PROXY environment variable. Here is an example:

HTTPS_PROXY=http://localhost:3128 ktor new ktor-project