This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Getting Started

This is a placeholder page that shows you how to use this template site.

This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project. For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which lives in the [Docsy theme repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to copy its docs section. Other content such as marketing material, case studies, and community updates should live in the [About](/about/) and [Community](/community/) pages. Find out how to use the Docsy theme in the [Docsy User Guide](https://docsy.dev/docs/). You can learn more about how to organize your documentation (and how we organized this site) in [Organizing Your Content](https://docsy.dev/docs/best-practices/organizing-content/).

1 - Install

Installing BDK

Install pre-built binary

The latest releases binaries can be found in https://github.com/testernetes/bdk/releases

Container Image

Container images can be pulled from ghcr.io/testernetes/bdk:latest

Install from source

To install the latest version of BDK you must have at least Go v1.19 installed and run:

go install github.com/testernetes/bdk@latest

2 - CLI Usage

How to use the BDK CLI

BDK CLI Usage

Behaviour Driven Kubernetes

Usage:
  bdk [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  matchers    View matchers
  steps       View steps
  test        Run a test suite of feature files

Flags:
  -h, --help              help for bdk
  -p, --plugins strings   Additional plugin step definitions

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

Test

Usage:
  bdk test [-f format] features... [flags]

Flags:
  -f, --format string   the format printer (default "simple")
  -h, --help            help for test

Global Flags:
  -p, --plugins strings   Additional plugin step definitions

Where features is a set of 1 or more feature files to test.