# inquirer-select-directory

> A directory prompt for Inquirer.js

Latest version **1.2.0** (published 2017-11-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install inquirer-select-directory
pnpm add inquirer-select-directory
yarn add inquirer-select-directory
bun add inquirer-select-directory
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2017-11-10 |
| First published | 2016-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | JEGARD Benjamin |
| Maintainers | kamikillerto |
| Keywords | Inquirer, directory, prompt |

## Links

- npm: https://www.npmjs.com/package/inquirer-select-directory
- Repository: https://github.com/KamiKillertO/inquirer-select-directory
- Homepage: https://github.com/KamiKillertO/inquirer-select-directory#readme
- Issues: https://github.com/KamiKillertO/inquirer-select-directory/issues
- npm.io page: https://npm.io/package/inquirer-select-directory

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) 1.1.1
- [figures](https://npm.io/package/figures.md) 2.0.0
- [rx-lite](https://npm.io/package/rx-lite.md) 4.0.8
- [inquirer](https://npm.io/package/inquirer.md) 2.0.0
- [cli-cursor](https://npm.io/package/cli-cursor.md) 2.0.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2017-11-10
- 1.1.2 — 2017-05-19
- 1.1.0 — 2017-05-19
- 1.0.2 — 2016-12-28
- 1.0.1 — 2016-12-13
- 1.0.0 — 2016-10-26
- 0.1.0 — 2016-07-28

## README

# inquirer-select-directory

A directory prompt for [Inquirer.js](https://github.com/SBoudrias/Inquirer.js).

This project is a fork of [Inquirer-directory](https://github.com/nicksrandall/inquirer-directory) which does not limit the navigation to the current folder.

<!--[![Issue Count](https://codeclimate.com/github/KamiKillertO/inquirer-select-directory/badges/issue_count.svg)](https://codeclimate.com/github/KamiKillertO/inquirer-select-directory)!-->
![](https://img.shields.io/badge/license-MIT-blue.svg)
[![](https://img.shields.io/badge/release-v1.1.0-blue.svg)](https://github.com/KamiKillertO/inquirer-select-directory/releases/tag/v1.1.0)
[![Build Status](https://travis-ci.org/KamiKillertO/inquirer-select-directory.svg)](https://travis-ci.org/KamiKillertO/inquirer-select-directory)
[![Build status](https://ci.appveyor.com/api/projects/status/fdyk5g3y56381742?svg=true)](https://ci.appveyor.com/project/KamiKillertO/inquirer-select-directory)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e6a963539c4440b69356649c0048ea30)](https://www.codacy.com/app/kamikillerto/inquirer-select-directory?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=KamiKillertO/inquirer-select-directory&amp;utm_campaign=Badge_Grade)

## Installation

```bash
npm install --save inquirer-select-directory
```

## Features

-   Support for symlinked files
-   Vim style navigation
-   Search for file with "/" key

### Key Maps

-   Press "/" key to enter search mode.
-   Press "-" key to go up (back) a directory.
-   Press "." key to select the current directory.

## Usage

This prompt is anonymous, meaning you can register this prompt with the type name you please:

```javascript
inquirer.registerPrompt('directory', require('inquirer-select-directory'));
inquirer.prompt({
  type: 'directory',
  ...
})
```

Change `directory` to whatever you might prefer.

### Parameters

Takes `type`, `name`, `message`, `basePath`, `options` properties.

See [inquirer](https://github.com/SBoudrias/Inquirer.js) readme for meaning of all except **basePath**.

**basePath** is the relative path from your current working directory

#### [Example](https://github.com/KamiKillertO/inquirer-select-directory/tree/develop/example/example.js)

```javascript
inquirer.registerPrompt('directory', require('inquirer-select-directory'));
inquirer.prompt([{
  type: 'directory',
  name: 'from',
  message: 'Where you like to put this component?',
  basePath: './src'
}]).then(function(answers) {
  //etc
});
```

### Options

#### options.displayFiles

default ***false***

Set this to true if you to display files

```javascript
inquirer.prompt([{
  type: 'directory',
  //...
  options: {
      displayFiles:true
  }
}]).then(function(answers) {
  //etc
});
```

#### options.displayHidden

default ***false***

Set this to true if you to display hidden folders (and files if displayFiles is set to `true`) 

```javascript
inquirer.prompt([{
  type: 'directory',
  //...
  options: {
      displayHidden:true
  }
}]).then(function(answers) {
  //etc
});
```

## License

MIT

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