Knative developer experience, docs, reference Knative CLI implementation
Go to file
knative-automation a0ddad92fc
Update common github actions (#1090)
Signed-off-by: Knative Automation <automation@knative.team>
2020-11-06 03:05:07 -08:00
.github Update common github actions (#1090) 2020-11-06 03:05:07 -08:00
cmd/kn Fix various misspellings and linter items (#1057) 2020-10-12 21:24:30 -07:00
config Use ko's strict mode for better errors messages (#706) 2020-03-07 12:11:27 -08:00
conventions Fix various misspellings and linter items (#1057) 2020-10-12 21:24:30 -07:00
docs Feature: "kn service apply" (#964) 2020-11-02 00:36:35 -08:00
hack updating to use the hack repo (#1084) 2020-10-30 11:41:35 -07:00
lib Export test refactor (#1069) 2020-11-02 07:21:35 -08:00
pkg Export test refactor (#1069) 2020-11-02 07:21:35 -08:00
test Export test refactor (#1069) 2020-11-02 07:21:35 -08:00
third_party/VENDOR-LICENSE Pin deps back to master (#1082) 2020-10-30 08:15:35 -07:00
vendor upgrade to latest dependencies (#1091) 2020-11-05 22:12:07 -08:00
.gitignore Explicit name for serving client (#537) 2019-12-08 23:42:44 -08:00
.golangci.yaml Add linting config and fix issues. (#1001) 2020-09-11 05:41:00 -07:00
.ko.yaml build test images for e2e (#974) 2020-08-20 04:42:13 -07:00
CHANGELOG.adoc uniform multiple writeSink into DescribeSink (#1075) 2020-10-29 06:44:34 -07:00
LICENSE Initial commit 2018-12-12 16:45:51 -08:00
OWNERS Adds Navid (@navidshaikh) to approvers list (#321) 2019-07-31 13:59:43 -07:00
README.md Fix a couple typos in README (#1007) 2020-09-11 14:56:01 -07:00
go.mod upgrade to latest dependencies (#1091) 2020-11-05 22:12:07 -08:00
go.sum upgrade to latest dependencies (#1091) 2020-11-05 22:12:07 -08:00

README.md

Kn

go.dev reference Go Report Card Releases LICENSE Slack Status

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 scripts.

kn offers you:

  • Full support for managing all features of Knative Serving (services, revisions, traffic splits)
  • Growing support for 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 with 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 APIs exclusively so that it will work with any Knative installation, even those that are not Kubernetes based. It does not help with 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.