diff --git a/README.md b/README.md index ad2a500..e0270b7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ # REPLmk +[![Build](https://github.com/bira/replmk/actions/workflows/build.yml/badge.svg)] + Friendly custom REPL building tool !! Beta version !! +![image](assets/replmk1.png) + ## Features - Custom commands definitions via configuration files - Save and restore command and output history + ## Usage The simplest way to starting a REPL is just by, well, typing `replmk` in the terminal. @@ -50,6 +55,11 @@ You can also specify a file to save and load the command history as well as the -o, --output-history-file arg -> Optional path to a file where to save the output history ``` +If not specified, the default values for those arguments are: + +- Command history file: `~/.replmk_history` +- Output history file: `~/.replmk_output_history` + ## Installation from source Requirements: @@ -65,3 +75,13 @@ make -C build ``` The binary will be in `build/src/replmk` + +## Dependencies + +Many thanks to the people who created the great libraries and tools in use by this project. Here is a list of them: + +- [doctest](https://github.com/doctest/doctest) +- [yaml-cpp](https://github.com/jbeder/yaml-cpp.git) +- [cxxopts](https://github.com/jarro2783/cxxopts.git) +- [ftxui](https://github.com/ArthurSonzogni/FTXUI.git) +- and of course, [CMake](https://cmake.org/) and your favourite C++ Compiler \ No newline at end of file diff --git a/assets/replmk1.png b/assets/replmk1.png new file mode 100644 index 0000000..7fff4f1 Binary files /dev/null and b/assets/replmk1.png differ diff --git a/examples/simple.yaml b/examples/simple.yaml index 898a64c..bff377a 100644 --- a/examples/simple.yaml +++ b/examples/simple.yaml @@ -17,8 +17,8 @@ commands: description: "Lists all environment variables" type: single exec: "env" - - name: ot - description: "Test stdout and stderr. Ah, end shell scripts" + - name: example_output + description: "Example using stdout and stderr" type: shell exec: | #!/bin/bash @@ -26,16 +26,12 @@ commands: echo "received args $@" for arg in "$@"; do - echo "arg: $arg" + echo "argument: $arg" done sleep 2 - echo "it's working" + echo "running..." sleep 2 echo "and this goes to stderr" 1>&2 sleep 2 echo "bye" - sleep 2 - - name: jqt - description: "jq test" - type: "shell" - exec: "echo '{\"a\": 1, \"b\": 2}' | jq ." \ No newline at end of file + sleep 2 \ No newline at end of file