BC-Envelope-CLI TypeScript Library - v1.0.0-alpha.16
    Preparing search index...

    Interface CommandArgs

    Command arguments for the encrypt command.

    interface CommandArgs {
        key?: string;
        password?: string;
        askpass: boolean;
        passwordDerivation: PasswordDerivationType;
        sshId?: string;
        recipients: string[];
        envelope?: string;
    }
    Index

    Properties

    key? password? askpass passwordDerivation sshId? recipients envelope?

    Properties

    key?: string

    The content key to use to encrypt the envelope's subject (ur:crypto-key)

    password?: string

    A password used to lock the content key

    askpass: boolean

    Use SSH_ASKPASS to read the password

    passwordDerivation: PasswordDerivationType

    The password-based key derivation algorithm

    sshId?: string

    The SSH agent key identity used to lock the content key

    recipients: string[]

    The recipients to whom the envelope's subject should be encrypted (ur:crypto-pubkeys)

    envelope?: string

    The envelope to encrypt

    Settings

    Member Visibility

    On This Page

    Properties