-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
60 lines (59 loc) · 15.1 KB
/
index.html
File metadata and controls
60 lines (59 loc) · 15.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>xrDebug</title>
<meta name="generator" content="VuePress 1.9.10">
<link rel="icon" href="/logo.png">
<link rel="apple-touch-icon" href="/logo.png">
<meta name="description" content="Lightweight portable debug utility">
<meta property="og:site_name" content="xrDebug">
<meta property="og:type" content="website">
<meta property="og:url" content="/">
<meta name="twitter:url" content="/">
<meta name="twitter:card" content="summary_large_image">
<meta name="theme-color" content="#23a8e0">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="msapplication-TileColor" content="#000000">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="preload" href="/assets/css/0.styles.d2c3555d.css" as="style"><link rel="preload" href="/assets/js/app.c44b2647.js" as="script"><link rel="preload" href="/assets/js/2.5f89cc48.js" as="script"><link rel="preload" href="/assets/js/1.fd3adf74.js" as="script"><link rel="preload" href="/assets/js/22.ef5637a0.js" as="script"><link rel="prefetch" href="/assets/js/10.423e4ac4.js"><link rel="prefetch" href="/assets/js/11.a373a5f2.js"><link rel="prefetch" href="/assets/js/12.b28924a1.js"><link rel="prefetch" href="/assets/js/13.8aafa6f5.js"><link rel="prefetch" href="/assets/js/14.7437570e.js"><link rel="prefetch" href="/assets/js/15.df4291a8.js"><link rel="prefetch" href="/assets/js/16.be855806.js"><link rel="prefetch" href="/assets/js/17.34549737.js"><link rel="prefetch" href="/assets/js/18.ac720a26.js"><link rel="prefetch" href="/assets/js/19.7935f841.js"><link rel="prefetch" href="/assets/js/20.209855e4.js"><link rel="prefetch" href="/assets/js/21.e74ef83d.js"><link rel="prefetch" href="/assets/js/23.593d1650.js"><link rel="prefetch" href="/assets/js/24.3470381f.js"><link rel="prefetch" href="/assets/js/25.a37d2650.js"><link rel="prefetch" href="/assets/js/26.be5816a3.js"><link rel="prefetch" href="/assets/js/3.74ca6ec8.js"><link rel="prefetch" href="/assets/js/4.4b47ec71.js"><link rel="prefetch" href="/assets/js/5.af0d6a13.js"><link rel="prefetch" href="/assets/js/6.d0849f85.js"><link rel="prefetch" href="/assets/js/7.7606245d.js"><link rel="prefetch" href="/assets/js/vendors~docsearch.1f6d7e80.js">
<link rel="stylesheet" href="/assets/css/0.styles.d2c3555d.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container no-sidebar"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" aria-current="page" class="home-link router-link-exact-active router-link-active"><img src="/logo.svg" alt="xrDebug" class="logo"> <span class="site-name can-hide">xrDebug</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/install/" class="nav-link">
Install
</a></div><div class="nav-item"><a href="/run/" class="nav-link">
Run
</a></div><div class="nav-item"><a href="/developer/" class="nav-link">
Developer
</a></div><div class="nav-item"><a href="/api/" class="nav-link">
API
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Library Menu" class="dropdown-title"><span class="title">Library</span> <span class="arrow down"></span></button> <button type="button" aria-label="Library Menu" class="mobile-dropdown-title"><span class="title">Library</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/xrdebug/php" target="_blank" rel="noopener noreferrer" class="nav-link external">
PHP
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://github.com/xrdebug/wordpress" target="_blank" rel="noopener noreferrer" class="nav-link external">
WordPress
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/xrdebug/xrdebug" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/install/" class="nav-link">
Install
</a></div><div class="nav-item"><a href="/run/" class="nav-link">
Run
</a></div><div class="nav-item"><a href="/developer/" class="nav-link">
Developer
</a></div><div class="nav-item"><a href="/api/" class="nav-link">
API
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Library Menu" class="dropdown-title"><span class="title">Library</span> <span class="arrow down"></span></button> <button type="button" aria-label="Library Menu" class="mobile-dropdown-title"><span class="title">Library</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/xrdebug/php" target="_blank" rel="noopener noreferrer" class="nav-link external">
PHP
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://github.com/xrdebug/wordpress" target="_blank" rel="noopener noreferrer" class="nav-link external">
WordPress
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/xrdebug/xrdebug" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span></span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/" aria-current="page" class="active sidebar-link">/</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/#quick-start" class="sidebar-link">Quick start</a></li><li class="sidebar-sub-header"><a href="/#debugging" class="sidebar-link">Debugging</a></li><li class="sidebar-sub-header"><a href="/#contributing" class="sidebar-link">Contributing</a></li></ul></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="xrdebug"><a href="#xrdebug" class="header-anchor">#</a> xrDebug</h1> <p><a href="https://xrdebug.com/" target="_blank" rel="noopener noreferrer">xrDebug<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> is a lightweight web-based debug software. <a href="https://xrdebug.com/xrdebug.mp4" target="_blank" rel="noopener noreferrer">Play video<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></p> <h2 id="quick-start"><a href="#quick-start" class="header-anchor">#</a> Quick start</h2> <ul><li><a href="/install">Install</a> application (binary)</li></ul> <div class="language-sh extra-class"><pre class="language-sh"><code><span class="token function">bash</span> <span class="token operator"><</span><span class="token punctuation">(</span><span class="token function">curl</span> <span class="token parameter variable">-sL</span> xrdebug.com/bin.sh<span class="token punctuation">)</span>
</code></pre></div><ul><li><a href="/run/">Run</a> <code>xrdebug</code> to spawn server</li></ul> <div class="language-sh extra-class"><pre class="language-sh"><code>xrdebug
</code></pre></div><ul><li>Alternatively, run it with Docker (use <code>host.docker.internal</code> as the host)</li></ul> <div class="language-sh extra-class"><pre class="language-sh"><code><span class="token function">docker</span> run <span class="token parameter variable">-t</span> <span class="token parameter variable">--init</span> <span class="token parameter variable">-p</span> <span class="token number">27420</span>:27420 ghcr.io/xrdebug/xrdebug:latest
</code></pre></div><h2 id="debugging"><a href="#debugging" class="header-anchor">#</a> Debugging</h2> <ul><li>Install a client library for your language/framework or use the <a href="/api/">HTTP API</a> directly</li></ul> <h3 id="client-libraries"><a href="#client-libraries" class="header-anchor">#</a> Client libraries</h3> <p>A client library is a wrapper around the HTTP API and it enables to debug your application by using helpers in your codebase.</p> <table><thead><tr><th>Technology</th> <th>Package</th></tr></thead> <tbody><tr><td>PHP</td> <td><a href="https://github.com/xrdebug/php" target="_blank" rel="noopener noreferrer">xrdebug/php<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></td></tr> <tr><td>WordPress</td> <td><a href="https://github.com/xrdebug/wordpress" target="_blank" rel="noopener noreferrer">xrdebug/wordpress<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></td></tr></tbody></table> <h2 id="contributing"><a href="#contributing" class="header-anchor">#</a> Contributing</h2> <p>If you want to contribute to xrDebug, please check the <a href="/developer">developer guide</a>.</p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/xrdebug/docs/edit/main/README.md" target="_blank" rel="noopener noreferrer">Edit this page</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <!----></footer> <!----> </main></div><div class="global-ui"></div></div>
<script src="/assets/js/app.c44b2647.js" defer></script><script src="/assets/js/2.5f89cc48.js" defer></script><script src="/assets/js/1.fd3adf74.js" defer></script><script src="/assets/js/22.ef5637a0.js" defer></script>
</body>
</html>