Code Vault Documentation

1. Project Overview

A CLI based static file analyser for codebase analysis. Made from pure C++ with object-oriented methodology. Easy to use and blazing fast response.

The project supports two main operational modes:

2. Installation & Setup

1. Clone the repository: 
                git clone https://github.com/tecnolgd/cvault
                 2. Open the codevault folder:
                 cd cvault

2.1 Prerequisites

GCC MinGW(x32/64) ver 14.2.0 (Recommended)
                2. Recommended terminal: cmd (windows)
                3. Libraries: Not required 💀 (clone and run the damn code)
                4. Runtime Environment: Windows 11 and above(Recommended)

2.2 Compilation / Build

                Use the following command to build the executable:
                Compilation:
                * g++ main.cpp cmd.cpp -o cvaultFor manual build
                * mingw-32 makeFor makefile build(recommended)

                Build:
                * cvault.exe or simply cvault (For windows)
                * ./cvault (For linux/mac)

3. Feature Reference

[Command line Mode]

3.1. cvault populate <path>

This command is used to scan for the directory for files. If directory name is not specified, it scans the directory in which Code Vault is opened. 

cvault populate .

3.2. report

This command is used to display all the files in the scanned directory. The report by default scans the directory in which Code Vault is opened unless stated in the cvault report <directoryName> otherwise. 

cvault report . //report generation for the current directory.

3.3. fsearch <filename>

This command is used to search a file in the scanned/populated directory. The search functionality happens based on file name. Note that fsearch doesn't work for executables or object files. 

cvault search filename

3.4.cvault fsortbyte <path> or simply cvault fsortbyte

This command is used to sort the files(including executables, object files, etc.) in increasing order of no of bytes in the file or simply based on the size of the file. cvault fsortbyte<directory> otherwise. 

cvault fsortbyte . //file sort for the current directory.

4. Interactive Mode commands

                    
    
                    
  • populate: To populate / scan the  directory
    • 
                    
    
                    
  • report: To display the scanned directory report
    • 
                    
    
                    
  • fsortbyte: To sort the files based on file size
    • 
                    
    
                    
  • fsearch: To search for a file in the scanned directory
    • 
                    
    
                    
  • fmaxbyte: To find the largest file(based on size)
    • 
                    
    
                    
  • creds: To display credits and doc links
    • 
                    
  • help: To display commands and their meanings
    • 
                    
    
                    
  • exit/quit: To exit/ quit the application
    •

5. How to run?

                1. Clone the repository :
                git clone https://github.com/tecnolgd/cvault

                2. Open the folder :
                cd cvault

                3. Run with : 
                    Makefile(Recommended)
                        1. Open terminal in the cvault folder. 
                        2. Run mingw32-make //for windows / make //for linux/ios.
                        3. An executabe file called cvault.exe / cvalut.owould be formed.
                        4. Run the command     
                            a) for Interactive mode:
                            - Use cvault.exe //for windows or simply cvault.
                            - Use ./cvault //for linux/ios in the terminal.
                            b) for Command-line mode:
                            Directly type the suitable commands on the terminal interface.

                            (Note: Run mingw32-make clean or make clean to clear object files based on OS)
                        5. The application will open for user interaction.

                    g++(Manual way / for beginners)   
                        1. Open the terminal in the **cvault** folder.
                        2. Run
                        g++ main.cpp cmd.cpp -o cvault
                        3. An executable file called cvault.exe would be formed.
                        4. The command-line mode will be activated.
                        5. Start writing commands based on your need.