https://github.com/mpclarkson/prompter

Capture user input at the command line on OSX and Linux
https://github.com/mpclarkson/prompter

Last synced: 26 days ago
JSON representation

Capture user input at the command line on OSX and Linux

• Host: GitHub
• URL: https://github.com/mpclarkson/prompter
• Owner: mpclarkson
• License: mit
• Created: 2016-01-12T04:42:44.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-13T01:24:29.000Z (almost 9 years ago)
• Last Synced: 2024-09-14T05:25:38.319Z (about 2 months ago)
• Language: Swift
• Size: 210 KB
• Stars: 15
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Prompter - Capture Command Line Input with Swift

[![CI Status](http://img.shields.io/travis/mpclarkson/Prompter.svg?style=flat)](https://travis-ci.org/hilenium/Prompter)

[![Version](https://img.shields.io/cocoapods/v/Prompter.svg?style=flat)](http://cocoapods.org/pods/Prompter)

[![License](https://img.shields.io/cocoapods/l/Prompter.svg?style=flat)](http://cocoapods.org/pods/Prompter)

[![Platform](https://img.shields.io/cocoapods/p/Prompter.svg?style=flat)](http://cocoapods.org/pods/Prompter)

Prompter is lightweight Swift 2+ library that greatly simplifies capturing user input for command line (cli) applications on OSX and Linux.

Specifically, it allows you to prompt the user for input and validate that responses are (currently) `String`, `Int`, `Bool`, or a valid single choice from a given list.

## Installation

### Swift Package Manager

To add Prompter via the SPM, add the following to your `Package.swift` file:

```swift

let package = Package(

    name: "YourPackageName"

    dependencies: [

        .Package(url: "https://github.com/mpclarkson/Prompter.git", majorVersion: 1),

    ]

)

```

### CocoaPods

Prompter is available through [CocoaPods](http://cocoapods.org).

To install it, simply add the following line to your Podfile:

```ruby

pod "Prompter"

```

## Instructions

### Documentation

This library is well documented. View the [documentation](https://mpclarkson.github.io/Prompter/).

### Overview

Each `ask` method includes the following arguments:

- `question` - required

- `message` - optional string to override the default validation message

- `block` - an optional closure that is called on success

```swift

import Prompter

let prompt = Prompt()

//Prompt the user for a string input

let name = prompt.askString("What is your name?",

  message: "This is an optional validation message!") { string in

  //this is an optional block

}

//Prompt the user for a string input

let age = prompt.askInt("How old are you?")

//Prompt the user for a Boolean response

//y, Y, Yes, yes, t, True, 1 are all true etc

let age = prompt.askBool("Do you like beans")

//Ask the user to select from a list of choices

let choices = ["beans", "apples"]

let age = prompt.askChoice("Which of these do you prefer",

  choices: choices) { (index, string) in

    print(index, string)

    //0, beans

 }

```

## Todo

- askDate

- askMultiple

- initWithStyle

##Tests

Run the tests using xctool:

```bash

xctool -workspace Prompter.xcworkspace -scheme Prompter test

```

## Author

Matthew Clarkson from [Hilenium](http://hilenium.com) [@matt_clarkson](https://twitter.com/matt_clarkson)

## License

Prompter is available under the MIT license. See the LICENSE file for more info.