README.md

   1 # gen-shell
   2 ![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fbuild.bhojwani.org%2Fjob%2Fgen-shell%2F)
   3 A simple way to turn any command into a shell with arrow key/history support. This is a fork of [taskshell](https://github.com/GothenburgBitFactory/taskshell) with a highly reduce codebase.
   4
   5 ## Usage
   6 Just put the command that you want to repeat after `gen-shell`, eg; `gen-shell ls`, or even something much more complex like `gen-shell "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words` This command was actually the inspiration for gen-shell.
   7
   8 ## Installation
   9 ### Binaries
  10 Binaries can be downloaded [from here](https://build.bhojwani.org/job/gen-shell/lastSuccessfulBuild/artifact/build/src/gen-shell). NB: these binaries are compiled against libreadline7, so if your system only has libreadline8, you can symlink 8 to 7 with `sudo ln -s /usr/lib/x86_64-linux-gnu/libreadline.so.8.0 /usr/lib/x86_64-linux-gnu/libreadline.so.7`. This isn't a great solution, but it gets the job done.
  11
  12 ### From source
  13 If you would like to avoid this, you can build from source. Doing so requires:
  14   - cmake (2.8 or higher)
  15   - make
  16   - gcc
  17   - g++ (sometimes packaged as gcc-c++ or gcc-g++)
  18   - cpp (11 or higher)
  19   - libreadline development files (7 or 8 is fine, 5 is untested)
  20 ```bash
  21 git clone https://codeberg.org/armaan/gen-shell
  22 cd gen-shell
  23 cmake .
  24 make
  25 sudo cp src/gen-shell /usr/bin/
  26 ```
  27 Or if you don't have root access, you can subsitute the last line with
  28 `cp src/gen-shell ~/.local/bin`
  29
  30 ### Docker
  31 You can also run gen-shell in docker. Simply use
  32 ```bash
  33 docker run -it -e CMD=<command-to-run> armaanb/gen-shell:latest
  34 ```
  35 Or to build the docker container locally
  36 ```bash
  37 git clone https://codeberg.org/armaan/gen-shell
  38 cd gen-shell
  39 docker build -t armaanb/gen-shell:latest .
  40 docker run -it -e CMD=<command-to-run> armaanb/gen-shell
  41 ```
  42 ## License
  43 Following suit from tasksh, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from tasksh, from which its codebase has been greatly reduced, although the majority of code remaining was written by the tasksh developers [(listed here)](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).
  44
  45 Gen-shell uses [Sarge](https://github.com/MayaPosch/Sarge) for parsing command-line arguments. Sarge was written by Maya Posch and is BSD 3-Clause licensed