cli

Documentation

Overview

Package cli implements the commandline interface using https://github.com/spf13/cobra.

Index

• Variables
• func AddDecryptCommand(parent *cobra.Command) *cobra.Command
• func AddDocsGenCommand(root *cobra.Command) *cobra.Command
• func AddEncryptCommand(parent *cobra.Command) *cobra.Command
• func AddKeygenCommand(parent *cobra.Command) *cobra.Command
• func AddPubkeyCommand(parent *cobra.Command) *cobra.Command
• func Execute()

Variables

var AddPbkdfCommand = func(c *cobra.Command) *cobra.Command {
	return c
}

Placeholder that is maybe overwritten in pbkdf.go init() if pbkdf build tag given

var RootCommand = &cobra.Command{
	Use: "aenker",
	Long: `Aenker is a tool to encrypt files with an authenticated integrated encryption
scheme by chunking the input into equal parts and sealing them with a key
derived from an anonymous Diffie-Hellman key exchange on an elliptic curve.

Many parties can encrypt files for a single recipient by distributing that
recipient's public key, while only the recipient can decrypt any of those files
afterwards.`,
}

RootCommand is the root cobra command to be executed with Execute().

Functions

func AddDecryptCommand

func AddDecryptCommand(parent *cobra.Command) *cobra.Command

AddDecryptCommand adds the decryption subcommand to a cobra command.

func AddDocsGenCommand

func AddDocsGenCommand(root *cobra.Command) *cobra.Command

AddDocsGenCommand adds the manuals and autocompletion generator subcommands to a cobra command.

It can be disabled by building with the tag 'nodocs' to save some space.

func AddEncryptCommand

func AddEncryptCommand(parent *cobra.Command) *cobra.Command

AddEncryptCommand adds the encryption subcommand to a cobra command.

func AddKeygenCommand

func AddKeygenCommand(parent *cobra.Command) *cobra.Command

AddKeygenCommand add the key generator and pubkey converter subcommands to a cobra command.

func AddPubkeyCommand

func AddPubkeyCommand(parent *cobra.Command) *cobra.Command

AddPubkeyCommand adds the pubkey converter subcommand to a cobra command.

func Execute

func Execute()

Execute is the main function. It starts the cobra commander for the RootCommand 'aenker', parses arguments and flags, and finally executes the desired command.