{"id":25871129,"url":"https://github.com/gashmob/enquirer","last_synced_at":"2026-06-07T02:31:48.080Z","repository":{"id":132829704,"uuid":"564886624","full_name":"Gashmob/Enquirer","owner":"Gashmob","description":"Interactive CLI library","archived":false,"fork":false,"pushed_at":"2024-05-14T13:27:04.000Z","size":8267,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-14T14:41:46.510Z","etag":null,"topics":["cli","cpp","enquirer","interactive"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gashmob.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-11T18:30:05.000Z","updated_at":"2024-05-14T13:27:08.000Z","dependencies_parsed_at":"2024-01-13T12:13:16.972Z","dependency_job_id":"e6fe7b44-18c3-4e9a-9b5f-8e94995b5511","html_url":"https://github.com/Gashmob/Enquirer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gashmob%2FEnquirer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gashmob%2FEnquirer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gashmob%2FEnquirer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gashmob%2FEnquirer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gashmob","download_url":"https://codeload.github.com/Gashmob/Enquirer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241470357,"owners_count":19968039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cpp","enquirer","interactive"],"created_at":"2025-03-02T06:35:28.855Z","updated_at":"2025-03-02T06:35:32.013Z","avatar_url":"https://github.com/Gashmob.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Enquirer\n\n[![Tests](https://github.com/Gashmob/Enquirer/actions/workflows/test.yml/badge.svg)](https://github.com/Gashmob/Enquirer/actions/workflows/test.yml)\n\nA collection of function to make an interactive CLI. Inspired by [Enquirer.js](https://www.npmjs.com/package/enquirer).\n\n**Full demo**\n\n![Full demo](medias/full_demo.gif)\n\n- [Use it in your project](#use-it-in-your-project)\n- [Usage](#usage)\n    - [Auth](#auth)\n    - [Autocomplete](#autocomplete)\n    - [Confirm](#confirm)\n    - [Form](#form)\n    - [Input](#input)\n    - [Invisible](#invisible)\n    - [List](#list)\n    - [MultiSelect](#multiselect)\n    - [Number](#number)\n    - [Password](#password)\n    - [Quiz](#quiz)\n    - [Slider](#slider)\n    - [Select](#select)\n    - [Toggle](#toggle)\n- [Tests](#tests)\n\nHave use [Terminalizer](https://github.com/faressoft/terminalizer) to record the demo.\n\n## Use it in your project\n\nFor CMake based projects, you can simply use `FetchContent` this way:\n\n```cmake\nFetchContent_Declare(\n        enquirer\n        GIT_REPOSITORY https://github.com/Gashmob/Enquirer.git\n        GIT_TAG v1.0.2\n)\nFetchContent_GetProperties(enquirer)\n\nif(NOT enquirer_POPULATED)\n    message(STATUS \"Fetching enquirer...\")\n    FetchContent_Populate(enquirer)\n    add_subdirectory(${enquirer_SOURCE_DIR} ${enquirer_BINARY_DIR})\nendif()\n\ntarget_link_libraries(my_target PUBLIC enquirer)\n```\n\nThen the include path is just `#include \u003cenquirer.h\u003e`\n\n## Usage\n\nPlease note :\n\n- All functions are in the `enquirer` namespace.\n- All functions are synchronous (wait until user submit).\n\nYou can try the demo by building the `demo` target.\n\n### Auth\n\nAsk the user for username and password.\n\n**Prototypes**\n\nThere is 2 prototypes :\n\n1. Returns the username and password as a `std::pair`\n2. Takes a predicate as arguments and return its result.\n\n```c++\nstd::pair\u003cstd::string, std::string\u003e auth(const std::string \u0026id_prompt = \"Username\",\n                                         const std::string \u0026pw_prompt = \"Password\",\n                                         char mask = '*');\n\nbool auth(const std::function\u003cbool(const std::pair\u003cstd::string, std::string\u003e \u0026)\u003e \u0026predicate,\n          const std::string \u0026id_prompt = \"Username\",\n          const std::string \u0026pw_prompt = \"Password\",\n          char mask = '*');\n```\n\n**Example**\n\n```c++\nbool is_valid = enquirer::auth([](const std::pair\u003cstd::string, std::string\u003e \u0026credentials) {\n    return credentials.first == \"admin\"\n           \u0026\u0026 credentials.second == \"admin\";\n});\n```\n\n**Result**\n\n![Auth](medias/auth.gif)\n\n### Autocomplete\n\nPrompt the question and autocomplete the answer with a list of choices.\n\n**Prototype**\n\n```c++\nstd::string autocomplete(const std::string\u0026 question,\n                         const std::string choices[] = {},\n                         int limit = 10);\n```\n\n**Example**\n\n```c++\nstd::string answer = enquirer::autocomplete(\"What is you favorite fruit\", {\n    \"Apple\",\n    \"Banana\",\n    \"Blueberry\",\n    \"Cherry\",\n    \"Orange\",\n    \"Pear\",\n    \"Raspberry\",\n    \"Strawberry\"\n});\n```\n\n**Result**\n\n![Autocomplete](medias/autocomplete.gif)\n\n### Confirm\n\nAsk the user to confirm.\n\n**Prototype**\n\n```c++\nbool confirm(const std::string \u0026question,\n             bool default_value = false);\n```\n\n**Example**\n\n```c++\nbool quit = false;\nwhile (!quit) {\n    quit = enquirer::confirm(\"Do you want to quit?\");\n}\n```\n\n**Result**\n\n![Confirm](medias/confirm.gif)\n\n### Form\n\nMulti-prompt for user\n\n**Prototype**\n\n```c++\nstd::map\u003cstd::string, std::string\u003e form(const std::string \u0026question,\n                                        const std::vector\u003cstd::string\u003e \u0026inputs);\n```\n\n**Example**\n\n```c++\nauto answers = enquirer::form(\"Please provide some informations:\", {\n        \"Firstname\",\n        \"Lastname\",\n        \"Username\"\n});\n```\n\n**Result**\n\n![Form](medias/form.gif)\n\n### Input\n\nPrompt the question and return the answer.\n\n**Prototype**\n\n```c++\nstd::string input(const std::string \u0026question,\n                  const std::string \u0026default_value = \"\");\n```\n\n**Example**\n\n```c++\nstd::string answer = enquirer::input(\"What is your name?\", \"John Doe\");\n```\n\n**Result**\n\n![Input](medias/input.gif)\n\n### Invisible\n\nHides the user input\n\n**Prototype**\n\n```c++\nstd::string invisible(const std::string \u0026question);\n```\n\n**Example**\n\n```c++\nstd::string secret = enquirer::invisible(\"What is your secret?\");\n```\n\n**Result**\n\n![Invisible](medias/invisible.gif)\n\n### List\n\nSame as [Input](#input), but split the user input around `,`.\n\n**Prototype**\n\n```c++\nstd::vector\u003cstd::string\u003e list(const std::string \u0026question);\n```\n\n**Example**\n\n```c++\nauto keywords = enquirer::list(\"Type comma separated keywords\");\n```\n\n**Result**\n\n![List](medias/list.gif)\n\n### MultiSelect\n\nAllow user to select several items from a list\n\n**Prototype**\n\n```c++\nstd::vector\u003cstd::string\u003e multi_select(const std::string \u0026question,\n                                      const std::vector\u003cstd::string\u003e \u0026choices);\n```\n\n**Example**\n\n```c++\nauto choices = enquirer::multi_select(\"Choose some colors\", {\n    \"Red\",\n    \"Green\",\n    \"Blue\",\n    \"Yellow\",\n    \"Magenta\",\n    \"Cyan\",\n    \"White\",\n    \"Black\"\n});\n```\n\n**Result**\n\n![MultiSelect](medias/multiselect.gif)\n\n### Number\n\nAsk the user for a number\n\n**Prototype**\n\n```c++\ntemplate\u003ctypename N,\n        typename = typename std::enable_if\u003cstd::is_arithmetic\u003cN\u003e::value\u003e::type\u003e\nN number(const std::string \u0026question);\n```\n\n**Example**\n\n```c++\nauto pi = enquirer::number\u003cdouble\u003e(\"What is the value of PI?\");\n```\n\n**Result**\n\n![Number](medias/number.gif)\n\n### Password\n\nMask the user input with `*`.\n\n**Prototype**\n\n```c++\nstd::string password(const std::string \u0026question,\n                     char mask = '*');\n```\n\n**Example**\n\n```c++\nauto pwd = enquirer::password(\"What is your password?\");\n```\n\n**Result**\n\n![Password](medias/password.gif)\n\n### Quiz\n\nMulti-choice quiz !\n\n**Prototype**\n\n```c++\nbool quiz(const std::string \u0026question,\n          const std::vector\u003cstd::string\u003e \u0026choices,\n          const std::string \u0026correct);\n```\n\n**Example**\n\n```c++\nif (enquirer::quiz(\"Which is yellow?\", {\"Banana\", \"Coconut\", \"Strawberry\"}, \"Banana\"))\n    std::cout \u003c\u003c \"Good answer!\" \u003c\u003c std::endl;\nelse\n    std::cout \u003c\u003c \"Bad answer!\" \u003c\u003c std::endl;\n```\n\n**Result**\n\n![Quiz](medias/quiz.gif)\n\n### Slider\n\nAllow user to choose a value in a range.\n\n**Prototype**\n\n```c++\ntemplate\u003ctypename N,\n        typename = typename std::enable_if\u003cstd::is_arithmetic\u003cN\u003e::value\u003e::type\u003e\nN slider(const std::string \u0026question,\n         N min_value,\n         N max_value,\n         N step,\n         N initial_value);\n```\n\n**Example**\n\n```c++\nint value = enquirer::slider\u003cint\u003e(\"How much do you want?\", 0, 10, 1, 1);\n```\n\n**Result**\n\n![Slider](medias/slider.gif)\n\n### Select\n\nChoose one item from a list.\n\n**Prototype**\n\n```c++\nstd::string select(const std::string \u0026question,\n                   const std::vector\u003cstd::string\u003e \u0026choices);\n```\n\n**Example**\n\n```c++\nauto language = enquirer::select(\"Which is the best one?\", {\n        \"c++\",\n        \"python\",\n        \"java\"\n});\n```\n\n**Result**\n\n![Select](medias/select.gif)\n\n### Toggle\n\nChoose between two values.\n\n**Prototype**\n\n```c++\nbool toggle(const std::string \u0026question,\n            const std::string \u0026enable,\n            const std::string \u0026disable,\n            bool default_value = false);\n```\n\n**Example**\n\n```c++\nbool light = enquirer::toggle(\"Light?\", \"On\", \"Off\", true);\n```\n\n**Result**\n\n![Toggle](medias/toggle.gif)\n\n## Tests\n\nAll tests are run for each push via [GitHub Actions](https://github.com/Gashmob/Enquirer/actions) on Ubuntu and macOS.\nThe tests sources are located in `tests/test.cpp` and use\na [simple c++ test framework](https://github.com/Gashmob/Cpp-Tests). You can run the tests by building the `test`\ntarget.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgashmob%2Fenquirer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgashmob%2Fenquirer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgashmob%2Fenquirer/lists"}