Skip to content

cli.md

Latest commit

 

History

History
126 lines (85 loc) · 2.29 KB

cli.md

File metadata and controls

126 lines (85 loc) · 2.29 KB

CLI Documentation

The prefix is always arithmos.

Note : Arithmos Cipher chain are not available on CLI.
The reason why I didn't implement the chain in the CLI is, the user will be in trouble when decrypting because the cipher must be too long.

Content List


Command

List of all commands.

  • encrypt
  • decrypt
  • version
  • update
  • uninstall


Arguments

Commands arguments (the string/cipher)

encrypt [text]

text : the string to be encrypted into a cipher.

decrypt [cipher]

cipher : the cipher to be decrypted into a string.

version

Not have arguments.

update

Not have arguments.

uninstall

Not have arguments.



Option

Commands option

encrypt [text] [option] [option args]

Option :

  • --ignore/-i | letters that will not be encrypted by the algorithm. if you don't want to encrypt more than 1 letter or sentence, add --ignore/-g again as before. | Required = False.

Example :

arithmos encrypt example -i e

# output
2401131612 (xampl)

# more than 1 letters and sentence
arithmos encrypt example123 -i e -i 123

# output
2401131612 (xampl)


decrypt [text] [option] [option args]

Option :

  • --ignore/-i | number that will not be decrypted by the algorithm. if you don't want to decrypt more than 1 number or sentence, add --ignore/-g again as before. | Required = False.

Example :

arithmos decrypt 05240113161205 -i 05

# output
xampl (2401131612)

# more than 1 number and sentence
arithmos decrypt 05240113161205868788 -i 05 -i 868788

# output
xampl (2401131612)


version [option]

Option :

  • --more/-m

Check your local (arithmos-cipher) version, PyPI latest version, click version, and requests version.

update

Not have option.

uninstall

Not have option.



Aliases

Commands aliases.

Alias :

  • encrypt = enc
  • decrypt = dec
  • version = ver
  • update = up
  • uninstall = del