Documentation
¶
Overview ¶
Copyright © 2020 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright © 2020 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func Execute()
- func LongBeta(long string) string
- func LongDeleteIntro(resource string) string
- func LongDisableIntro(resource string) string
- func LongEnableIntro(resource string) string
- func LongGetIntro(resource string) string
- func LongUpdateIntro(resource string) string
- func LongUpsertIntro(resource string) string
- func RootCmd() *cobra.Command
- func ShortBeta(short string) string
- func ShortCreate(resource string) string
- func ShortDelete(resource string) string
- func ShortDisable(resource string) string
- func ShortEnable(resource string) string
- func ShortGet(resource string) string
- func ShortList(resource string) string
- func ShortUpdate(resource string) string
- func ShortUpsert(resource string) string
Constants ¶
const ( ResourceSource = "source" ResourceConnection = "connection" ResourceDestination = "destination" ResourceTransformation = "transformation" ResourceEvent = "event" ResourceRequest = "request" ResourceAttempt = "attempt" )
Resource names for shared help text (singular form for "a source", "a connection").
const BetaFeedbackSuffix = `
[BETA] This feature is in beta. Please share bugs and feedback via:
https://github.com/hookdeck/hookdeck-cli/issues`
Beta help text for gateway/connection commands. Centralised so the feedback URL and wording stay consistent.
const SuccessCheck = "✔"
SuccessCheck is the checkmark character used in success messages across all commands.
Variables ¶
var Config config.Config
Functions ¶
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func LongBeta ¶ added in v1.8.0
LongBeta appends the beta feedback paragraph to a long description for use in Cobra Long.
func LongDeleteIntro ¶ added in v1.8.0
LongDeleteIntro returns the first sentence for "delete" commands.
func LongDisableIntro ¶ added in v1.8.0
LongDisableIntro returns the first sentence for "disable" commands.
func LongEnableIntro ¶ added in v1.8.0
LongEnableIntro returns the first sentence for "enable" commands.
func LongGetIntro ¶ added in v1.8.0
LongGetIntro returns the first paragraph for "get" commands: "Get detailed information about a specific {resource}.\n\nYou can specify either a {resource} ID or name." Callers append their own Examples block.
func LongUpdateIntro ¶ added in v1.8.0
LongUpdateIntro returns the first sentence for "update" commands.
func LongUpsertIntro ¶ added in v1.8.0
LongUpsertIntro returns the first sentence for "upsert" commands (create or update by name).
func RootCmd ¶ added in v1.8.0
RootCmd returns the root command for use by tools (e.g. generate-reference).
func ShortBeta ¶ added in v1.8.0
ShortBeta appends [BETA] to a short description for use in Cobra Short.
func ShortCreate ¶ added in v1.8.0
func ShortDelete ¶ added in v1.8.0
func ShortDisable ¶ added in v1.8.0
func ShortEnable ¶ added in v1.8.0
func ShortGet ¶ added in v1.8.0
Short help (one line) for common commands. Use when the only difference is the resource name.
func ShortUpdate ¶ added in v1.8.0
func ShortUpsert ¶ added in v1.8.0
Types ¶
This section is empty.
Source Files
¶
- attempt.go
- attempt_get.go
- attempt_list.go
- ci.go
- completion.go
- connection.go
- connection_common.go
- connection_create.go
- connection_delete.go
- connection_disable.go
- connection_enable.go
- connection_get.go
- connection_include.go
- connection_list.go
- connection_pause.go
- connection_unpause.go
- connection_update.go
- connection_upsert.go
- destination.go
- destination_common.go
- destination_count.go
- destination_create.go
- destination_delete.go
- destination_disable.go
- destination_enable.go
- destination_get.go
- destination_list.go
- destination_update.go
- destination_upsert.go
- event.go
- event_cancel.go
- event_get.go
- event_list.go
- event_mute.go
- event_raw_body.go
- event_retry.go
- gateway.go
- helptext.go
- listen.go
- login.go
- logout.go
- metrics.go
- metrics_attempts.go
- metrics_events.go
- metrics_events_by_issue.go
- metrics_pending.go
- metrics_queue_depth.go
- metrics_requests.go
- metrics_transformations.go
- pagination_output.go
- project.go
- project_list.go
- project_use.go
- request.go
- request_events.go
- request_get.go
- request_ignored_events.go
- request_list.go
- request_raw_body.go
- request_retry.go
- root.go
- source.go
- source_common.go
- source_count.go
- source_create.go
- source_delete.go
- source_disable.go
- source_enable.go
- source_get.go
- source_list.go
- source_update.go
- source_upsert.go
- transformation.go
- transformation_count.go
- transformation_create.go
- transformation_delete.go
- transformation_executions.go
- transformation_get.go
- transformation_list.go
- transformation_run.go
- transformation_update.go
- transformation_upsert.go
- version.go
- whoami.go
Directories