Document updated on Jun 6, 2021

Running KrakenD Enterprise: Available commands

After installing KrakenD Enterprise, you can start using it by typing krakend help:

$krakend

╓▄█                          ▄▄▌                               ╓██████▄µ
▐███  ▄███╨▐███▄██H╗██████▄  ║██▌ ,▄███╨ ▄██████▄  ▓██▌█████▄  ███▀╙╙▀▀███╕
▐███▄███▀  ▐█████▀"╙▀▀"╙▀███ ║███▄███┘  ███▀""▀███ ████▀╙▀███H ███     ╙███
▐██████▌   ▐███⌐  ,▄████████M║██████▄  ║██████████M███▌   ███H ███     ,███
▐███╨▀███µ ▐███   ███▌  ,███M║███╙▀███  ███▄```▄▄` ███▌   ███H ███,,,╓▄███▀
▐███  ╙███▄▐███   ╙█████████M║██▌  ╙███▄`▀███████╨ ███▌   ███H █████████▀
                     ``                     `'`

Version: 2.7.2

KrakenD is a declarative high-performance API gateway that helps you effortlessly adopt microservices

Usage:
  krakend [command]

Available Commands:
  audit        Checks the integrity of the config and returns security recommendations.
  check        Validates that the configuration file is valid.
  check-plugin Checks your plugin dependencies are compatible.
  e2e          Executes an end to end test for the gateway based on the configuration file and a set of specs.
  generate     Generates static content for several functionalities. See subcommands.
  help         Help about any command
  run          Runs the KrakenD server.
  version      Shows KrakenD version.

Flags:
  -h, --help   help for krakend

Use "krakend [command] --help" for more information about a command.

To see all the options of a command type krakend help <COMMAND> or krakend <COMMAND> -h.

The commands are:

• krakend audit: Use krakend audit to get security recommendations for a given configuration.
• krakend check: Use krakend check to make sure the configuration file you have generated is not broken and has the required attributes to start the gateway.
• krakend check-plugin: Use the check-plugin when you are developing custom plugins and you want to check that they are compatible with the server.
• krakend e2e: Use the end to end command to run integration tests.
• krakend generate: Use the generate command to transform from and to different formats like OpenAPI.
• krakend run: Use run to start the API gateway server.
• krakend version: Use the version command to print the current KrakenD version and the Glibc and Go versions used during compilation.

To start the server, invoke the krakend run command. The command will require a configuration file with your API definition. You can create your first krakend.json file using the KrakenDesigner if you prefer a UI.

Make sure KrakenD can find a krakend.json and a LICENSE file in the same place where it is executed (workdir).

To get started right away, you can paste the following content inside a krakend.json file:

{
    "$schema": "https://www.krakend.io/schema/v2.7/krakend.json",
    "version": 3
}

And then you can start KrakenD:

$krakend run -c krakend.json

Or if you use Docker:

$docker run -p 8080:8080 -v "$PWD:/etc/krakend/" krakend/krakend-ee:2.7 run --config /etc/krakend/krakend.json

Now KrakenD is listening on 8080, and you can see it working under http://localhost:8080/__health.