Installing and Updating Cryptex

Forward and / or Why should I install it?

Are you getting tired of having to navigate to the /path/to/Cryptex/src to launch Cryptex. Good news, we have an easy to use installer that allows you to launch Cryptex from anywhere on the command line. -- Neat!

Installing also makes using Cryptex syntax simpler as well as a command looks like:
cryptex cc -e -t "Hello world! " -k 14
instead of
python3 main.py cc -e -t "Hello world! " -k 14

Lets get into it.

Pre-Install Requirements:

• Python3
• Pip

Install Instructions

1. Make a folder to house cryptex in and move into it. I usually call this git.

mkdir ~/git && cd ~/git

2. Clone the repository into a folder you just made.

git clone https://github.com/SSGorg/Cryptex

3. Navigate to the newly cloned Cryptex folder

cd ~/git/Cryptex

4. Use python to install Cryptex.

python3 install.py

The installer will walk you through everything with minimal effort as it should automagically detect your OS and what shell you are using.

5. Restart your terminal

exit

6. Launch Cryptex

cryptex

If all of this was done correctly you should now see the Cryptex menu.

---

Updating Cryptex

When we release a new 'patch' or numbered version to Cryptex you will be notified when you launch Cryptex and will be given the option to update on the spot. No hassle necessary.

The Hackers Method of Updating

There is a second way to update Cryptex but this is more if you are using 'bleeding edge' Cryptex.

1. Navigate to the directory Cryptex resides in

cd ~/git/Cryptex

2. Do a git pull

git pull

3. Run the install script.

python3 install.py

The installer will not delete the .cryptex folder in your user home directory but copy and or replace all the files that need to be changed in the background so you don't need to worry about it.