If you like WireQuery, please ⭐️ it on GitHub
Table of Contents

Quick Start

Run the following commands if you want to try out WireQuery on your local machine:

  1. Make sure Docker is installed and run the following commands in your terminal:
    mkdir wirequery
    cd wirequery
    curl -O https://raw.githubusercontent.com/wirequery/wirequery/main/docker-compose.yml
    curl -O https://raw.githubusercontent.com/wirequery/wirequery/main/nginx.conf
    docker-compose up
  2. Wait until both the backend and frontend are initialized and navigate to localhost:8090. Log in with admin / admin and update your password in the Settings.
  3. Start using WireQuery by creating an application and connecting to WireQuery using one of the SDKs below.

If you wish to install WireQuery on a server, please follow the Server Installation instructions.

Setting up the SDK

The SDKs allow your applications to send and receive the required data from and to WireQuery, so you can query them.

Before you can use them, the SDKs require a host, an application name and an API key.

In order to be able to provide an application name and API key, you need to create an application in WireQuery. Go to 'Applications', click 'New', choose a 'Name' and a 'Description' and click 'Save'. Finally, click 'Show API Key' on the saved application and copy the displayed API Key.

Next, follow the SDK instructions or integration guide of your choice to integrate WireQuery with your application:

JVMNative libraries for vanilla Java, Spring Boot 2 and 3Yes-
JS (Browser)Guide for integrating with Javascript in the Browser for frontend recordingNoNo SDK, but an integration guide
GoNative library for GoYesHighly experimental, no built-in masking
UniversalWireQuery Universal Daemon, tool for universal WireQuery supportNoHighly experimental, no built-in masking

More SDKs (libraries) will be added over time.


Now that your application is connected with WireQuery, you can start exploring the traffic going in and out of your app through the Explore feature. You will learn how more about this feature in the next Chapter.