项目作者: atao60

项目描述 :
A CLI for fs-extra
高级语言: TypeScript
项目地址: git://github.com/atao60/fse-cli.git
创建时间: 2020-06-17T06:00:01Z
项目社区:https://github.com/atao60/fse-cli

开源协议:MIT License

下载


Welcome to @atao/fse-cli

Github Version Github Version License: MIT @atao60/fse-cli"">NPM Version

A CLI for fs-extra.

BREAKING CHANGE
Since release @atao60/fse-cli/v/0.1.2">0.1, @atao60/fse-cli will only support Node.js 12 and above.
Releases 0.0.x are last ones to support LTS release 10 of Node.js.
Moreover the support is also removed for Node.js release 13.

💡 Rational

Everyone needs simple file system operations like copy, remove, clean, … that can be used from the terminal or via scripts.

There are many Npm packages that provide all or any of this:

@atao60/fse-cli">This package just provides many of them from a unique CLI, without any pretention to be any kind of shell).

It is based on the API Node.js: fs-extra.

If an API is needed, use Node.js: fs-extra, not @atao60/fse-cli"">@atao60/fse-cli. If only because the latter embeds a npm-shrinkwrap.json expunged from dev dependencies.

The available CLI commands are fully functional and tested. However it’s still a work in progress:

  • Not all fs-extra functions are mapped yet. Please, feel free to open an issue if there is something you would like supported.
  • More tests to come, even if they will only concern the CLI part without overlapping fs-extra‘s tests.

🏁 Quickstart

@atao60/fse-cli"">NPM

Each command is available:

  • either as a stand alone one, i.e. fse-<command> or fse-cli-<command>,
  • or as a sub command, i.e. fse <command> or fse-cli <command>.

The arguments and options of each command are those of Node.js: fs-extra as far as possible, see the manual.

Let’s start with displaying the versions of both @atao60/fse-cli and fs-extra:

  • without installing the package:
  1. npx @atao60/fse-cli version
  • otherwise after installing the package either in global mode:
  1. npm install --global @atao60/fse-cli
  2. fse version
  • or in a project:
  1. npm install --save-dev @atao60/fse-cli # or `yarn add --dev @atao60/fse-cli`
  2. fse version

🎹 Commands

For more details, see the manual.

🛠️ Development

See Contributing.

🛡️ License

See MIT.

Copyright © 2020-2023 Pierre Raoul.

📜 Credits

Indeed the API Node.js: fs-extra.

Furthermore node-fs-extra-cli was very useful to start this project.