cli

package

v0.27.2 Latest Latest Go to latest Published: Nov 3, 2026 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/andrewheberle/ssh-ca-client

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func Command() (*cobra.Command, error)
func Execute(ctx context.Context, args []string) error
func GenerateDocs(dir string) error

Constants ¶

View Source

const (
	// DocsDir is the directory the documentation is generated in, relative to
	// this package, which is the working directory for go generate and go test
	DocsDir = "../../../docs"
)

Variables ¶

View Source

var (
	ErrNothingToRevoke        = errors.New("no certificates to revoke")
	ErrRevocationNotConfirmed = errors.New("revocation was not confirmed")
)

View Source

var (
	ErrNoPrivateKey = errors.New("no private key found")
)

Functions ¶

func Command ¶ added in v0.23.0

func Command() (*cobra.Command, error)

Command returns the fully initialised cobra command tree without executing it, for uses such as generating documentation

func Execute ¶

func Execute(ctx context.Context, args []string) error

func GenerateDocs ¶ added in v0.23.0

func GenerateDocs(dir string) error

GenerateDocs writes markdown documentation for each command to dir, replacing any previously generated documentation.

This is only built without the snap tag and on non-Windows platforms, so the documentation covers all commands and their flags.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gendocs Command gendocs generates the markdown documentation for ssh-ca-client-cli into the docs directory of the repository.	Command gendocs generates the markdown documentation for ssh-ca-client-cli into the docs directory of the repository.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL