1. Installing Navi

Introduction

I am going to go through this guide as if I am installing Navi on a clean system. Fresh install.

Installing Navi On Linux

Getting Navi

Getting Navi is a pretty straight forward thing.

Tip

While the first two steps are not explicitly required the important parts are steps 3 and 4

1. Setup git directory - mkdir ~/ssg
2. Move to the git directory - cd ~/ssg
3. git clone https://github.com/SaintsSec/Navi Or if you use SSH git clone git@github.com:SaintsSec/Navi.git
4. Confirm complete clone - ls

Note

From here you should now see Navi as being the contents of the directory.

Installing Navi

Important

All major updates happen on the edge branch. We will discuss accessing that later.

1. Move into the Navi directory - cd Navi/
2. Move into the install directory - `cd install/
3. Run the install script - ./install.sh

Note

On the back end this install script is coping Navi into your systems /opt/ directory.
It is also installing all the requirements to run Navi and setting up her system alias. So once its over
You should be able to type navi on the command line and it will drop you into Navi's shell program.

Important

If for whatever reason you cant simply run navi post install try restarting your terminal.

Caution

From this point forward if you are doing any development with Navi, editing the AI or
making a custom script. Do your work from the /opt/Navi directory. Then copy that over to the cloned Navi in ~/ssg/

Updating Navi

Now that Navi is installed, you have quick easy access to it through command line aliasing. Which makes updating a breeze

Its automated
Yeah the main branch update process has been automated as of v0.6.5 and beyond. However if you want to manually update you can do the following!

On Main Branch

1. Update from anywhere on the command line - navi --update

On Edge Branch

Warning

Edge branch is pre-release / development builds. So it might be the latest and greatest but it might also be unstable.
If you run into problems please submit an Issue

1. Update from anywhere on the command line - navi --edge

Important

You can install directly from edge but the moment you use navi stock without --edge it will kick you right back to the normal main branch latest release. So run navi --edge right after you install to make sure the version numbers all check out and everything is installed properly! -- As of version 0.6.6 you can access Navi's settings directly from the cli app by typing settings in the chat. You can switch branches this way as well.