Skip to content

Commit 01b9292

Browse files
committed
Update README.md
1 parent b835023 commit 01b9292

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
A minimalist [Flask](https://github.com/pallets/flask) extension that serves as a REST API wrapper for python's subprocess API.<br/>
66

77
- **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.
910

1011
Inspired by the work of awesome folks over at [msoap/shell2http](https://github.com/msoap/shell2http).
1112

@@ -14,6 +15,7 @@ Inspired by the work of awesome folks over at [msoap/shell2http](https://github.
1415
- Set a script that runs on a succesful POST request to an endpoint of your choice. See [Example code](examples/run_script.py).
1516
- Map a base command to an endpoint and pass dynamic arguments to it. See [Example code](examples/basic.py).
1617
- 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).
1719
- Currently, all commands are run asynchronously, so result is not available directly. An option would be provided for this in future release.
1820

1921
> 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

Comments
 (0)