MCPcopy Index your code
hub / github.com/azimjohn/jprq

github.com/azimjohn/jprq @2.4

Chat with this repo
repository ↗ · DeepWiki ↗ · release 2.4 ↗ · + Follow
134 symbols 327 edges 22 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
<img height="140" src="https://user-images.githubusercontent.com/35038240/221522083-1011e567-e2b7-424c-a018-15e965cf8df9.png#gh-light-mode-only">
<img height="140" src="https://user-images.githubusercontent.com/35038240/221522077-5b1e3eca-ca85-4c9f-93a9-afd39cc93c88.png#gh-dark-mode-only">

What's JPRQ?

  • JPRQ is a free and open tool for exposing local servers to public network (the internet)
  • It can expose TCP protocols, such as HTTP, SSH, etc. Any server!

How to install

Windows

📹Video tutorial

  1. Install the latest release of JPRQ

  2. Place the file where it is convenient for you

(At this point, you can use the program, but you will need to manually call the .exe file)

  1. Create jprq.bat file so we can use the "jprq" keyword to call the .exe file

    bash @echo off "C:\Exact\Path\To\File\jprq-windows-386.exe" %*

  2. Awesome! Finally, we need to add to the environment variable " PATH", the path to the folder where we created .bat file (step 3)

Congratulations! You can check if everything is working with the jprq command in CMD


MacOs and Linux

$ brew install jprq

or

$ curl -fsSL https://jprq.io/install.sh | sudo bash

Arch-based distros

  1. JPRQ is available on the AUR.

bash git clone https://aur.archlinux.org/jprq.git cd jprq makepkg -si

  1. You can use an AUR helper like yay to install it:

bash yay -S jprq

How to use

First obtain auth token from https://jprq.io/auth, then

jprq auth <your-auth-token>

Replace 8000 with the port you want to expose

jprq http 8000

For exposing any TCP servers, such as SSH

jprq tcp 22

For using custom subdomains

jprq http 3000 -s <custom-name>

For using jprq debugger (with v2.1 or higher)

jprq http 3000 --debug

Serve static files using built-in HTTP Server (with v2.2 or higher)

jprq serve .

Serve on a different domain using CNAME (with v2.3 or higher)

jprq http 3000 --cname example.com

Press Ctrl+C to stop it

Update as of Oct 21, 2023

** jprq is now members-only service **

What does that mean?

  • it still stays open and free to self-host
  • to use the service I maintain, buy me a coffee and leave your github username
  • I will send you invite link to keep using jprq

Buy Me A Coffee

Extension points exported contracts — how you extend this code

Conn (Interface)
(no doc) [1 implementers]
cli/debugger/server.go
Authenticator (Interface)
(no doc) [1 implementers]
server/github/github.go
EventType (Interface)
(no doc)
server/events/events.go
Tunnel (Interface)
(no doc)
server/tunnel/tunnel.go
Debugger (Interface)
(no doc) [1 implementers]
cli/debugger/server.go

Core symbols most depended-on inside this repo

Close
called by 20
server/tunnel/tunnel.go
Write
called by 10
server/events/events.go
WriteError
called by 9
server/events/events.go
Read
called by 8
server/events/events.go
Write
called by 7
cli/config.go
createElementFromHTML
called by 6
cli/debugger/static/script.js
Bind
called by 6
server/tunnel/tunnel.go
Init
called by 5
server/server/tcpserver.go

Shape

Method 56
Function 54
Struct 19
Interface 5

Languages

Go84%
TypeScript16%

Modules by API surface

cli/debugger/static/script.js22 symbols
cli/debugger/server.go16 symbols
server/tunnel/tunnel.go15 symbols
server/github/github.go11 symbols
server/events/events.go10 symbols
server/jprq.go7 symbols
cli/main.go7 symbols
server/tunnel/tcp_tunnel.go6 symbols
server/tunnel/http_tunnel.go6 symbols
server/server/tcpserver.go6 symbols
cli/debugger/parser.go5 symbols
website/main.go4 symbols

For agents

$ claude mcp add jprq \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact