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 (if compiled with libreadline). Forked from [taskshell](https://github.com/GothenburgBitFactory/taskshell).
   4
   5 ## Usage
   6 See `gen-shell --help`
   7
   8 ## Installation
   9 ### From a binary
  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 (any somewhat recent version is fine)
  19   - libreadline development files (7 or 8 is fine, 5 is untested) (optional, but highly reccomended)
  20
  21 On a Debian or Ubuntu based distribution, you can install these dependencies with this command:
  22 ```bash
  23 sudo apt update && sudo apt install cmake make gcc g++ cpp libreadline-dev
  24 ```
  25 Then download and build gen shell:
  26 ```bash
  27 git clone --recursive https://codeberg.org/armaan/gen-shell
  28 cd gen-shell
  29 cmake .
  30 sudo make install
  31 ```
  32 ### Docker
  33 You can also run gen-shell in docker. Simply use
  34 ```bash
  35 docker run -it -e command=<command> -e before_command=<before command> -e after_command=<after command> -e custom_prompt=<custom prompt> armaanb/gen-shell
  36 ```
  37 Or to build the docker container locally, run:
  38 ```bash
  39 git clone --recursive https:/codeberg.org/armaan/gen-shell
  40 cd gen-shell
  41 docker build --no-cache -t gen-shell:latest .
  42 ```
  43 ## License
  44 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).
  45
  46 Gen-shell uses the [Sarge library](https://github.com/MayaPosch/Sarge) for parsing command-line arguments. Sarge was written by Maya Posch and is BSD 3-Clause licensed. It is added as a submodule in the root folder of this repository.