debug-me.1


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

.\" -*- nroff -*-
.TH debug-me 1 "Commands"
.SH NAME
debug-me \- secure remote debugging
.SH SYNOPSIS
.B debug-me [options]
.SH DESCRIPTION
.I debug-me
`debug-me` lets a developer access your computer remotely, to debug a problem,
avoiding a tedious back-and-forth by email. When you start `debug-me`, it
starts a shell, and generates an URL which you can give to the developer
(or developers) to connect them to the session.
.PP
It's not normally a good idea to let someone run commands in a shell on
your computer. To make this as safe as possible, debug-me uses the
GPG web of trust. Everything the developer sends to debug-me is signed
with their GPG key, in a way that produces a GPG signed proof of what the
developer saw, and what they did in the debug-me session.
If the developer does something Evil, you have the neccessary proof
to adjust their reputation.
.PP
.SH OPTIONS
.PP
.IP "-- cmd opts"
Normally debug-me will run your login shell. To run some other command,
pass the command and any options after "--".
.PP
.IP "--gpg-opt=option"
debug-me runs gpg to verify the GPG key of a developer. To pass options to
gpg, use --gpg-opt with the option to pass. For example:
--gpg-opt=--keyserver=pgpkeys.mit.edu
This can be done multiple times.
.IP "--debug url"
Connect to a debug-me session on the specified url. The developer runs
debug-me with this option to see and interact with the user's bug.
.IP "--download url"
Download a debug-me log file from the specified url. Note that if the
debug-me session is still in progress, this will continue downloading
until the session ends. The proof chain in the log file is verified
as it is downloaded, but developer gpg signatures are not verified.
.IP "--replay logfile"
Replay a debug-me log file with realistic pauses.
.IP "--watch url"
Connect to a debug-me session on the specified url and display what
happens in the session. Your keystrokes will not be sent to the session.
.IP "--graphviz logfile"
Uses graphviz to generate a visualization of a debug-me log file.
.IP "--show-hashes"
Include hashes in the graphviz visualization.
.IP "--server logdir"
Run a debug-me server, logging to the specified directory.
.IP "--port N"
Specify a port for the debug-me server to listen to.
.SH SEE ALSO
<https://debug-me.branchable.com/>
.SH AUTHOR 
Joey Hess <id@joeyh.name>