X-Git-Url: https://git.armaanb.net/?p=gen-shell.git;a=blobdiff_plain;f=README.md;fp=README.md;h=3a62a96872a5a452421c44649e8e99483345741f;hp=481053d4e7edc3dd5a06969ae9c1cc2e7bdaeaca;hb=ed587e970f8083d69f5e4d07aba04ee7435f2e4c;hpb=e8d0a44ba528abc257a5f260922eff65b73bc5de diff --git a/README.md b/README.md index 481053d..3a62a96 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A simple way to turn any command into a shell with arrow key/history support (if compiled with libreadline). Forked from [taskshell](https://github.com/GothenburgBitFactory/taskshell). ## Usage -Just put the command that you want to repeat after the c flag, eg; `gen-shell -c ls`, or even something much more complex like `gen-shell -c "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words"` This command was actually the inspiration for gen-shell. +See `gen-shell --help` ## Installation ### From a binary @@ -27,23 +27,18 @@ Then download and build gen shell: git clone --recursive https://codeberg.org/armaan/gen-shell cd gen-shell cmake . -make -sudo cp src/gen-shell /usr/bin/ +sudo make install ``` -Or, if you don't have root access, you can subsitute the last line with -`cp src/gen-shell ~/.local/bin` - ### Docker You can also run gen-shell in docker. Simply use ```bash -docker run -it -e CMD= armaanb/gen-shell +docker run -it -e command= -e before_command= -e after_command= -e custom_prompt= armaanb/gen-shell ``` Or to build the docker container locally, run: ```bash git clone --recursive https:/codeberg.org/armaan/gen-shell cd gen-shell docker build --no-cache -t gen-shell:latest . -docker run -it -e CMD= gen-shell ``` ## License Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from taskshell, which was developed by [these people](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).