Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Description ¶
func Description() string
Description returns the copy for the description of this CLI.
func DocumentationCLI ¶
DocumentationCLI returns the copy for the documentation of this CLI. Takes a writer to determine if the output is a TTY for link rendering.
func DocumentationOrgID ¶
DocumentationOrgID returns the copy for the documentation for obtaining an organization ID. Takes a writer to determine if the output is a TTY for link rendering.
func DocumentationPAT ¶
DocumentationPAT returns the copy for the documentation for obtaining a personal access token. Takes a writer to determine if the output is a TTY for link rendering.
Types ¶
type CencliLink ¶
type CencliLink string
const ( CencliRepo CencliLink = "https://github.com/censys/cencli" CencliDocs CencliLink = "https://docs.censys.com/docs/platform-cli" CensysPATInstructions CencliLink = "https://docs.censys.com/reference/get-started#step-2-create-a-personal-access-token" CensysOrgIDInstructions CencliLink = "https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional" )
func (CencliLink) Render ¶
func (l CencliLink) Render(anchorText string) string
Render returns a terminal-friendly clickable link. This should only be used if the result is being written to a TTY. If no anchor text is provided, the link's URL will be used as the anchor text, with the protocol stripped.
func (CencliLink) String ¶
func (l CencliLink) String() string
Source Files