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
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@
5
5
A minimalist [Flask](https://github.com/pallets/flask) extension that serves as a REST API wrapper for python's subprocess API.<br/>
6
6
7
7
-**Convert any command-line tool into a REST API service.**
8
-
- Execute shell commands asynchronously and safely from flask's endpoints.
8
+
- Execute pre-defined shell commands asynchronously and securely from flask's endpoints.
9
+
- Designed for development, prototyping or remote control.
9
10
10
11
Inspired by the work of awesome folks over at [msoap/shell2http](https://github.com/msoap/shell2http).
11
12
@@ -14,6 +15,7 @@ Inspired by the work of awesome folks over at [msoap/shell2http](https://github.
14
15
- Set a script that runs on a succesful POST request to an endpoint of your choice. See [Example code](examples/run_script.py).
15
16
- Map a base command to an endpoint and pass dynamic arguments to it. See [Example code](examples/basic.py).
16
17
- Can also process multiple uploaded files in one command. See [Example code](examples/multiple_files.py).
18
+
- This is useful for internal docker-to-docker communications if you have lots of different binaries. See [real-life example](https://github.com/intelowlproject/IntelOwl/blob/develop/integrations/peframe/app.py).
17
19
- Currently, all commands are run asynchronously, so result is not available directly. An option would be provided for this in future release.
18
20
19
21
> Note: This module is primarily meant for running long-running shell commands/scripts (like nmap, code-analysis' tools) in background and getting the result at a later time.
0 commit comments