diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 3f1e3161ef..2e7bf185b2 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -34,6 +34,10 @@ | Add "--annotation-service" and "--annotation-revision" to kn service create/update | https://github.com/knative/client/pull/1029[#1029] +| 🎁 +| Add alias to commands +| https://github.com/knative/client/pull/1041[#1041] + |=== ## v0.17.0 (2020-08-26) diff --git a/docs/cmd/kn.md b/docs/cmd/kn.md index f00dd7e35c..f5ccb1b36d 100644 --- a/docs/cmd/kn.md +++ b/docs/cmd/kn.md @@ -19,16 +19,16 @@ kn is the command line interface for managing Knative Serving and Eventing resou ### SEE ALSO -* [kn broker](kn_broker.md) - Manage message broker -* [kn channel](kn_channel.md) - Manage event channels +* [kn broker](kn_broker.md) - Manage message broker (alias: brokers) +* [kn channel](kn_channel.md) - Manage event channels (alias: channels) * [kn completion](kn_completion.md) - Output shell completion code * [kn options](kn_options.md) - Print the list of flags inherited by all commands -* [kn plugin](kn_plugin.md) - Manage kn plugins -* [kn revision](kn_revision.md) - Manage service revisions -* [kn route](kn_route.md) - List and describe service routes -* [kn service](kn_service.md) - Manage Knative services -* [kn source](kn_source.md) - Manage event sources -* [kn subscription](kn_subscription.md) - Manage event subscriptions -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn plugin](kn_plugin.md) - Manage kn plugins (alias: plugins) +* [kn revision](kn_revision.md) - Manage service revisions (alias: revisions) +* [kn route](kn_route.md) - List and describe service routes (alias: routes) +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) +* [kn source](kn_source.md) - Manage event sources (alias: sources) +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) * [kn version](kn_version.md) - Show the version of this client diff --git a/docs/cmd/kn_broker.md b/docs/cmd/kn_broker.md index 104788dbd7..95ba221bbc 100644 --- a/docs/cmd/kn_broker.md +++ b/docs/cmd/kn_broker.md @@ -1,10 +1,10 @@ ## kn broker -Manage message broker +Manage message broker (alias: brokers) ### Synopsis -Manage message broker +Manage message broker (alias: brokers) ``` kn broker @@ -30,5 +30,5 @@ kn broker * [kn broker create](kn_broker_create.md) - Create a broker * [kn broker delete](kn_broker_delete.md) - Delete a broker * [kn broker describe](kn_broker_describe.md) - Describe broker -* [kn broker list](kn_broker_list.md) - List brokers +* [kn broker list](kn_broker_list.md) - List brokers (alias: 'ls') diff --git a/docs/cmd/kn_broker_create.md b/docs/cmd/kn_broker_create.md index fdee69d156..f78f09e878 100644 --- a/docs/cmd/kn_broker_create.md +++ b/docs/cmd/kn_broker_create.md @@ -38,5 +38,5 @@ kn broker create NAME ### SEE ALSO -* [kn broker](kn_broker.md) - Manage message broker +* [kn broker](kn_broker.md) - Manage message broker (alias: brokers) diff --git a/docs/cmd/kn_broker_delete.md b/docs/cmd/kn_broker_delete.md index 67b1c7f659..bc437cb8b8 100644 --- a/docs/cmd/kn_broker_delete.md +++ b/docs/cmd/kn_broker_delete.md @@ -42,5 +42,5 @@ kn broker delete NAME ### SEE ALSO -* [kn broker](kn_broker.md) - Manage message broker +* [kn broker](kn_broker.md) - Manage message broker (alias: brokers) diff --git a/docs/cmd/kn_broker_describe.md b/docs/cmd/kn_broker_describe.md index 808bcf0071..439be0cd7a 100644 --- a/docs/cmd/kn_broker_describe.md +++ b/docs/cmd/kn_broker_describe.md @@ -38,5 +38,5 @@ kn broker describe NAME ### SEE ALSO -* [kn broker](kn_broker.md) - Manage message broker +* [kn broker](kn_broker.md) - Manage message broker (alias: brokers) diff --git a/docs/cmd/kn_broker_list.md b/docs/cmd/kn_broker_list.md index 506de7ee61..230dd3d902 100644 --- a/docs/cmd/kn_broker_list.md +++ b/docs/cmd/kn_broker_list.md @@ -1,10 +1,10 @@ ## kn broker list -List brokers +List brokers (alias: 'ls') ### Synopsis -List brokers +List brokers (alias: 'ls') ``` kn broker list @@ -43,5 +43,5 @@ kn broker list ### SEE ALSO -* [kn broker](kn_broker.md) - Manage message broker +* [kn broker](kn_broker.md) - Manage message broker (alias: brokers) diff --git a/docs/cmd/kn_channel.md b/docs/cmd/kn_channel.md index 41e69096ad..9d6f3ba570 100644 --- a/docs/cmd/kn_channel.md +++ b/docs/cmd/kn_channel.md @@ -1,10 +1,10 @@ ## kn channel -Manage event channels +Manage event channels (alias: channels) ### Synopsis -Manage event channels +Manage event channels (alias: channels) ``` kn channel COMMAND @@ -30,5 +30,5 @@ kn channel COMMAND * [kn channel create](kn_channel_create.md) - Create an event channel * [kn channel delete](kn_channel_delete.md) - Delete a channel * [kn channel describe](kn_channel_describe.md) - Show details of a channel -* [kn channel list](kn_channel_list.md) - List channels +* [kn channel list](kn_channel_list.md) - List channels (alias: 'ls') diff --git a/docs/cmd/kn_channel_create.md b/docs/cmd/kn_channel_create.md index f22febe4f7..1dd0251729 100644 --- a/docs/cmd/kn_channel_create.md +++ b/docs/cmd/kn_channel_create.md @@ -44,5 +44,5 @@ kn channel create NAME ### SEE ALSO -* [kn channel](kn_channel.md) - Manage event channels +* [kn channel](kn_channel.md) - Manage event channels (alias: channels) diff --git a/docs/cmd/kn_channel_delete.md b/docs/cmd/kn_channel_delete.md index 78e8110ee0..2e16fb2068 100644 --- a/docs/cmd/kn_channel_delete.md +++ b/docs/cmd/kn_channel_delete.md @@ -35,5 +35,5 @@ kn channel delete NAME ### SEE ALSO -* [kn channel](kn_channel.md) - Manage event channels +* [kn channel](kn_channel.md) - Manage event channels (alias: channels) diff --git a/docs/cmd/kn_channel_describe.md b/docs/cmd/kn_channel_describe.md index 88df50d168..bc4eb02543 100644 --- a/docs/cmd/kn_channel_describe.md +++ b/docs/cmd/kn_channel_describe.md @@ -39,5 +39,5 @@ kn channel describe NAME ### SEE ALSO -* [kn channel](kn_channel.md) - Manage event channels +* [kn channel](kn_channel.md) - Manage event channels (alias: channels) diff --git a/docs/cmd/kn_channel_list.md b/docs/cmd/kn_channel_list.md index 646f663f34..cd37c02278 100644 --- a/docs/cmd/kn_channel_list.md +++ b/docs/cmd/kn_channel_list.md @@ -1,10 +1,10 @@ ## kn channel list -List channels +List channels (alias: 'ls') ### Synopsis -List channels +List channels (alias: 'ls') ``` kn channel list @@ -43,5 +43,5 @@ kn channel list ### SEE ALSO -* [kn channel](kn_channel.md) - Manage event channels +* [kn channel](kn_channel.md) - Manage event channels (alias: channels) diff --git a/docs/cmd/kn_plugin.md b/docs/cmd/kn_plugin.md index ead701a002..02dae39a3e 100644 --- a/docs/cmd/kn_plugin.md +++ b/docs/cmd/kn_plugin.md @@ -1,6 +1,6 @@ ## kn plugin -Manage kn plugins +Manage kn plugins (alias: plugins) ### Synopsis @@ -30,5 +30,5 @@ kn plugin ### SEE ALSO * [kn](kn.md) - kn manages Knative Serving and Eventing resources -* [kn plugin list](kn_plugin_list.md) - List plugins +* [kn plugin list](kn_plugin_list.md) - List plugins (alias: 'ls') diff --git a/docs/cmd/kn_plugin_list.md b/docs/cmd/kn_plugin_list.md index 28009fb524..201e024774 100644 --- a/docs/cmd/kn_plugin_list.md +++ b/docs/cmd/kn_plugin_list.md @@ -1,6 +1,6 @@ ## kn plugin list -List plugins +List plugins (alias: 'ls') ### Synopsis @@ -33,5 +33,5 @@ kn plugin list ### SEE ALSO -* [kn plugin](kn_plugin.md) - Manage kn plugins +* [kn plugin](kn_plugin.md) - Manage kn plugins (alias: plugins) diff --git a/docs/cmd/kn_revision.md b/docs/cmd/kn_revision.md index d07e70aeb9..35c4758777 100644 --- a/docs/cmd/kn_revision.md +++ b/docs/cmd/kn_revision.md @@ -1,10 +1,10 @@ ## kn revision -Manage service revisions +Manage service revisions (alias: revisions) ### Synopsis -Manage service revisions +Manage service revisions (alias: revisions) ``` kn revision @@ -29,5 +29,5 @@ kn revision * [kn](kn.md) - kn manages Knative Serving and Eventing resources * [kn revision delete](kn_revision_delete.md) - Delete revisions * [kn revision describe](kn_revision_describe.md) - Show details of a revision -* [kn revision list](kn_revision_list.md) - List revisions +* [kn revision list](kn_revision_list.md) - List revisions (alias: 'ls') diff --git a/docs/cmd/kn_revision_delete.md b/docs/cmd/kn_revision_delete.md index 8f4776498b..82d466bf37 100644 --- a/docs/cmd/kn_revision_delete.md +++ b/docs/cmd/kn_revision_delete.md @@ -39,5 +39,5 @@ kn revision delete NAME [NAME ...] ### SEE ALSO -* [kn revision](kn_revision.md) - Manage service revisions +* [kn revision](kn_revision.md) - Manage service revisions (alias: revisions) diff --git a/docs/cmd/kn_revision_describe.md b/docs/cmd/kn_revision_describe.md index c997b0fda3..881ab910e1 100644 --- a/docs/cmd/kn_revision_describe.md +++ b/docs/cmd/kn_revision_describe.md @@ -31,5 +31,5 @@ kn revision describe NAME ### SEE ALSO -* [kn revision](kn_revision.md) - Manage service revisions +* [kn revision](kn_revision.md) - Manage service revisions (alias: revisions) diff --git a/docs/cmd/kn_revision_list.md b/docs/cmd/kn_revision_list.md index 2764c26198..1def77967c 100644 --- a/docs/cmd/kn_revision_list.md +++ b/docs/cmd/kn_revision_list.md @@ -1,6 +1,6 @@ ## kn revision list -List revisions +List revisions (alias: 'ls') ### Synopsis @@ -50,5 +50,5 @@ kn revision list ### SEE ALSO -* [kn revision](kn_revision.md) - Manage service revisions +* [kn revision](kn_revision.md) - Manage service revisions (alias: revisions) diff --git a/docs/cmd/kn_route.md b/docs/cmd/kn_route.md index 1e9e377568..42c1d5c0a1 100644 --- a/docs/cmd/kn_route.md +++ b/docs/cmd/kn_route.md @@ -1,10 +1,10 @@ ## kn route -List and describe service routes +List and describe service routes (alias: routes) ### Synopsis -List and describe service routes +List and describe service routes (alias: routes) ``` kn route @@ -28,5 +28,5 @@ kn route * [kn](kn.md) - kn manages Knative Serving and Eventing resources * [kn route describe](kn_route_describe.md) - Show details of a route -* [kn route list](kn_route_list.md) - List routes +* [kn route list](kn_route_list.md) - List routes (alias: 'ls') diff --git a/docs/cmd/kn_route_describe.md b/docs/cmd/kn_route_describe.md index dcfb3a5768..e64e282f44 100644 --- a/docs/cmd/kn_route_describe.md +++ b/docs/cmd/kn_route_describe.md @@ -31,5 +31,5 @@ kn route describe NAME ### SEE ALSO -* [kn route](kn_route.md) - List and describe service routes +* [kn route](kn_route.md) - List and describe service routes (alias: routes) diff --git a/docs/cmd/kn_route_list.md b/docs/cmd/kn_route_list.md index b5f62285a6..6efc225a2e 100644 --- a/docs/cmd/kn_route_list.md +++ b/docs/cmd/kn_route_list.md @@ -1,10 +1,10 @@ ## kn route list -List routes +List routes (alias: 'ls') ### Synopsis -List routes +List routes (alias: 'ls') ``` kn route list NAME @@ -46,5 +46,5 @@ kn route list NAME ### SEE ALSO -* [kn route](kn_route.md) - List and describe service routes +* [kn route](kn_route.md) - List and describe service routes (alias: routes) diff --git a/docs/cmd/kn_service.md b/docs/cmd/kn_service.md index 7243d7e9dd..a00f1c11af 100644 --- a/docs/cmd/kn_service.md +++ b/docs/cmd/kn_service.md @@ -1,10 +1,10 @@ ## kn service -Manage Knative services +Manage Knative services (aliases: ksvc, services) ### Synopsis -Manage Knative services +Manage Knative services (aliases: ksvc, services) ``` kn service @@ -31,6 +31,6 @@ kn service * [kn service delete](kn_service_delete.md) - Delete services * [kn service describe](kn_service_describe.md) - Show details of a service * [kn service export](kn_service_export.md) - Export a service and its revisions -* [kn service list](kn_service_list.md) - List services +* [kn service list](kn_service_list.md) - List services (alias: 'ls') * [kn service update](kn_service_update.md) - Update a service diff --git a/docs/cmd/kn_service_create.md b/docs/cmd/kn_service_create.md index 8441f158ae..a4f9b46019 100644 --- a/docs/cmd/kn_service_create.md +++ b/docs/cmd/kn_service_create.md @@ -109,5 +109,5 @@ kn service create NAME --image IMAGE ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_service_delete.md b/docs/cmd/kn_service_delete.md index aa492868ed..4fa0db2b17 100644 --- a/docs/cmd/kn_service_delete.md +++ b/docs/cmd/kn_service_delete.md @@ -46,5 +46,5 @@ kn service delete NAME [NAME ...] ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_service_describe.md b/docs/cmd/kn_service_describe.md index 41f81ecc88..3cb4f1d614 100644 --- a/docs/cmd/kn_service_describe.md +++ b/docs/cmd/kn_service_describe.md @@ -45,5 +45,5 @@ kn service describe NAME ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_service_export.md b/docs/cmd/kn_service_export.md index de0ab5dcd8..87a9bb47bb 100644 --- a/docs/cmd/kn_service_export.md +++ b/docs/cmd/kn_service_export.md @@ -49,5 +49,5 @@ kn service export NAME ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_service_list.md b/docs/cmd/kn_service_list.md index 70fdc12de5..bb087b9e04 100644 --- a/docs/cmd/kn_service_list.md +++ b/docs/cmd/kn_service_list.md @@ -1,10 +1,10 @@ ## kn service list -List services +List services (alias: 'ls') ### Synopsis -List services +List services (alias: 'ls') ``` kn service list @@ -46,5 +46,5 @@ kn service list ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_service_update.md b/docs/cmd/kn_service_update.md index 0633a4e391..7f231ba570 100644 --- a/docs/cmd/kn_service_update.md +++ b/docs/cmd/kn_service_update.md @@ -95,5 +95,5 @@ kn service update NAME ### SEE ALSO -* [kn service](kn_service.md) - Manage Knative services +* [kn service](kn_service.md) - Manage Knative services (aliases: ksvc, services) diff --git a/docs/cmd/kn_source.md b/docs/cmd/kn_source.md index 8eece17416..cd74472535 100644 --- a/docs/cmd/kn_source.md +++ b/docs/cmd/kn_source.md @@ -1,10 +1,10 @@ ## kn source -Manage event sources +Manage event sources (alias: sources) ### Synopsis -Manage event sources +Manage event sources (alias: sources) ``` kn source SOURCE|COMMAND @@ -29,7 +29,7 @@ kn source SOURCE|COMMAND * [kn](kn.md) - kn manages Knative Serving and Eventing resources * [kn source apiserver](kn_source_apiserver.md) - Manage Kubernetes api-server sources * [kn source binding](kn_source_binding.md) - Manage sink bindings -* [kn source list](kn_source_list.md) - List event sources +* [kn source list](kn_source_list.md) - List event sources (alias: 'ls') * [kn source list-types](kn_source_list-types.md) - List event source types * [kn source ping](kn_source_ping.md) - Manage ping sources diff --git a/docs/cmd/kn_source_apiserver.md b/docs/cmd/kn_source_apiserver.md index 8d3db4baf2..3fd70a0007 100644 --- a/docs/cmd/kn_source_apiserver.md +++ b/docs/cmd/kn_source_apiserver.md @@ -26,7 +26,7 @@ kn source apiserver COMMAND ### SEE ALSO -* [kn source](kn_source.md) - Manage event sources +* [kn source](kn_source.md) - Manage event sources (alias: sources) * [kn source apiserver create](kn_source_apiserver_create.md) - Create an api-server source * [kn source apiserver delete](kn_source_apiserver_delete.md) - Delete an api-server source * [kn source apiserver describe](kn_source_apiserver_describe.md) - Show details of an api-server source diff --git a/docs/cmd/kn_source_binding.md b/docs/cmd/kn_source_binding.md index 0205448724..ee32cd34dc 100644 --- a/docs/cmd/kn_source_binding.md +++ b/docs/cmd/kn_source_binding.md @@ -26,7 +26,7 @@ kn source binding COMMAND ### SEE ALSO -* [kn source](kn_source.md) - Manage event sources +* [kn source](kn_source.md) - Manage event sources (alias: sources) * [kn source binding create](kn_source_binding_create.md) - Create a sink binding * [kn source binding delete](kn_source_binding_delete.md) - Delete a sink binding * [kn source binding describe](kn_source_binding_describe.md) - Show details of a sink binding diff --git a/docs/cmd/kn_source_list-types.md b/docs/cmd/kn_source_list-types.md index a4a52c0765..2d86b197b7 100644 --- a/docs/cmd/kn_source_list-types.md +++ b/docs/cmd/kn_source_list-types.md @@ -42,5 +42,5 @@ kn source list-types ### SEE ALSO -* [kn source](kn_source.md) - Manage event sources +* [kn source](kn_source.md) - Manage event sources (alias: sources) diff --git a/docs/cmd/kn_source_list.md b/docs/cmd/kn_source_list.md index 8053e9c41d..630c2cdf2f 100644 --- a/docs/cmd/kn_source_list.md +++ b/docs/cmd/kn_source_list.md @@ -1,10 +1,10 @@ ## kn source list -List event sources +List event sources (alias: 'ls') ### Synopsis -List event sources +List event sources (alias: 'ls') ``` kn source list @@ -47,5 +47,5 @@ kn source list ### SEE ALSO -* [kn source](kn_source.md) - Manage event sources +* [kn source](kn_source.md) - Manage event sources (alias: sources) diff --git a/docs/cmd/kn_source_ping.md b/docs/cmd/kn_source_ping.md index fc9649782d..8c3e4b4699 100644 --- a/docs/cmd/kn_source_ping.md +++ b/docs/cmd/kn_source_ping.md @@ -26,7 +26,7 @@ kn source ping COMMAND ### SEE ALSO -* [kn source](kn_source.md) - Manage event sources +* [kn source](kn_source.md) - Manage event sources (alias: sources) * [kn source ping create](kn_source_ping_create.md) - Create a ping source * [kn source ping delete](kn_source_ping_delete.md) - Delete a ping source * [kn source ping describe](kn_source_ping_describe.md) - Show details of a ping source diff --git a/docs/cmd/kn_subscription.md b/docs/cmd/kn_subscription.md index 640bb9a386..3d0dd1630f 100644 --- a/docs/cmd/kn_subscription.md +++ b/docs/cmd/kn_subscription.md @@ -1,10 +1,10 @@ ## kn subscription -Manage event subscriptions +Manage event subscriptions (aliases: subscriptions, sub) ### Synopsis -Manage event subscriptions +Manage event subscriptions (aliases: subscriptions, sub) ``` kn subscription COMMAND @@ -30,6 +30,6 @@ kn subscription COMMAND * [kn subscription create](kn_subscription_create.md) - Create a subscription * [kn subscription delete](kn_subscription_delete.md) - Delete a subscription * [kn subscription describe](kn_subscription_describe.md) - Show details of a subscription -* [kn subscription list](kn_subscription_list.md) - List subscriptions +* [kn subscription list](kn_subscription_list.md) - List subscriptions (alias: 'ls') * [kn subscription update](kn_subscription_update.md) - Update an event subscription diff --git a/docs/cmd/kn_subscription_create.md b/docs/cmd/kn_subscription_create.md index a36fcc46f6..b18ba33287 100644 --- a/docs/cmd/kn_subscription_create.md +++ b/docs/cmd/kn_subscription_create.md @@ -42,5 +42,5 @@ kn subscription create NAME ### SEE ALSO -* [kn subscription](kn_subscription.md) - Manage event subscriptions +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) diff --git a/docs/cmd/kn_subscription_delete.md b/docs/cmd/kn_subscription_delete.md index c173f3aaae..705611548e 100644 --- a/docs/cmd/kn_subscription_delete.md +++ b/docs/cmd/kn_subscription_delete.md @@ -35,5 +35,5 @@ kn subscription delete NAME ### SEE ALSO -* [kn subscription](kn_subscription.md) - Manage event subscriptions +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) diff --git a/docs/cmd/kn_subscription_describe.md b/docs/cmd/kn_subscription_describe.md index e04c01de19..8ba254a25d 100644 --- a/docs/cmd/kn_subscription_describe.md +++ b/docs/cmd/kn_subscription_describe.md @@ -39,5 +39,5 @@ kn subscription describe NAME ### SEE ALSO -* [kn subscription](kn_subscription.md) - Manage event subscriptions +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) diff --git a/docs/cmd/kn_subscription_list.md b/docs/cmd/kn_subscription_list.md index 4aead93ab4..6bbafc2921 100644 --- a/docs/cmd/kn_subscription_list.md +++ b/docs/cmd/kn_subscription_list.md @@ -1,10 +1,10 @@ ## kn subscription list -List subscriptions +List subscriptions (alias: 'ls') ### Synopsis -List subscriptions +List subscriptions (alias: 'ls') ``` kn subscription list @@ -43,5 +43,5 @@ kn subscription list ### SEE ALSO -* [kn subscription](kn_subscription.md) - Manage event subscriptions +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) diff --git a/docs/cmd/kn_subscription_update.md b/docs/cmd/kn_subscription_update.md index 3ce6e6cd75..a884c316e0 100644 --- a/docs/cmd/kn_subscription_update.md +++ b/docs/cmd/kn_subscription_update.md @@ -41,5 +41,5 @@ kn subscription update NAME ### SEE ALSO -* [kn subscription](kn_subscription.md) - Manage event subscriptions +* [kn subscription](kn_subscription.md) - Manage event subscriptions (aliases: subscriptions, sub) diff --git a/docs/cmd/kn_trigger.md b/docs/cmd/kn_trigger.md index 4f82747ce4..f5e70e06d2 100644 --- a/docs/cmd/kn_trigger.md +++ b/docs/cmd/kn_trigger.md @@ -1,10 +1,10 @@ ## kn trigger -Manage event triggers +Manage event triggers (alias: triggers) ### Synopsis -Manage event triggers +Manage event triggers (alias: triggers) ``` kn trigger @@ -30,6 +30,6 @@ kn trigger * [kn trigger create](kn_trigger_create.md) - Create a trigger * [kn trigger delete](kn_trigger_delete.md) - Delete a trigger * [kn trigger describe](kn_trigger_describe.md) - Show details of a trigger -* [kn trigger list](kn_trigger_list.md) - List triggers +* [kn trigger list](kn_trigger_list.md) - List triggers (alias: 'ls') * [kn trigger update](kn_trigger_update.md) - Update a trigger diff --git a/docs/cmd/kn_trigger_create.md b/docs/cmd/kn_trigger_create.md index f9c57ed0a6..2a46592c79 100644 --- a/docs/cmd/kn_trigger_create.md +++ b/docs/cmd/kn_trigger_create.md @@ -42,5 +42,5 @@ kn trigger create NAME --sink SINK ### SEE ALSO -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) diff --git a/docs/cmd/kn_trigger_delete.md b/docs/cmd/kn_trigger_delete.md index 868e94c40d..fd79e4ce1e 100644 --- a/docs/cmd/kn_trigger_delete.md +++ b/docs/cmd/kn_trigger_delete.md @@ -35,5 +35,5 @@ kn trigger delete NAME ### SEE ALSO -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) diff --git a/docs/cmd/kn_trigger_describe.md b/docs/cmd/kn_trigger_describe.md index 6727ef5c3b..9848ec5451 100644 --- a/docs/cmd/kn_trigger_describe.md +++ b/docs/cmd/kn_trigger_describe.md @@ -36,5 +36,5 @@ kn trigger describe NAME ### SEE ALSO -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) diff --git a/docs/cmd/kn_trigger_list.md b/docs/cmd/kn_trigger_list.md index 7bbe298b3e..0daffc6866 100644 --- a/docs/cmd/kn_trigger_list.md +++ b/docs/cmd/kn_trigger_list.md @@ -1,10 +1,10 @@ ## kn trigger list -List triggers +List triggers (alias: 'ls') ### Synopsis -List triggers +List triggers (alias: 'ls') ``` kn trigger list @@ -43,5 +43,5 @@ kn trigger list ### SEE ALSO -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) diff --git a/docs/cmd/kn_trigger_update.md b/docs/cmd/kn_trigger_update.md index 7a609489c4..9f1b6e4bdd 100644 --- a/docs/cmd/kn_trigger_update.md +++ b/docs/cmd/kn_trigger_update.md @@ -46,5 +46,5 @@ kn trigger update NAME ### SEE ALSO -* [kn trigger](kn_trigger.md) - Manage event triggers +* [kn trigger](kn_trigger.md) - Manage event triggers (alias: triggers) diff --git a/pkg/kn/commands/broker/broker.go b/pkg/kn/commands/broker/broker.go index bbb9334915..e8ff3428f9 100644 --- a/pkg/kn/commands/broker/broker.go +++ b/pkg/kn/commands/broker/broker.go @@ -25,8 +25,9 @@ import ( // NewBrokerCommand represents broker management commands func NewBrokerCommand(p *commands.KnParams) *cobra.Command { brokerCmd := &cobra.Command{ - Use: "broker", - Short: "Manage message broker", + Use: "broker", + Short: "Manage message broker (alias: brokers)", + Aliases: []string{"brokers"}, } brokerCmd.AddCommand(NewBrokerCreateCommand(p)) brokerCmd.AddCommand(NewBrokerDescribeCommand(p)) diff --git a/pkg/kn/commands/broker/list.go b/pkg/kn/commands/broker/list.go index a4418187c1..fb90d0adfc 100644 --- a/pkg/kn/commands/broker/list.go +++ b/pkg/kn/commands/broker/list.go @@ -43,7 +43,8 @@ func NewBrokerListCommand(p *commands.KnParams) *cobra.Command { cmd := &cobra.Command{ Use: "list", - Short: "List brokers", + Short: "List brokers (alias: 'ls')", + Aliases: []string{"ls"}, Example: listExample, RunE: func(cmd *cobra.Command, args []string) (err error) { namespace, err := p.GetNamespace(cmd) diff --git a/pkg/kn/commands/channel/channel.go b/pkg/kn/commands/channel/channel.go index be324754da..6d01829928 100644 --- a/pkg/kn/commands/channel/channel.go +++ b/pkg/kn/commands/channel/channel.go @@ -27,8 +27,9 @@ import ( // NewChannelCommand to manage event channels func NewChannelCommand(p *commands.KnParams) *cobra.Command { channelCmd := &cobra.Command{ - Use: "channel COMMAND", - Short: "Manage event channels", + Use: "channel COMMAND", + Short: "Manage event channels (alias: channels)", + Aliases: []string{"channels"}, } channelCmd.AddCommand(NewChannelCreateCommand(p)) channelCmd.AddCommand(NewChannelListCommand(p)) diff --git a/pkg/kn/commands/channel/list.go b/pkg/kn/commands/channel/list.go index 0d4466dbeb..a8f994fae7 100644 --- a/pkg/kn/commands/channel/list.go +++ b/pkg/kn/commands/channel/list.go @@ -28,8 +28,9 @@ func NewChannelListCommand(p *commands.KnParams) *cobra.Command { listFlags := flags.NewListPrintFlags(ListHandlers) listCommand := &cobra.Command{ - Use: "list", - Short: "List channels", + Use: "list", + Short: "List channels (alias: 'ls')", + Aliases: []string{"ls"}, Example: ` # List all channels kn channel list diff --git a/pkg/kn/commands/plugin/list.go b/pkg/kn/commands/plugin/list.go index 153a8f5a08..4d78b41f2f 100644 --- a/pkg/kn/commands/plugin/list.go +++ b/pkg/kn/commands/plugin/list.go @@ -40,8 +40,9 @@ func NewPluginListCommand(p *commands.KnParams) *cobra.Command { plFlags := pluginListFlags{} pluginListCommand := &cobra.Command{ - Use: "list", - Short: "List plugins", + Use: "list", + Short: "List plugins (alias: 'ls')", + Aliases: []string{"ls"}, Long: `List all installed plugins. Available plugins are those that are: diff --git a/pkg/kn/commands/plugin/list_test.go b/pkg/kn/commands/plugin/list_test.go index 3624800ed6..a6da754d9e 100644 --- a/pkg/kn/commands/plugin/list_test.go +++ b/pkg/kn/commands/plugin/list_test.go @@ -39,7 +39,7 @@ func TestPluginListBasic(t *testing.T) { } assert.Assert(t, pluginListCmd.Use == "list") - assert.Assert(t, pluginListCmd.Short == "List plugins") + assert.Assert(t, pluginListCmd.Short == "List plugins (alias: 'ls')") assert.Assert(t, strings.Contains(pluginListCmd.Long, "List all installed plugins")) assert.Assert(t, pluginListCmd.RunE != nil) } diff --git a/pkg/kn/commands/plugin/plugin.go b/pkg/kn/commands/plugin/plugin.go index 4a82598366..d4189884a2 100644 --- a/pkg/kn/commands/plugin/plugin.go +++ b/pkg/kn/commands/plugin/plugin.go @@ -22,8 +22,9 @@ import ( func NewPluginCommand(p *commands.KnParams) *cobra.Command { pluginCmd := &cobra.Command{ - Use: "plugin", - Short: "Manage kn plugins", + Use: "plugin", + Short: "Manage kn plugins (alias: plugins)", + Aliases: []string{"plugins"}, Long: `Manage kn plugins Plugins provide extended functionality that is not part of the core kn command-line distribution. diff --git a/pkg/kn/commands/revision/list.go b/pkg/kn/commands/revision/list.go index 5fd57e6f30..7a6864d14c 100644 --- a/pkg/kn/commands/revision/list.go +++ b/pkg/kn/commands/revision/list.go @@ -38,9 +38,10 @@ func NewRevisionListCommand(p *commands.KnParams) *cobra.Command { revisionListFlags := flags.NewListPrintFlags(RevisionListHandlers) revisionListCommand := &cobra.Command{ - Use: "list", - Short: "List revisions", - Long: "List revisions for a given service.", + Use: "list", + Short: "List revisions (alias: 'ls')", + Aliases: []string{"ls"}, + Long: "List revisions for a given service.", Example: ` # List all revisions kn revision list diff --git a/pkg/kn/commands/revision/revision.go b/pkg/kn/commands/revision/revision.go index c7c2fc32ff..0880da1df6 100644 --- a/pkg/kn/commands/revision/revision.go +++ b/pkg/kn/commands/revision/revision.go @@ -23,8 +23,9 @@ import ( func NewRevisionCommand(p *commands.KnParams) *cobra.Command { revisionCmd := &cobra.Command{ - Use: "revision", - Short: "Manage service revisions", + Use: "revision", + Short: "Manage service revisions (alias: revisions)", + Aliases: []string{"revisions"}, } revisionCmd.AddCommand(NewRevisionListCommand(p)) revisionCmd.AddCommand(NewRevisionDescribeCommand(p)) diff --git a/pkg/kn/commands/route/list.go b/pkg/kn/commands/route/list.go index 9db68b5f88..622cd2878c 100644 --- a/pkg/kn/commands/route/list.go +++ b/pkg/kn/commands/route/list.go @@ -31,8 +31,9 @@ import ( func NewRouteListCommand(p *commands.KnParams) *cobra.Command { routeListFlags := flags.NewListPrintFlags(RouteListHandlers) routeListCommand := &cobra.Command{ - Use: "list NAME", - Short: "List routes", + Use: "list NAME", + Short: "List routes (alias: 'ls')", + Aliases: []string{"ls"}, Example: ` # List all routes kn route list diff --git a/pkg/kn/commands/route/route.go b/pkg/kn/commands/route/route.go index e1a4a24a0e..c10e4b90ad 100644 --- a/pkg/kn/commands/route/route.go +++ b/pkg/kn/commands/route/route.go @@ -22,8 +22,9 @@ import ( func NewRouteCommand(p *commands.KnParams) *cobra.Command { routeCmd := &cobra.Command{ - Use: "route", - Short: "List and describe service routes", + Use: "route", + Short: "List and describe service routes (alias: routes)", + Aliases: []string{"routes"}, } routeCmd.AddCommand(NewRouteListCommand(p)) routeCmd.AddCommand(NewRouteDescribeCommand(p)) diff --git a/pkg/kn/commands/service/list.go b/pkg/kn/commands/service/list.go index ff300304a1..904d8d842e 100644 --- a/pkg/kn/commands/service/list.go +++ b/pkg/kn/commands/service/list.go @@ -31,8 +31,9 @@ func NewServiceListCommand(p *commands.KnParams) *cobra.Command { serviceListFlags := flags.NewListPrintFlags(ServiceListHandlers) serviceListCommand := &cobra.Command{ - Use: "list", - Short: "List services", + Use: "list", + Short: "List services (alias: 'ls')", + Aliases: []string{"ls"}, Example: ` # List all services kn service list diff --git a/pkg/kn/commands/service/list_mock_test.go b/pkg/kn/commands/service/list_mock_test.go index c3ec42b994..1d91cb643f 100644 --- a/pkg/kn/commands/service/list_mock_test.go +++ b/pkg/kn/commands/service/list_mock_test.go @@ -168,6 +168,19 @@ func TestServiceListWithTwoSrvNameMock(t *testing.T) { r.Validate() } +func TestServiceListWithTwoSrvNameAliasMock(t *testing.T) { + // New mock client + client := clientservingv1.NewMockKnServiceClient(t) + + // Recording: + r := client.Recorder() + + _, err := executeServiceCommand(client, "ls", "foo", "bar") + assert.ErrorContains(t, err, "'kn service list' accepts maximum 1 argument") + + r.Validate() +} + func getServiceWithNamespace(name, namespace string) *servingv1.Service { service := servingv1.Service{} service.Name = name diff --git a/pkg/kn/commands/service/list_test.go b/pkg/kn/commands/service/list_test.go index 43b46b4a4c..eedf89e03b 100644 --- a/pkg/kn/commands/service/list_test.go +++ b/pkg/kn/commands/service/list_test.go @@ -146,6 +146,24 @@ func TestServiceGetWithTwoSrvName(t *testing.T) { _, _, err := fakeServiceList([]string{"service", "list", "foo", "bar"}, serviceList) assert.ErrorContains(t, err, "'kn service list' accepts maximum 1 argument") } +func TestServiceListWithAlias(t *testing.T) { + service1 := createMockServiceWithParams("foo", "default", "http://foo.default.example.com", "foo-xyz") + service3 := createMockServiceWithParams("sss", "default", "http://sss.default.example.com", "sss-xyz") + service2 := createMockServiceWithParams("bar", "default", "http://bar.default.example.com", "bar-xyz") + serviceList := &servingv1.ServiceList{Items: []servingv1.Service{*service1, *service2, *service3}} + action, output, err := fakeServiceList([]string{"service", "ls"}, serviceList) + assert.NilError(t, err) + if action == nil { + t.Errorf("No action") + } else if !action.Matches("list", "services") { + t.Errorf("Bad action %v", action) + } + // Outputs in alphabetical order + assert.Check(t, util.ContainsAll(output[0], "NAME", "URL", "LATEST", "AGE", "CONDITIONS", "READY", "REASON")) + assert.Check(t, util.ContainsAll(output[1], "bar", "bar.default.example.com", "bar-xyz")) + assert.Check(t, util.ContainsAll(output[2], "foo", "foo.default.example.com", "foo-xyz")) + assert.Check(t, util.ContainsAll(output[3], "sss", "sss.default.example.com", "sss-xyz")) +} func createMockServiceWithParams(name, namespace, urlS string, revision string) *servingv1.Service { url, _ := apis.ParseURL(urlS) diff --git a/pkg/kn/commands/service/service.go b/pkg/kn/commands/service/service.go index 1652f65a2b..7bab456187 100644 --- a/pkg/kn/commands/service/service.go +++ b/pkg/kn/commands/service/service.go @@ -33,8 +33,9 @@ const ( func NewServiceCommand(p *commands.KnParams) *cobra.Command { serviceCmd := &cobra.Command{ - Use: "service", - Short: "Manage Knative services", + Use: "service", + Short: "Manage Knative services (aliases: ksvc, services)", + Aliases: []string{"ksvc", "services"}, } serviceCmd.AddCommand(NewServiceListCommand(p)) serviceCmd.AddCommand(NewServiceDescribeCommand(p)) diff --git a/pkg/kn/commands/source/list.go b/pkg/kn/commands/source/list.go index ce29e9dc14..54090ff37a 100644 --- a/pkg/kn/commands/source/list.go +++ b/pkg/kn/commands/source/list.go @@ -43,7 +43,8 @@ func NewListCommand(p *commands.KnParams) *cobra.Command { listFlags := flags.NewListPrintFlags(ListHandlers) listCommand := &cobra.Command{ Use: "list", - Short: "List event sources", + Short: "List event sources (alias: 'ls')", + Aliases: []string{"ls"}, Example: listExample, RunE: func(cmd *cobra.Command, args []string) error { namespace, err := p.GetNamespace(cmd) diff --git a/pkg/kn/commands/source/source.go b/pkg/kn/commands/source/source.go index b3e30c0fc9..5bd94edd82 100644 --- a/pkg/kn/commands/source/source.go +++ b/pkg/kn/commands/source/source.go @@ -25,8 +25,9 @@ import ( func NewSourceCommand(p *commands.KnParams) *cobra.Command { sourceCmd := &cobra.Command{ - Use: "source SOURCE|COMMAND", - Short: "Manage event sources", + Use: "source SOURCE|COMMAND", + Short: "Manage event sources (alias: sources)", + Aliases: []string{"sources"}, } sourceCmd.AddCommand(NewListTypesCommand(p)) sourceCmd.AddCommand(NewListCommand(p)) diff --git a/pkg/kn/commands/subscription/list.go b/pkg/kn/commands/subscription/list.go index 8ee749d23d..16780b0672 100644 --- a/pkg/kn/commands/subscription/list.go +++ b/pkg/kn/commands/subscription/list.go @@ -31,7 +31,7 @@ func NewSubscriptionListCommand(p *commands.KnParams) *cobra.Command { listCommand := &cobra.Command{ Use: "list", - Short: "List subscriptions", + Short: "List subscriptions (alias: 'ls')", Example: ` # List all subscriptions kn subscription list diff --git a/pkg/kn/commands/subscription/subscription.go b/pkg/kn/commands/subscription/subscription.go index ca6bec0cf9..b741d15e71 100644 --- a/pkg/kn/commands/subscription/subscription.go +++ b/pkg/kn/commands/subscription/subscription.go @@ -30,7 +30,7 @@ import ( func NewSubscriptionCommand(p *commands.KnParams) *cobra.Command { subscriptionCmd := &cobra.Command{ Use: "subscription COMMAND", - Short: "Manage event subscriptions", + Short: "Manage event subscriptions (aliases: subscriptions, sub)", Aliases: []string{"subscriptions", "sub"}, } subscriptionCmd.AddCommand(NewSubscriptionCreateCommand(p)) diff --git a/pkg/kn/commands/trigger/list.go b/pkg/kn/commands/trigger/list.go index a237ffd823..4d1f1b78e5 100644 --- a/pkg/kn/commands/trigger/list.go +++ b/pkg/kn/commands/trigger/list.go @@ -28,8 +28,9 @@ func NewTriggerListCommand(p *commands.KnParams) *cobra.Command { triggerListFlags := flags.NewListPrintFlags(TriggerListHandlers) triggerListCommand := &cobra.Command{ - Use: "list", - Short: "List triggers", + Use: "list", + Short: "List triggers (alias: 'ls')", + Aliases: []string{"ls"}, Example: ` # List all triggers kn trigger list diff --git a/pkg/kn/commands/trigger/trigger.go b/pkg/kn/commands/trigger/trigger.go index 683f7de983..26b8478f74 100644 --- a/pkg/kn/commands/trigger/trigger.go +++ b/pkg/kn/commands/trigger/trigger.go @@ -28,8 +28,9 @@ const ( // NewTriggerCommand to create trigger command group func NewTriggerCommand(p *commands.KnParams) *cobra.Command { triggerCmd := &cobra.Command{ - Use: "trigger", - Short: "Manage event triggers", + Use: "trigger", + Short: "Manage event triggers (alias: triggers)", + Aliases: []string{"triggers"}, } triggerCmd.AddCommand(NewTriggerCreateCommand(p)) triggerCmd.AddCommand(NewTriggerUpdateCommand(p)) diff --git a/test/e2e/service_test.go b/test/e2e/service_test.go index db5c65320b..25f5ffe01a 100644 --- a/test/e2e/service_test.go +++ b/test/e2e/service_test.go @@ -147,7 +147,7 @@ func serviceMultipleDelete(r *test.KnRunResultCollector, existService, nonexistS } func serviceUntagTagThatDoesNotExist(r *test.KnRunResultCollector, serviceName string) { - out := r.KnTest().Kn().Run("service", "list", serviceName) + out := r.KnTest().Kn().Run("ksvc", "ls", serviceName) r.AssertNoError(out) assert.Check(r.T(), strings.Contains(out.Stdout, serviceName), "Service "+serviceName+" does not exist for test (but should exist)") @@ -156,17 +156,17 @@ func serviceUntagTagThatDoesNotExist(r *test.KnRunResultCollector, serviceName s } func serviceDeleteAll(r *test.KnRunResultCollector) { - out := r.KnTest().Kn().Run("service", "list") + out := r.KnTest().Kn().Run("services", "ls") r.AssertNoError(out) // Check if services created successfully/available for test. assert.Check(r.T(), !strings.Contains(out.Stdout, "No services found."), "No services created for kn service delete --all e2e (but should exist)") - out = r.KnTest().Kn().Run("service", "delete", "--all") + out = r.KnTest().Kn().Run("services", "delete", "--all") r.AssertNoError(out) // Check if output contains successfully deleted to verify deletion took place. assert.Check(r.T(), strings.Contains(out.Stdout, "successfully deleted"), "Failed to get 'successfully deleted' message") - out = r.KnTest().Kn().Run("service", "list") + out = r.KnTest().Kn().Run("services", "list") r.AssertNoError(out) // Check if no services present after kn service delete --all. assert.Check(r.T(), strings.Contains(out.Stdout, "No services found."), "Failed to show 'No services found' after kn service delete --all")