https://github.com/gashmob/yeschief
C++ library helping you to easily create and manage options and commands of your CLI
https://github.com/gashmob/yeschief
cli cpp cpp23
Last synced: 3 months ago
JSON representation
C++ library helping you to easily create and manage options and commands of your CLI
- Host: GitHub
- URL: https://github.com/gashmob/yeschief
- Owner: Gashmob
- License: mit
- Created: 2025-02-19T20:09:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-20T21:27:22.000Z (over 1 year ago)
- Last Synced: 2025-02-20T21:33:58.954Z (over 1 year ago)
- Topics: cli, cpp, cpp23
- Language: HTML
- Homepage: https://gashmob.github.io/YesChief/
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# YesChief!
[](https://opensource.org/licenses/MIT)
C++ library helping you to easily create manage options and commands of your CLI.
## Use it in your project
You can retrieve rpm/deb package attached to [latest release](https://github.com/Gashmob/YesChief/releases/latest).
Devel packages are also build for each push to master branch in [package workflow](https://github.com/Gashmob/YesChief/actions/workflows/package.yml?query=branch%3Amaster).
A nix flake package is also available inside [flake.nix](./flake.nix).
For CMake based projects, you can simply use `FetchContent` this way:
```cmake
FetchContent_Declare(
yeschief
GIT_REPOSITORY https://github.com/Gashmob/YesChief.git
GIT_TAG v1.0.0
)
FetchContent_GetProperties(yeschief)
if(NOT yeschief_POPULATED)
message(STATUS "Fetching yeschief...")
FetchContent_Populate(yeschief)
add_subdirectory(${yeschief_SOURCE_DIR})
endif()
target_link_libraries(my_target PUBLIC yeschief)
```
Then the include path is just `#include `
## Building
All following commands should be run inside a `nix-shell`, it allows you to have all needed tools and binary in your PATH.
Entire project is based on cmake. So you can just run cmake as for every cmake project.
Or you can run a pre-defined script:
```shell
build_release
```
## Testing
```shell
run_unit_tests
```
You can then get coverage of these tests with:
```shell
build_coverage
```