The ktor
tool allows generating Ktor applications through the command line interface.
The tool can be installed via Homebrew on Linux and macOS:
brew install ktor
To build the tool, the go
compiler needs to be installed first. You can find the installation guide on the official website.
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
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.
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
To get the version of the tool, use the --version
flag or the version
command:
ktor --version
ktor version
To get the help page about the tool usage, use the --help
flag or the help
command:
ktor --help
ktor help
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