Welcome to Voogle - a tool to search for functions by types! This command-line tool provides a convenient way to search for functions based on return types and parameter types.
To install Voogle, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/JohnLucid1/voogle.git
-
Change into the project directory:
cd voogle -
Compile the programm
v . -
You're ready to use Voogle!
Voogle utilizes command-line flags for ease of use. Use the following command:
voogle -p <filepath or dir> -i <search query>Replace <filepath or dir> with the path or directory to start searching, and <search query> with your desired search query.
voogle -p ./ -i "int|string, int"This command will search for functions that return an integer and have two parameters: a string and an integer, starting from the current directory.
voogle -p ./ -i "|float"This command will search for functions that do not have a specified return type and have a single parameter of type float, starting from the current directory.
If you'd like to contribute to Voogle, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive commit messages.
- Push your changes to your fork.
- Create a pull request to the main repository's
developbranch.
This project is licensed under the MIT License - see the LICENSE.md file for details.
Thank you for using Voogle! If you encounter any issues or have suggestions for improvement, feel free to open an issue on the GitHub repository. Happy coding!