# filepick

> File Picker for Command Line Applications

Latest version **0.0.1** (published 2017-08-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install filepick
pnpm add filepick
yarn add filepick
bun add filepick
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-08-02 |
| First published | 2017-08-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Wallace Coelho |
| Maintainers | wac2007 |
| Keywords | filebrowser, file, picker, browser, cli |

## Links

- npm: https://www.npmjs.com/package/filepick
- Repository: https://github.com/wac2007/filepick
- Homepage: https://github.com/wac2007/filepick#readme
- Issues: https://github.com/wac2007/filepick/issues
- npm.io page: https://npm.io/package/filepick

## Dependencies (3)

- [clear](https://npm.io/package/clear.md) 0.0.1
- [prompt](https://npm.io/package/prompt.md) ^1.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^3.2.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2017-08-02

## README

# Filepick 

A file picker made for node cli applications.

## [Documentation](#documentation)
<a name="documentation"></a>

### Installation

```
npm install filepick --save
```

### Methods

Get the full path of an selected file
``` 
filepick(directory, options) -> Promise
```

#### Options
* **question** (string) Show the question for select the file. *Default: 'Choose a file'*.

#### Example
``` javascript
const filepick = require('filepick');

filepick('.', {
  question: 'Escolha um arquivo de backup'
}).then(file => {
  console.log('file', file);
}).catch(err => {
  console.log('Error Getting the file!', err);
});
```

---
_Source: https://npm.io/package/filepick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
