{"id":31893743,"url":"https://github.com/deans-bradley/promptly","last_synced_at":"2026-05-04T11:33:58.022Z","repository":{"id":316282118,"uuid":"1021367339","full_name":"deans-bradley/promptly","owner":"deans-bradley","description":"A modern C# library for building beautiful and interactive console applications with styled menus, input validation, progress indicators, and more.","archived":false,"fork":false,"pushed_at":"2025-09-23T20:59:20.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-13T09:24:43.171Z","etag":null,"topics":["console","csharp","dotnet","input-validation","library","menu","progress-bar","terminal","ui"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deans-bradley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-17T09:40:22.000Z","updated_at":"2025-09-23T20:59:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"9b645188-04a5-4977-8100-9dab1c3cc14b","html_url":"https://github.com/deans-bradley/promptly","commit_stats":null,"previous_names":["deans-bradley/promptly"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/deans-bradley/promptly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2Fpromptly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2Fpromptly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2Fpromptly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2Fpromptly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deans-bradley","download_url":"https://codeload.github.com/deans-bradley/promptly/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2Fpromptly/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32605804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["console","csharp","dotnet","input-validation","library","menu","progress-bar","terminal","ui"],"created_at":"2025-10-13T09:22:23.399Z","updated_at":"2026-05-04T11:33:58.016Z","avatar_url":"https://github.com/deans-bradley.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Promptly\n\nA modern, feature-rich C# library for building beautiful and interactive console applications with ease.\n\n## Overview\n\nPromptly is a comprehensive toolkit designed to simplify console application development in C#. It provides a clean, organized set of utilities for creating professional-looking menus, handling user input, displaying progress indicators, and managing console output with style.\n\n## Features\n\n- **Interactive Menus**: Create styled menus with customizable appearance, disabled options, and flexible navigation\n- **Input Validation**: Robust input handling with type-safe readers and validation utilities\n- **Progress Indicators**: Multiple animation styles including dots, spinners, and progress bars\n- **Message System**: Colored output messages with support for success, warning, and error states\n- **Utility Functions**: Common console operations like screen clearing, confirmations, and pause prompts\n\n## Installation\n\n[![NuGet](https://img.shields.io/nuget/v/Promptly.svg)](https://www.nuget.org/packages/Promptly/)\n\n### .NET CLI\n\n```bash\ndotnet add package Promptly\n```\n\n### NuGet Package Manager\n\n```bash\nInstall-Package Promptly\n```\n\n### PackageReference (Manual)\n\nAdd this to your `.csproj` file:\n\n```xml\n\u003cItemGroup\u003e\n  \u003cPackageReference Include=\"Promptly\" Version=\"1.0.4\" /\u003e\n\u003c/ItemGroup\u003e\n```\n\n**Package URL**: https://www.nuget.org/packages/Promptly/\n\n## Quick Start\n\n```csharp\nusing Promptly.UI;\nusing Promptly.Output;\nusing Promptly.Input;\nusing Promptly.Utilities;\n\nnamespace MyConsoleApp\n{\n    class Program\n    {\n        static void Main(string[] args)\n        {\n            Common.ClearScreen(\"Welcome to My App\");\n            \n            int choice = Menu.Show(\"Main Menu\", new[] \n            { \n                \"Start Process\", \n                \"View Settings\", \n                \"Help\" \n            });\n            \n            switch (choice)\n            {\n                case 1:\n                    MessageWriter.WriteSuccess(\"Process started!\");\n                    ProgressIndicator.ShowLoader(\"Processing\");\n                    break;\n                case 2:\n                    MessageWriter.WriteMessage(\"Opening settings...\");\n                    break;\n                case 3:\n                    MessageWriter.WriteMessage(\"Help documentation...\");\n                    break;\n                case 0:\n                    MessageWriter.WriteMessage(\"Goodbye!\");\n                    return;\n            }\n            \n            Common.Continue();\n        }\n    }\n}\n```\n\n## Documentation\n\n### Menu System\n\n#### Basic Menu\n```csharp\nint choice = Menu.Show(\"Choose an option\", new[] { \"Option 1\", \"Option 2\", \"Exit\" });\n```\n\n#### Styled Menu with Configuration\n```csharp\nMenuConfig config = new() \n{\n    Style = MenuStyle.Boxed,\n    TitleColor = ConsoleColor.Cyan,\n    AllowEscape = true\n};\n\nint choice = Menu.Show(\"Settings Menu\", options, config);\n```\n\n#### Advanced Menu with Descriptions\n```csharp\nMenuOption[] options =\n[\n    new(\"Process Data\", \"Processes the uploaded data files\"),\n    new(\"Generate Report\", \"Creates a summary report\"),\n    new(\"Advanced Settings\", \"Configure advanced options\") { IsEnabled = false }\n];\n\nint choice = Menu.Show(\"Advanced Menu\", options);\n```\n\n### Input Handling\n\n#### Basic Input\n```csharp\nstring name = InputReader.ReadInput(\"Enter your name: \");\nstring age = InputReader.ReadInt(\"Enter your age: \", 1, 120);\nstring email = InputReader.ReadRequiredInput(\"Enter email: \");\n```\n\n#### Input Validation\n```csharp\nif (InputValidator.IsValidEmail(email))\n{\n    MessageWriter.WriteSuccess(\"Valid email address!\");\n}\n```\n\n### Progress Indicators\n\n#### Simple Loader\n```csharp\nProgressIndicator.ShowLoader(\"Loading data\");\n```\n\n#### Spinner Animation\n```csharp\nProgressIndicator.ShowSpinner(\"Connecting to server\", 3000);\n```\n\n#### Progress Bar\n```csharp\nfor (int i = 0; i \u003c= 100; i++)\n{\n    ProgressIndicator.ShowProgressBar(i, 100);\n    Thread.Sleep(50);\n}\n```\n\n### Message Output\n\n#### Colored Messages\n```csharp\nMessageWriter.WriteSuccess(\"Operation completed successfully!\");\nMessageWriter.WriteWarning(\"This action cannot be undone.\");\nMessageWriter.WriteError(\"Connection failed. Please try again.\");\n```\n\n### Utility Functions\n\n#### Screen Management\n```csharp\nCommon.ClearScreen(\"Application Header\");\nCommon.Continue(); // Press any key to continue\n```\n\n#### User Confirmation\n```csharp\nif (Common.Confirm(\"Are you sure you want to delete this file?\"))\n{\n    // Perform deletion\n}\n```\n\n## Configuration Options\n\n### Menu Styles\n- `MenuStyle.None` - No styling\n- `MenuStyle.Simple` - Simple separator lines\n- `MenuStyle.Boxed` - Unicode box characters\n- `MenuStyle.Minimal` - Minimal styling with underlines\n\n### Progress Styles\n- `ProgressStyle.Dots` - Animated dots\n- `ProgressStyle.Spinner` - Rotating spinner\n- `ProgressStyle.Bar` - Progress bar with percentage\n- `ProgressStyle.Percentage` - Percentage only\n\n### Message Types\n- `MessageType.Info` - Standard information\n- `MessageType.Success` - Success notifications\n- `MessageType.Warning` - Warning messages\n- `MessageType.Error` - Error notifications\n\n## Requirements\n\n- .NET 9.0 or later\n- C# 10.0 or later\n\n## Project Structure\n\n```\nPromptly/\n├── Models/\n│   └── MenuOption.cs\n├── UI/\n│   ├── Menu.cs\n│   └── MenuStyles.cs\n├── Input/\n│   ├── InputReader.cs\n│   └── InputValidator.cs\n├── Output/\n│   ├── MessageWriter.cs\n│   └── ProgressIndicator.cs\n└── Utilities/\n    └── Common.cs\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Author\n\n**Bradley Deans**\nGitHub: [@deans-bradley](https://github.com/deans-bradley)\n\n## Contributing\n\nThis project is currently closed to contributions. However, feel free to fork the repository for your own use and modifications.\n\n## Changelog\n\n### Version 1.0.4\n- Fix icon packaging path issue for NuGet package\n- Add Promptly icon to package\n\n### Version 1.0.3\n- Add Promptly icon to `.csproj`\n- Initial release with core functionality\n- Menu system with multiple styling options\n- Input validation and handling\n- Progress indicators and animations\n- Message output with color support\n- Common utility functions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeans-bradley%2Fpromptly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeans-bradley%2Fpromptly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeans-bradley%2Fpromptly/lists"}