cli-pher 1.0.0

A command line implementation of common ciphers

CLI-pher

Introduction

Welcome to CLI-pher! This is a command line implementation for quick encoding and decoding of text using common ciphers.

Supported ciphers

• Caesar
• Vigenere
• Simple keyword substitution

Quickstart Guide

Install

CLI-pher is published to PyPI and can be installed via pip, uv, or any python package manager of your choice.

pip install cli-pher

Run

CLI-pher can be run using either cli-pher or clipher. For consistency, this guide will use cli-pher and the caesar command for each example.

For usage and full list of commands:

# Display help message for cli-pher
cli-pher --help

# Display help message for a specific supported cipher
# Usage: cli-pher COMMAND --help
cli-pher caesar --help

Running cipher encryption/decryption examples:

# Example - encrypting using caesar cipher with a shift of 3
cli-pher caesar 3 julius

# Example - decrypting using caesar cipher with a shift of 3
cli-pher caesar 3 mxolxv --decrypt

Interactive Mode

CLI-pher supports an "Interactive Mode" that prompts you for all necessary inputs instead of relying on positional arguments and CLI options. Interactive Mode is automatically started if any required arguments are missing from your cli-pher command.

Alternatively, you can enter interactive mode by passing the interactive flag:

cli-pher caesar --interactive

Here is an example of what interactive mode looks like:

$ cli-pher caesar --interactive
Entering interactive mode!
Encrypt or decrypt? (e/d):
$ e
Key:
$ 3
Text:
$ julius
mxolxv

Using CLI-pher as a library

CLI-pher can be added as a dependency to a python project and the ciphers module can be imported for programmatic encryption and decryption of supported CLI-pher ciphers.

from cli_pher.ciphers import caesar

ciphertext = caesar.encrypt('julius', 3)
print(f'Caesar encrypted text: {ciphertext}')