Skip to content

Inquirer file selector prompt, you can navigate freely between directories, choose what type of files you want to allow and it is fully customizable.

License

Notifications You must be signed in to change notification settings

br14n-sol/inquirer-file-selector

Repository files navigation

inquirer-file-selector

version license node-current unpacked-size downloads

A prompt implementation for Inquirer.js that allows users to interactively select files or directories in the terminal.

banner

Key Features

  • File & Directory Selection – Browse and select files from the terminal.
  • Multiple Selection – Select multiple files at once. (not ready)
  • Custom Filters – Apply filters to show only specific file types.
  • Keyboard Navigation – Use arrow keys for easy selection.
  • Theming – Customize the appearance of the prompt.

Installation

pnpm (recommended) npm
pnpm add inquirer-file-selector
npm install inquirer-file-selector

Usage

import {
  fileSelector,
  type Item
} from 'inquirer-file-selector'

const selection: Item = await fileSelector({
  message: 'Select a file or directory:'
})

Documentation

See the full documentation in the docs/ directory:

Contributing

Contributions are welcome! See CONTRIBUTING.md for more information.

Copyright & License

© 2024 Brian Fernandez and Contributors.

This project is licensed under the MIT license. See the file LICENSE for details.

About

Inquirer file selector prompt, you can navigate freely between directories, choose what type of files you want to allow and it is fully customizable.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •