Knative developer experience, docs, reference Knative CLI implementation
Go to file
Roland Huß 5ce3d1b71d
chore: fixed documentation of configuration options in README (#1297)
* chore: fixed documentation of configuration options in README

* chore: Updated according to review comments.
2021-05-04 07:18:38 -07:00
.github Update common github actions (#1268) 2021-03-31 00:43:22 -07:00
cmd/kn Enable errorlint and fix all issues (#1223) 2021-02-12 18:27:38 -08: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 chore: fixed documentation of configuration options in README (#1297) 2021-05-04 07:18:38 -07:00
hack Drop --strict flag on ko (#1295) 2021-04-26 17:46:39 -07:00
lib Upgrade Eventing API from v1beta1 to v1 (#1284) 2021-04-08 07:42:51 -07:00
pkg Update Eventing Sources API to v1 (#1299) 2021-05-03 03:12:58 -07:00
test Update Eventing Sources API to v1 (#1299) 2021-05-03 03:12:58 -07:00
third_party/VENDOR-LICENSE Upgrade Eventing API from v1beta1 to v1 (#1284) 2021-04-08 07:42:51 -07:00
tools/knb feat: Add knb plugin build tool (#1226) 2021-03-08 00:22:21 -08:00
vendor Update Eventing Sources API to v1 (#1299) 2021-05-03 03:12:58 -07:00
.gitignore feat: Add knb plugin build tool (#1226) 2021-03-08 00:22:21 -08:00
.golangci.yaml Enable gosec linter and fix existing issues (#1228) 2021-02-16 02:17:26 -08:00
.ko.yaml build test images for e2e (#974) 2020-08-20 04:42:13 -07:00
CHANGELOG.adoc Fix service/revision list output with '-o' param (#1276) 2021-04-13 07:53:00 -07:00
LICENSE Initial commit 2018-12-12 16:45:51 -08:00
OWNERS Update OWNERS_ALIASES to match autogen in community (#1277) 2021-04-01 09:30:23 -07:00
OWNERS_ALIASES Update knative/community files (#1290) 2021-04-20 04:57:36 -07:00
README.md Drop master references to knative repos (#1254) 2021-03-09 03:42:25 -08:00
go.mod Update Eventing Sources API to v1 (#1299) 2021-05-03 03:12:58 -07:00
go.sum Update Eventing Sources API to v1 (#1299) 2021-05-03 03:12:58 -07: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.