Noora CLI
Noora is a Swift package providing terminal UI components for building beautiful command-line interfaces.
[!NOTE]
The web component library has moved to the tuist/tuist monorepo (noora/ directory).
Quick Start
Installation:
.package(url: "https://github.com/tuist/Noora", .upToNextMajor(from: "0.15.0"))
Usage:
import Noora
Noora().yesOrNoChoicePrompt(
title: "Authentication",
question: "Would you like to authenticate?",
defaultAnswer: true,
description: "Authentication is required to use some CLI features."
)
The Noora CLI package provides Swift components for building beautiful terminal interfaces. It includes components for:
- Prompts: Interactive user input (yes/no choices, text input, single choice selection)
- Alerts: Status messages (success, warning, error notifications)
- Progress: Visual progress indicators (progress bars, step indicators)
- Text Styling: Consistent typography and formatting
Development
Prerequisites
- mise for tool management
Getting Started
# Install tools
mise install
Build
mise run build
Test
mise run test
Lint
mise run lint
Contributors
Thanks goes to these wonderful people (emoji key):
Finn Voorhees 💻 |
Vaishali Desai 💻 |
Nikita Vasilev 💻 |
Raul Menezes 💻 |
Mikhail 💻 |
Joannis Orlandos 💻 |
Zamderax 💻 |
Ryu 💻 |
Luca Büning 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
License
This project is licensed under the MIT License - see the LICENSE file for details.