Skip to content

trailofbits/qt-multiplier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

680 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Multiplier GUI

A graphical user interface for exploring and analyzing code using the Multiplier framework.

Multiplier GUI provides developers with an intuitive, visual way to navigate complex codebases, understand code relationships, and perform in-depth code analysis. Built with Qt 6, it offers a modern, responsive interface for working with Multiplier-indexed code databases.

🚀 Getting Started

Quick Start with Pre-built Binaries

Latest CI Builds

Get the most recent build artifacts automatically generated by our CI pipeline:

  1. Visit the repository homepage
  2. Click the green checkmark next to the latest commit
  3. Select the Details link for your platform's build
  4. Navigate to Summary in the top-left corner
  5. Download the appropriate package for your system

CI Releases

Stable, tagged releases are available at: qt-multiplier releases

Installing on Ubuntu/Debian

# Install the package
sudo dpkg -i package-name.deb

# Install any missing dependencies
sudo apt install -f

Running the Application

💡 Pro Tip: A sample database (created from the uBPF library) is available in our build artifacts for immediate testing.

  1. Generate a database using mx-index from the multiplier repository:

    mx-index --target compile_commands.json --db database.mx
  2. Launch the application:

    • macOS: Open Multiplier.app
    • Linux: Run the installed executable
    • Windows: Launch the executable from the installation directory
  3. Load your database: Select your generated database.mx file

📚 Documentation

Resource Description
🎓 GUI Tutorial Complete step-by-step guide to using Multiplier GUI
🔧 Build Guide Development and production build instructions
📋 API Documentation Complete code documentation

🛠️ Development

Want to build from source? Check out our comprehensive Build Guide for detailed instructions on setting up your development environment.

🙏 Acknowledgments

This project stands on the foundation of excellent open-source libraries:

Library License Description
Qt 6 LGPL Cross-platform application framework
Phantom Style LGPL Modern Qt styling framework
Qt Advanced Docking System LGPL Professional docking system for Qt
doctest MIT Modern C++ testing framework
xxHash BSD 2-Clause Fast hash algorithm

🤝 Contributing

Please see our development documentation and feel free to submit issues and pull requests.

📄 License

This project and its dependencies are governed by their respective open-source licenses as listed above.

About

Graphical user interface for Multiplier

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages