Crypto CLI
    Preparing search index...

    Variable translationsConst

    translations: {
        CLI_TITLE: "🔐 Crypto CLI";
        CLI_DESCRIPTION: "Crypto CLI is a simple, yet powerful, command line interface that can be used to perform common cryptographic operations from the command prompt or terminal.";
        CLI_FN_1_TTL: "Generate";
        CLI_FN_1_DES: "Generates a new OpenPGP key pair. Supports RSA and ECC keys.";
        CLI_FN_1_LG_DES: "🔍 Select this option to get help on the generate command.";
        CLI_FN_2_TTL: "Encrypt";
        CLI_FN_2_DES: "Encrypts a message.";
        CLI_FN_2_LG_DES: "🔍 Select this option to get help on the encrypt command.";
        CLI_FN_3_TTL: "Decrypt";
        CLI_FN_3_DES: "Decrypts a message.";
        CLI_FN_3_LG_DES: "🔍 Select this option to get help on the decrypt command.";
        CLI_FN_4_TTL: "Reformat";
        CLI_FN_4_DES: "Reformats signature packets for a key.";
        CLI_FN_4_LG_DES: "🔍 Select this option to get help on the reformat command.";
        CLI_FN_5_TTL: "Revoke";
        CLI_FN_5_DES: "Revokes a key.";
        CLI_FN_5_LG_DES: "🔍 Select this option to get help on the revoke command.";
        CLI_FN_6_TTL: "Session";
        CLI_FN_6_DES: "Generate a new session key object.";
        CLI_FN_6_LG_DES: "🔍 Select this option to get help on the session command.";
        CLI_FN_7_TTL: "Sign";
        CLI_FN_7_DES: "Signs a message.";
        CLI_FN_7_LG_DES: "🔍 Select this option to get help on the sign command.";
        CLI_FN_8_TTL: "Verify";
        CLI_FN_8_DES: "Verifies signatures of cleartext signed message.";
        CLI_FN_8_LG_DES: "🔍 Select this option to get help on the verify command.";
        CLI_FN_9_TTL: "Help";
        CLI_FN_9_DES: "Get help on a command.";
        CLI_FN_9_LG_DES: "";
        CLI_HDL_1_DES: "We need you to provide us with the following information:";
        PROMPT_SELECT_TTL: "Selection";
        PROMPT_SELECT_DES: "Select a function to execute.";
        PROMPT_SELECT_DES_HLP: "Let us help you on the Crypto Command Line Interface (CLI). Please select a command to learn more about.";
        PROMPT_HLP_DEC_DES: "This function decrypts a message with the user's private key, a session key or a password. One of decryptionKeys, session keys or passwords must be specified (passing a combination of these options is not supported).";
        PROMPT_HLP_DEC_USAGE: "Usage: decrypt [options]";
        PROMPT_HLP_DEC_OPTIONS: "Options:";
        PROMPT_HLP_DEC_OPT_1: " <encryptedMessage> - The message object with the encrypted data.";
        PROMPT_HLP_DEC_OPT_2: " <passphrase> - Passphrase / Passwords to decrypt the message";
        PROMPT_HLP_DEC_OPT_3: " <publicKey> - Public key enumeration base64 encoded.";
        PROMPT_HLP_ENC_DES: "This function encrypts a message using public keys, passwords or both at once. At least one of encryptionKeys or passwords must be specified. If signing keys are specified, those will be used to sign the message.";
        PROMPT_HLP_ENC_USAGE: "Usage: encrypt [options]";
        PROMPT_HLP_ENC_OPTIONS: "Options:";
        PROMPT_HLP_ENC_OPT_1: " <message> - The message to be encrypted.";
        PROMPT_HLP_ENC_OPT_2: " <passphrase> - Passphrase to encrypt the message.";
        PROMPT_HLP_ENC_OPT_3: " <publicKey> - Public key enumeration base64 encoded.";
        PROMPT_HLP_GEN_DES: "This function generates a new OpenPGP key pair. Supports RSA and ECC keys. By default, primary and subkeys will be of same type. The generated primary key will have signing capabilities. By default, one subkey with encryption capabilities is also generated.";
        PROMPT_HLP_GEN_USAGE: "Usage: generate [options]";
        PROMPT_HLP_GEN_OPTIONS: "Options:";
        PROMPT_HLP_GEN_OPT_1: " <name> - Name of the user.";
        PROMPT_HLP_GEN_OPT_2: " <email> - Email of the user.";
        PROMPT_HLP_GEN_OPT_3: " <passphrase> - The passphrase used to encrypt the generated private key. If omitted or empty, the key won't be encrypted.";
        PROMPT_HLP_GEN_OPT_4: " <type> - The primary key algorithm type: ECC (default) or RSA.";
        PROMPT_HLP_GEN_OPT_5: " <curve> - Elliptic curve for ECC keys: curve25519 (default), p256, p384, p521, secp256k1, brainpoolP256r1, brainpoolP384r1, or brainpoolP512r1.";
        PROMPT_HLP_GEN_OPT_6: " <rsaBits> - Number of bits for RSA keys.";
        PROMPT_HLP_GEN_OPT_7: " <keyExpirationTime> - Number of seconds from the key creation time after which the key expires.";
        PROMPT_HLP_GEN_OPT_8: " <format> - Format of the output keys: 'armored' | 'binary' | 'object'";
        PROMPT_HLP_REF_DES: "This function reformats signature packets for a key and rewraps key object.";
        PROMPT_HLP_REF_USAGE: "Usage: reformat [options]";
        PROMPT_HLP_REF_OPTIONS: "Options:";
        PROMPT_HLP_REF_OPT_1: " <email> - Email of the user.";
        PROMPT_HLP_REF_OPT_2: " <expirationTime> - Number of seconds from the key creation time after which the key expires.";
        PROMPT_HLP_REF_OPT_3: " <name> - Name of the user.";
        PROMPT_HLP_REF_OPT_4: " <passphrase> - The passphrase used to encrypt the reformatted private key. If omitted or empty, the key won't be encrypted.";
        PROMPT_HLP_REF_OPT_5: " <publicKey> - Public key enumeration base64 encoded.";
        PROMPT_HLP_RVK_DES: "This function revokes a key. Requires either a private key or a revocation certificate. If a revocation certificate is passed, the reasonForRevocation parameter will be ignored.";
        PROMPT_HLP_RVK_USAGE: "Usage: revoke [options]";
        PROMPT_HLP_RVK_OPTIONS: "Options:";
        PROMPT_HLP_RVK_OPT_1: " <flags> - Flag indicating the reason for revocation.";
        PROMPT_HLP_RVK_OPT_2: " <passphrase> - Passphrase to decrypt the private key.";
        PROMPT_HLP_RVK_OPT_3: " <reasonForRevocation> - Reason for revocation.";
        PROMPT_HLP_SES_DES: "This function generates a new session key object, taking the algorithm preferences of the passed public keys into account.";
        PROMPT_HLP_SES_USAGE: "Usage: session [options]";
        PROMPT_HLP_SES_OPT_1: " <name> - Name of the user.";
        PROMPT_HLP_SES_OPT_2: " <publicKey> - Public key enumeration base64 encoded.";
        PROMPT_HLP_SGN_DES: "This function signs a message.";
        PROMPT_HLP_SGN_USAGE: "Usage: sign [options]";
        PROMPT_HLP_SGN_OPT_1: " <passphrase> - Passphrase to sign the message.";
        PROMPT_HLP_SGN_OPT_2: " <message> - The message to be signed.";
        PROMPT_HLP_SGN_OPT_3: " <detach> - If true, the signature is detached. If false, the signature is embedded.";
        PROMPT_HLP_SGN_OPT_4: " <publicKey> - Public key enumeration base64 encoded.";
        PROMPT_HLP_SGN_OPT_5: " <privateKey> - Private key enumeration base64 encoded.";
        PROMPT_HLP_VRF_DES: "This function verifies signatures of cleartext signed message.";
        PROMPT_HLP_VRF_USAGE: "Usage: verify [options]";
        PROMPT_HLP_VRF_OPT_1: " <message> - The message to be verified.";
        PROMPT_HLP_VRF_OPT_2: " <publicKey> - Public key enumeration base64 encoded.";
        CLI_ERR_1: "🔔 You must select a command.";
        CLI_ERR_2: "🔔 You must select a valid option.";
    } = ...

    English (en) translation strings for the CLI interface.

    Type Declaration

    • ReadonlyCLI_TITLE: "🔐 Crypto CLI"

      Main title shown in the CLI banner.

    • ReadonlyCLI_DESCRIPTION: "Crypto CLI is a simple, yet powerful, command line interface that can be used to perform common cryptographic operations from the command prompt or terminal."

      Description of the CLI application.

    • ReadonlyCLI_FN_1_TTL: "Generate"

      Title for the Generate command.

    • ReadonlyCLI_FN_1_DES: "Generates a new OpenPGP key pair. Supports RSA and ECC keys."

      Short description for the Generate command.

    • ReadonlyCLI_FN_1_LG_DES: "🔍 Select this option to get help on the generate command."

      Help-menu description for the Generate command.

    • ReadonlyCLI_FN_2_TTL: "Encrypt"

      Title for the Encrypt command.

    • ReadonlyCLI_FN_2_DES: "Encrypts a message."

      Short description for the Encrypt command.

    • ReadonlyCLI_FN_2_LG_DES: "🔍 Select this option to get help on the encrypt command."

      Help-menu description for the Encrypt command.

    • ReadonlyCLI_FN_3_TTL: "Decrypt"

      Title for the Decrypt command.

    • ReadonlyCLI_FN_3_DES: "Decrypts a message."

      Short description for the Decrypt command.

    • ReadonlyCLI_FN_3_LG_DES: "🔍 Select this option to get help on the decrypt command."

      Help-menu description for the Decrypt command.

    • ReadonlyCLI_FN_4_TTL: "Reformat"

      Title for the Reformat command.

    • ReadonlyCLI_FN_4_DES: "Reformats signature packets for a key."

      Short description for the Reformat command.

    • ReadonlyCLI_FN_4_LG_DES: "🔍 Select this option to get help on the reformat command."

      Help-menu description for the Reformat command.

    • ReadonlyCLI_FN_5_TTL: "Revoke"

      Title for the Revoke command.

    • ReadonlyCLI_FN_5_DES: "Revokes a key."

      Short description for the Revoke command.

    • ReadonlyCLI_FN_5_LG_DES: "🔍 Select this option to get help on the revoke command."

      Help-menu description for the Revoke command.

    • ReadonlyCLI_FN_6_TTL: "Session"

      Title for the Session command.

    • ReadonlyCLI_FN_6_DES: "Generate a new session key object."

      Short description for the Session command.

    • ReadonlyCLI_FN_6_LG_DES: "🔍 Select this option to get help on the session command."

      Help-menu description for the Session command.

    • ReadonlyCLI_FN_7_TTL: "Sign"

      Title for the Sign command.

    • ReadonlyCLI_FN_7_DES: "Signs a message."

      Short description for the Sign command.

    • ReadonlyCLI_FN_7_LG_DES: "🔍 Select this option to get help on the sign command."

      Help-menu description for the Sign command.

    • ReadonlyCLI_FN_8_TTL: "Verify"

      Title for the Verify command.

    • ReadonlyCLI_FN_8_DES: "Verifies signatures of cleartext signed message."

      Short description for the Verify command.

    • ReadonlyCLI_FN_8_LG_DES: "🔍 Select this option to get help on the verify command."

      Help-menu description for the Verify command.

    • ReadonlyCLI_FN_9_TTL: "Help"

      Title for the Help command.

    • ReadonlyCLI_FN_9_DES: "Get help on a command."

      Short description for the Help command.

    • ReadonlyCLI_FN_9_LG_DES: ""

      Extended description for the Help command (empty).

    • ReadonlyCLI_HDL_1_DES: "We need you to provide us with the following information:"

      Prompt text shown before command-specific input collection.

    • ReadonlyPROMPT_SELECT_TTL: "Selection"

      Prompt field name for user selection.

    • ReadonlyPROMPT_SELECT_DES: "Select a function to execute."

      Prompt message for the main command selector.

    • ReadonlyPROMPT_SELECT_DES_HLP: "Let us help you on the Crypto Command Line Interface (CLI). Please select a command to learn more about."

      Prompt message for the help command selector.

    • ReadonlyPROMPT_HLP_DEC_DES: "This function decrypts a message with the user's private key, a session key or a password. One of decryptionKeys, session keys or passwords must be specified (passing a combination of these options is not supported)."

      Help text: decrypt command description.

    • ReadonlyPROMPT_HLP_DEC_USAGE: "Usage: decrypt [options]"

      Help text: decrypt command usage.

    • ReadonlyPROMPT_HLP_DEC_OPTIONS: "Options:"

      Help text: decrypt command options header.

    • ReadonlyPROMPT_HLP_DEC_OPT_1: " <encryptedMessage> - The message object with the encrypted data."

      Help text: decrypt encryptedMessage option.

    • ReadonlyPROMPT_HLP_DEC_OPT_2: " <passphrase> - Passphrase / Passwords to decrypt the message"

      Help text: decrypt passphrase option.

    • ReadonlyPROMPT_HLP_DEC_OPT_3: " <publicKey> - Public key enumeration base64 encoded."

      Help text: decrypt publicKey option.

    • ReadonlyPROMPT_HLP_ENC_DES: "This function encrypts a message using public keys, passwords or both at once. At least one of encryptionKeys or passwords must be specified. If signing keys are specified, those will be used to sign the message."

      Help text: encrypt command description.

    • ReadonlyPROMPT_HLP_ENC_USAGE: "Usage: encrypt [options]"

      Help text: encrypt command usage.

    • ReadonlyPROMPT_HLP_ENC_OPTIONS: "Options:"

      Help text: encrypt command options header.

    • ReadonlyPROMPT_HLP_ENC_OPT_1: " <message> - The message to be encrypted."

      Help text: encrypt message option.

    • ReadonlyPROMPT_HLP_ENC_OPT_2: " <passphrase> - Passphrase to encrypt the message."

      Help text: encrypt passphrase option.

    • ReadonlyPROMPT_HLP_ENC_OPT_3: " <publicKey> - Public key enumeration base64 encoded."

      Help text: encrypt publicKey option.

    • ReadonlyPROMPT_HLP_GEN_DES: "This function generates a new OpenPGP key pair. Supports RSA and ECC keys. By default, primary and subkeys will be of same type. The generated primary key will have signing capabilities. By default, one subkey with encryption capabilities is also generated."

      Help text: generate command description.

    • ReadonlyPROMPT_HLP_GEN_USAGE: "Usage: generate [options]"

      Help text: generate command usage.

    • ReadonlyPROMPT_HLP_GEN_OPTIONS: "Options:"

      Help text: generate command options header.

    • ReadonlyPROMPT_HLP_GEN_OPT_1: " <name> - Name of the user."

      Help text: generate name option.

    • ReadonlyPROMPT_HLP_GEN_OPT_2: " <email> - Email of the user."

      Help text: generate email option.

    • ReadonlyPROMPT_HLP_GEN_OPT_3: " <passphrase> - The passphrase used to encrypt the generated private key. If omitted or empty, the key won't be encrypted."

      Help text: generate passphrase option.

    • ReadonlyPROMPT_HLP_GEN_OPT_4: " <type> - The primary key algorithm type: ECC (default) or RSA."

      Help text: generate type option.

    • ReadonlyPROMPT_HLP_GEN_OPT_5: " <curve> - Elliptic curve for ECC keys: curve25519 (default), p256, p384, p521, secp256k1, brainpoolP256r1, brainpoolP384r1, or brainpoolP512r1."

      Help text: generate curve option.

    • ReadonlyPROMPT_HLP_GEN_OPT_6: " <rsaBits> - Number of bits for RSA keys."

      Help text: generate rsaBits option.

    • ReadonlyPROMPT_HLP_GEN_OPT_7: " <keyExpirationTime> - Number of seconds from the key creation time after which the key expires."

      Help text: generate keyExpirationTime option.

    • ReadonlyPROMPT_HLP_GEN_OPT_8: " <format> - Format of the output keys: 'armored' | 'binary' | 'object'"

      Help text: generate format option.

    • ReadonlyPROMPT_HLP_REF_DES: "This function reformats signature packets for a key and rewraps key object."

      Help text: reformat command description.

    • ReadonlyPROMPT_HLP_REF_USAGE: "Usage: reformat [options]"

      Help text: reformat command usage.

    • ReadonlyPROMPT_HLP_REF_OPTIONS: "Options:"

      Help text: reformat command options header.

    • ReadonlyPROMPT_HLP_REF_OPT_1: " <email> - Email of the user."

      Help text: reformat email option.

    • ReadonlyPROMPT_HLP_REF_OPT_2: " <expirationTime> - Number of seconds from the key creation time after which the key expires."

      Help text: reformat expirationTime option.

    • ReadonlyPROMPT_HLP_REF_OPT_3: " <name> - Name of the user."

      Help text: reformat name option.

    • ReadonlyPROMPT_HLP_REF_OPT_4: " <passphrase> - The passphrase used to encrypt the reformatted private key. If omitted or empty, the key won't be encrypted."

      Help text: reformat passphrase option.

    • ReadonlyPROMPT_HLP_REF_OPT_5: " <publicKey> - Public key enumeration base64 encoded."

      Help text: reformat publicKey option.

    • ReadonlyPROMPT_HLP_RVK_DES: "This function revokes a key. Requires either a private key or a revocation certificate. If a revocation certificate is passed, the reasonForRevocation parameter will be ignored."

      Help text: revoke command description.

    • ReadonlyPROMPT_HLP_RVK_USAGE: "Usage: revoke [options]"

      Help text: revoke command usage.

    • ReadonlyPROMPT_HLP_RVK_OPTIONS: "Options:"

      Help text: revoke command options header.

    • ReadonlyPROMPT_HLP_RVK_OPT_1: " <flags> - Flag indicating the reason for revocation."

      Help text: revoke flags option.

    • ReadonlyPROMPT_HLP_RVK_OPT_2: " <passphrase> - Passphrase to decrypt the private key."

      Help text: revoke passphrase option.

    • ReadonlyPROMPT_HLP_RVK_OPT_3: " <reasonForRevocation> - Reason for revocation."

      Help text: revoke reasonForRevocation option.

    • ReadonlyPROMPT_HLP_SES_DES: "This function generates a new session key object, taking the algorithm preferences of the passed public keys into account."

      Help text: session command description.

    • ReadonlyPROMPT_HLP_SES_USAGE: "Usage: session [options]"

      Help text: session command usage.

    • ReadonlyPROMPT_HLP_SES_OPT_1: " <name> - Name of the user."

      Help text: session name option.

    • ReadonlyPROMPT_HLP_SES_OPT_2: " <publicKey> - Public key enumeration base64 encoded."

      Help text: session publicKey option.

    • ReadonlyPROMPT_HLP_SGN_DES: "This function signs a message."

      Help text: sign command description.

    • ReadonlyPROMPT_HLP_SGN_USAGE: "Usage: sign [options]"

      Help text: sign command usage.

    • ReadonlyPROMPT_HLP_SGN_OPT_1: " <passphrase> - Passphrase to sign the message."

      Help text: sign passphrase option.

    • ReadonlyPROMPT_HLP_SGN_OPT_2: " <message> - The message to be signed."

      Help text: sign message option.

    • ReadonlyPROMPT_HLP_SGN_OPT_3: " <detach> - If true, the signature is detached. If false, the signature is embedded."

      Help text: sign detach option.

    • ReadonlyPROMPT_HLP_SGN_OPT_4: " <publicKey> - Public key enumeration base64 encoded."

      Help text: sign publicKey option.

    • ReadonlyPROMPT_HLP_SGN_OPT_5: " <privateKey> - Private key enumeration base64 encoded."

      Help text: sign privateKey option.

    • ReadonlyPROMPT_HLP_VRF_DES: "This function verifies signatures of cleartext signed message."

      Help text: verify command description.

    • ReadonlyPROMPT_HLP_VRF_USAGE: "Usage: verify [options]"

      Help text: verify command usage.

    • ReadonlyPROMPT_HLP_VRF_OPT_1: " <message> - The message to be verified."

      Help text: verify message option.

    • ReadonlyPROMPT_HLP_VRF_OPT_2: " <publicKey> - Public key enumeration base64 encoded."

      Help text: verify publicKey option.

    • ReadonlyCLI_ERR_1: "🔔 You must select a command."

      Error message when no command is selected.

    • ReadonlyCLI_ERR_2: "🔔 You must select a valid option."

      Error message when an invalid option is selected.