You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# JSShell
2
2
3
-
An interactive multi-user web based shell written in Python with Flask (for server side) and of course Javascript and HTML (client side). It was initally created in order to debug remote isoteric browsers during tests and research. I am well aware of other purposes this tool might serve, use it at your own responabilty and risk.
3
+
An interactive multi-user web based JS shell written in Python with Flask (for server side) and of course Javascript and HTML (client side). It was initially created to debug remote esoteric browsers during tests and research. I'm aware of other purposes this tool might serve, use it at your own responsibility and risk.
If you running localy, then navigate to `http://localhost:5000` (port can be changed)
46
+
If you running localy, then navigate to `http://localhost:5000` (port and host can of course be changed)
47
47
48
48
### Open the interactive shell
49
49
```python
@@ -56,7 +56,7 @@ Those are scripts that will execute on every registration of a new client. Use t
56
56
##### Profit :)
57
57
58
58
### Usage
59
-
The shell interface contains various commands (can be reavealed using the `help` command).
59
+
The shell interface contains various commands (can be revealed using the `help` command).
60
60
```bash
61
61
╦╔═╗╔═╗┬ ┬┌─┐┬ ┬
62
62
║╚═╗╚═╗├─┤├┤ │ │
@@ -81,7 +81,7 @@ The shell interface contains various commands (can be reavealed using the `help`
81
81
82
82
```
83
83
Utilizing the command queue, you can fire mutliple commands and the client will execute them one by one.
84
-
All the commands are executed using a single context, so you issue mutiple related commands.
84
+
All the commands are executed using a single context, so all of the commands are aware of each other (same scope).
85
85
86
86
To view the commands issued to a client, first selecta client:
87
87
```python
@@ -100,23 +100,23 @@ To view the full command and it's full output (on the `coms` command the output
100
100
## Workflow
101
101
After all the installations and configuration is done, the workflow of the application is the following:
102
102
103
-
1. Client visits the home page `http://localhost:5000/`
103
+
1. Client visits the home page `http://localhost:5000/` (or the host you chose)
104
104
105
-
2. He makes a `register` request to the server
105
+
2. The client makes an asynchronous `register` request to the server
106
106
107
-
3. Waits for commands
107
+
3. Then he waits for commands
108
108
109
109
4. In the meanwhile, on the server, you execute commands using the `shell.py` script
110
110
111
-
5. The client probes the server for commands, see a new one appeared, pulls it and executes it
111
+
5. The client probes the server for commands, when he sees a new one appeared, he pulls it and executes it
112
112
113
113
6. Once he's done executing, he will post back the result to the server
114
114
115
-
7. Now, using the `coms` command, we can see the output for that command
115
+
7. Now, using the `coms` command, you can see the output for that command
116
116
117
117
118
118
## Database Handling
119
-
I have included a script that i've been using during tests, which is the `db_handler.py` file. It includes varius function to handle and test your database.
119
+
I have included a script that I've been using during tests, which is the `db_handler.py` file. It includes varius function to handle and test your database.
0 commit comments