AlecAivazis/surveyArchived
Survey
Survey is a Go interactive prompt library and terminal user interface toolkit used to build command line interfaces that collect structured data. It provides a framework for rendering keyboard-navigable menus and forms across different operating systems.
The toolkit includes components for gathering user confirmation, capturing text and password entries, and presenting paginated lists of choices. It supports multi-line input by integrating with the system's external text editor and provides contextual help displays to guide users.
The library implements input validation logic to ensure responses meet specific rules before they are processed. It handles the underlying terminal abstraction for POSIX and Windows environments, using raw-mode input and ANSI rendering to create an interactive prompting experience.
Features
- Interactive Prompt Toolkits - A comprehensive Go toolkit for building interactive TUIs with selectable lists, text input, and validation.
- Terminal User Interface Frameworks - Provides a framework and set of components for building interactive, text-based user interfaces and forms within a terminal.
- CLI Confirmation Prompts - Provides a specialized terminal utility for capturing binary yes/no confirmations from users.
- Command-Line Input Toolkits - Ships a collection of visual input controls specifically designed for structured data collection in terminals.
- Interactive Input Collecters - Facilitates the sequential gathering of multiple user responses into a structured data format.
- CLI Input Validation - Implements rules and constraints to verify command-line input and request retries for invalid data.
- Selection Lists - Provides paginated, keyboard-navigable lists for selecting one or multiple options in the terminal.
- User Input Capture - Captures single-line strings, multi-line blocks, and obscured password entries through interactive prompts.
- Cross-Platform Terminal Abstractions - Provides a unified API that abstracts the differences between Windows console APIs and POSIX terminal codes.
- ANSI Escape Sequence Renderers - Implements raw terminal control codes to manage cursor movement and text styling for interactive interfaces.
- Prompt Interaction State Machines - Uses a deterministic state machine to manage the sequence of input, validation, and re-rendering in prompts.
- External Editor Integration - Integrates external system editors into the prompt flow for capturing long-form text input.
- External Editor Integrations - A CLI utility that opens a temporary file in the system text editor to capture complex multi-line input.
- Custom Logic Validation - Allows developers to define custom functional logic to validate user input beyond simple pattern matching.
- Raw Mode Input Handlers - Disables terminal line buffering and echo to capture individual keystrokes for real-time navigation.
- Terminal Interface Design - Provides a framework for creating structured and accessible layouts that guide users through data entry steps.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
