Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synrc/exe
🖥️ EXE: Shell Exec
https://github.com/synrc/exe
exec shell
Last synced: 10 days ago
JSON representation
🖥️ EXE: Shell Exec
- Host: GitHub
- URL: https://github.com/synrc/exe
- Owner: synrc
- License: isc
- Created: 2014-05-10T20:13:37.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T02:39:46.000Z (12 months ago)
- Last Synced: 2024-04-14T05:33:39.223Z (7 months ago)
- Topics: exec, shell
- Language: Erlang
- Homepage: https://exe.n2o.dev
- Size: 65.4 KB
- Stars: 36
- Watchers: 3
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sh: your unix gateway
[](https://hex.pm/packages/exe)
Family of functions and ports to interact with system shell, paths and external programs.
## Avoid `os:cmd/1` on user input!
```erlang
> Email = "proger+/&reboot%[email protected]". % valid email!
> os:cmd(["mkdir -p ", Email]).
% path clobbering and a reboot may happen here!
```
## Examples
### Onliners
```erlang
> sh:oneliner(["touch", filename:join("/tmp/", Path)]).
{done,0,<<>>}
> sh:oneliner("uname -mnprs").
{done,0,<<"Darwin mac 18.2.0 x86_64 i386">>}
> sh:oneliner("git describe --always").
{done,128,<<"fatal: Not a valid object name HEAD">>}
> sh:oneliner("git describe --always", "/tank/proger/vxz/otp").
{done,0,<<"OTP_R16B01">>}
```
### Escaping
```erlang
> Path = sh_path:escape("email+=/[email protected]").
"email+=%[email protected]"
```
### Run
```erlang
> sh:run(["git", "clone", "https://github.com/proger/darwinkit.git"], binary, "/tmp").
{done,0,<<"Cloning into 'darwinkit'...\n">>}
> UserUrl = "https://github.com/proger/darwinkit.git".
"https://github.com/proger/darwinkit.git"
> sh:run(["git", "clone", UserUrl], binary, "/tmp").
{done,128,
<<"fatal: destination path 'darwinkit' already exists and is not an empty directory.\n">>}
> sh:run(["ifconfig"], "/tmp/output.log", "/tank/proger/vxz/otp").
{done,0,"/tmp/output.log"}
% cat /tmp/output.log
>>> {{2013,8,28},{8,39,14}} /sbin/ifconfig
lo0: flags=8049 mtu 16384
options=3
inet6 fe80::1%lo0 prefixlen 64 scopeid 0x1
inet 127.0.0.1 netmask 0xff000000
inet6 ::1 prefixlen 128
gif0: flags=8010 mtu 1280
stf0: flags=0<> mtu 1280
en0: flags=8863 mtu 1500
ether 7c:d1:c3:e9:24:65
inet6 fe80::7ed1:c3ff:fee9:2465%en0 prefixlen 64 scopeid 0x4
inet 192.168.63.163 netmask 0xfffffc00 broadcast 192.168.63.255
media: autoselect
status: active
p2p0: flags=8843 mtu 2304
ether 0e:d1:c3:e9:24:65
media: autoselect
status: inactive
>>> {{2013,8,28},{8,39,14}} exit status: 0
```
## fdlink: make sure your ports exit when you exit
Consider a case of spawning a port that does not actually
read its standard input (e.g. `socat` that bridges `AF_UNIX` with `AF_INET`):
```shell
# pstree -A -a $(pgrep beam.smp)
beam.smp -- -root /usr/lib/erlang -progname erl -- -home /root -- -pa ebin -config sys.config
|-socat tcp-listen:32133,reuseaddr,bind=127.0.0.1 unix-connect:/var/run/docker.sock
`-16*[{beam.smp}]
```
If you terminate the node, beam will close the port but the process
will still remain alive (thus, it will leak). To mitigate this issue,
you can use `fdlink` that tracks `stdin` availability for you:
### Usage
```erlang
> Fdlink = sh:fdlink_executable().
> erlang:open_port({spawn_executable, Fdlink},
[stream, exit_status, {args, ["/usr/bin/socat"|Args]}).
```
`fdlink` will also close the standard input of its child process.
## Credits
* Vladimir Kirillov
OM A HUM