Skip to content

Commit c739ba7

Browse files
committed
Rename webrepl_cli to webrepl_scp to avoid confusion
1 parent d99f456 commit c739ba7

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
webrepl_content.js
2+
__pycache__
3+
*.pyc

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ connections. As WebREPL is intended to be used only within a user's
2424
local network, HTTPS isn't strictly required, and not accessing
2525
webrepl.html over HTTPS is a suggested workaround.
2626

27+
WebREPL remote console
28+
----------------------
29+
30+
The webrepl.py script can be used to connect from remote to a device.
31+
Run
32+
33+
webrepl_scp.py --help
34+
35+
to see usage information. Note that you will need the python websocket_client
36+
module.
37+
2738
WebREPL file transfer
2839
---------------------
2940

@@ -32,14 +43,14 @@ This feature is currently in alpha and has known issues on systems
3243
which have it enabled (ESP8266).
3344

3445
To use WebREPL file transfer capabilities, a separate command line
35-
utility is provided, webrepl_cli.py (file transfer is not supported
46+
utility is provided, webrepl_scp.py (file transfer is not supported
3647
via webrepl.html client). Run
3748

38-
webrepl_cli.py --help
49+
webrepl_scp.py --help
3950

4051
to see usage information. Note that there can be only one active
4152
WebREPL connection, so while webrepl.html is connected to device,
42-
webrepl_cli.py can't transfer files, and vice versa.
53+
webrepl_scp.py can't transfer files, and vice versa.
4354

4455

4556
Technical details
@@ -102,7 +113,7 @@ This protocol uses WebSocket "binary"-flagged messages. At this point,
102113
this protocol is in early research/design/proof-of-concept phase. The
103114
only available specification of it is the reference code implementation,
104115
and the protocol is subject to frequent and incompatible changes.
105-
The `webrepl_cli.py` module mentioned above intended to be both a
116+
The `webrepl_scp.py` module mentioned above intended to be both a
106117
command-line tool and a library for 3rd-party projects to use, though
107118
it may not be there yet. If you're interested in integrating WebREPL
108119
transfer/control capabilities into your application, please submit
File renamed without changes.

0 commit comments

Comments
 (0)