Knative developer experience, docs, reference Knative CLI implementation
Go to file
Navid Shaikh 8232c9d16b
Upgrade spf13/cobra dep to current master (#944)
* Pin spf13/cobra dep at b95db644ed1c0e183a90d8509ef2f9a5d51cc29b

 which includes the zsh completion fix for https://github.com/spf13/cobra/pull/899
 and remove the fork of cobra with fix in `replace` section of go.mod

* Parse args without invoking a separate command

 Do not define and execute extractCommand before running actual root
 command to parse all the args without flags. This was creating issues
 with completion utils to generate additional shell completion directive.
 Now uses cobra's inbuilt utilities to parse the command args without flags.

* Return error from stripFlags if any

* Update unit tests
2020-07-22 14:46:57 -07:00
.github correct typo in pull request template (#826) 2020-05-05 09:11:44 -07:00
cmd/kn Upgrade spf13/cobra dep to current master (#944) 2020-07-22 14:46:57 -07:00
config Use ko's strict mode for better errors messages (#706) 2020-03-07 12:11:27 -08:00
conventions Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
docs feat: Add support to combine service create --filename with other options (#937) 2020-07-21 06:05:35 -07:00
hack Track floating deps at master (#932) 2020-07-15 07:42:32 -07:00
lib/test kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
pkg feat: Add support to combine service create --filename with other options (#937) 2020-07-21 06:05:35 -07:00
scripts/test-infra Track floating deps at master (#932) 2020-07-15 07:42:32 -07:00
test feat: Add plugin listing to "kn --help" (#929) 2020-07-14 13:38:33 -07:00
third_party/VENDOR-LICENSE Track floating deps at master (#932) 2020-07-15 07:42:32 -07:00
vendor Upgrade spf13/cobra dep to current master (#944) 2020-07-22 14:46:57 -07:00
.gitignore Explicit name for serving client (#537) 2019-12-08 23:42:44 -08:00
CHANGELOG.adoc feat: Add support to combine service create --filename with other options (#937) 2020-07-21 06:05:35 -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(docs): Fix tekton task link in README (#934) 2020-07-15 05:59:32 -07:00
go.mod Upgrade spf13/cobra dep to current master (#944) 2020-07-22 14:46:57 -07:00
go.sum Upgrade spf13/cobra dep to current master (#944) 2020-07-22 14:46:57 -07:00
users.htpasswd Track floating deps at master (#932) 2020-07-15 07:42:32 -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.