aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 946e45eb01f8ba309210819b79c372c0c8c5a9b2 (plain)
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
extreload
=========

Reload Chrome extensions from the command line. Facilitates Chrome extension
development.

Communicates with Chrome over the [DevTools Protocol].


## Usage
Chrome must be started with the `--remote-debugging-port` flag to enable the
DevTools Protocol, and the `--silent-debugger-extension-api` flag to allow debug
access to extensions. On Mac OS X:

	$ /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome \
		--silent-debugger-extension-api \
		--remote-debugging-port=0 &

When Chrome is launched, the DevTools Protocol socket URL will be printed to the
console. That WebSocket URL must be passed to `extreload` with the
`--socket-url` argument. For example:

	$ extreload \
		--socket-url ws://127.0.0.1:55755/devtools/browser/208ae571-d691-4c98-ad41-3a15d507b656 \
		--reload-current-tab \
		ooeilikhhbbkljfdhbglpalaplegfcmj


## Install
On Mac OS X, the program can be installed with Homebrew:

	$ brew install teddywing/formulae/extreload

Pre-built binaries for Mac OS X and Linux can be found on the [releases page].


## Build
I’ve only tested the build with SBCL.

	$ git submodule init && git submodule update
	$ make build


## License
Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).


[DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
[releases page]: https://github.com/teddywing/extreload/releases