lydza / client

Knative developer experience, docs, reference Knative CLI implementation

Kn

The Knative client kn is your door to the Knative world. It allows you to create Knative resources interactively from the command line or from within Shell scripts.

kn offers you:

• Full support for managing all features of Knative Serving (services, revisions, traffic splits)
• Growing support Knative eventing, closely following its development (managing of sources & triggers)
• A plugin architecture similar to that of kubectl plugins
• A thin client-specific API in golang which helps in tasks like synchronously waiting on Knative service write operations.
• An easy integration of Knative into Tekton Pipelines by using kn in a Tekton Task.

This client uses the Knative Serving and Knative Eventing API exclusively so that it will work with any Knative installation, even those that are not Kubernetes based. It does not help in installing Knative itself though. Please refer to the various Knative installation options for how to install Knative with its prerequisites.

Documentation

Start with the user's guide to learn more. You can read about common use cases, get detailed documentation on each command, and learn how to extend the kn CLI. For more information, have a look at:

• User guide
  • Installation - How to install kn and run on your machine
  • Examples - Use case based examples
  • FAQ (to come.)
• Reference Manual - all possible commands and options with usage examples

Developers

We love contributions! Please refer to CONTRIBUTING for more information on how to best contributed to contribute to Knative.

For code contributions it as easy as picking an issue (look out for "kind/good-first-issue"), briefly comment that you would like to work on it, code, test, code and finally submit a PR which will trigger the review process.

More details on how to build and test can be found in the Developer guide.