Knative developer experience, docs, reference Knative CLI implementation
Go to file
Dave Protasowski a7ea77d106
Update go.mod to specify the module is go1.14 (#866)
* Update go.mod to specify the module is go1.14

Thus the go commands will default to -mod=vendor

See: https://golang.org/doc/go1.14#go-command

* install goimports as a tool

* drop mod=vendor usage as that's the default with go1.14

* remove comment about using -mod=vendor

* Revert "drop mod=vendor usage as that's the default with go1.14"

This reverts commit 567004d404bb7ebd39ed527dc75759cfc7db672f.

* Revert "remove comment about using -mod=vendor"

This reverts commit 2a71393a2015c1539be1503e0c52cf64283e12d0.

* Revert "install goimports as a tool"

This reverts commit 9616d5e2d2ab0d61e8454b1ace057ec9712e182d.

* use go_run_tool to run goimports

* inline go_run_tool

* include required env var REPO_ROOT_DIR
2020-06-08 13:40:32 -07:00
.github correct typo in pull request template (#826) 2020-05-05 09:11:44 -07:00
cmd/kn remove use of os.Exit (#851) 2020-05-25 22:12:48 -07:00
config Use ko's strict mode for better errors messages (#706) 2020-03-07 12:11:27 -08:00
conventions [master] Format markdown (#833) 2020-05-11 17:22:47 -07:00
docs Update flag names to --request and --limit (#872) 2020-06-03 04:04:18 -07:00
hack Update go.mod to specify the module is go1.14 (#866) 2020-06-08 13:40:32 -07:00
lib/test Add --requests and --limits resource flags (#859) 2020-05-28 01:45:59 -07:00
pkg chore: Move from Eventing v1alpha1 to v1beta1 (#878) 2020-06-08 05:42:19 -07:00
scripts/test-infra chore: Move from Eventing v1alpha1 to v1beta1 (#878) 2020-06-08 05:42:19 -07:00
test update test-infra to stop using serving.yaml (#876) 2020-06-04 23:32:18 -07:00
vendor Update go.mod to specify the module is go1.14 (#866) 2020-06-08 13:40:32 -07:00
.gitignore Explicit name for serving client (#537) 2019-12-08 23:42:44 -08:00
CHANGELOG.adoc Update flag names to --request and --limit (#872) 2020-06-03 04:04:18 -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 Add badges in README (#780) 2020-04-07 16:26:00 -07:00
go.mod Update go.mod to specify the module is go1.14 (#866) 2020-06-08 13:40:32 -07:00
go.sum chore: Move from Eventing v1alpha1 to v1beta1 (#878) 2020-06-08 05:42:19 -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 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.