Metadata-Version: 2.1
Name: cli-confirm
Version: 1.0.0
Summary: CLI utility to confirm yes/no.
Home-page: https://github.com/tueda/cli-confirm
License: MIT
Keywords: console,confirmation
Author: Takahiro Ueda
Author-email: takahiro.ueda@yahoo.com
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.0,<8.0)
Project-URL: Repository, https://github.com/tueda/cli-confirm
Description-Content-Type: text/markdown

cli-confirm
===========

[![Test](https://github.com/tueda/cli-confirm/workflows/CI/badge.svg?branch=master)](https://github.com/tueda/cli-confirm/actions?query=branch:master)
[![PyPI version](https://badge.fury.io/py/cli-confirm.svg)](https://pypi.org/project/cli-confirm/)

A CLI utility to confirm yes/no.


Installation
------------

```sh
pip install cli-confirm
```


Example
-------

```sh
confirm 'Are you sure?'
```
which shows a prompt to ask yes/no:
```
Are you sure? [y/N]:
```
If the user answers "yes", then it returns a zero exit status.
It returns a non-zero exit status otherwise.


Motivation
----------

This utility can be used in a combination with [taskipy](https://github.com/illBeRoy/taskipy) as follows:

```toml
[tool.taskipy.tasks]
deploy = "confirm 'Are you sure to deploy?' && mkdocs gh-deploy"
```


License
-------

[MIT](https://github.com/tueda/cli-confirm/blob/master/LICENSE)

