@stdlib/fs-read-file-cli
v0.2.2
Published
Read the entire contents of a file.
Downloads
9
Readme
Read File
Read the entire contents of a file.
Installation
To use as a general utility, install the CLI package globally
npm install -g @stdlib/fs-read-file-cli
Usage
Usage: read-file [options] <filepath>
Options:
-h, --help Print this message.
-V, --version Print the package version.
--enc, --encoding encoding Encoding.
--flag flag Flag. Default: 'r'.
Notes
- Relative file paths are resolved relative to the current working directory.
- Errors are written to
stderr
. - File contents are written to
stdout
.
Examples
$ read-file ./README.md
<file_contents>
See Also
@stdlib/fs-read-file
: read the entire contents of a file.@stdlib/fs-exists
: test whether a path exists on the filesystem.@stdlib/fs-open
: open a file.@stdlib/fs-read-dir
: read the entire contents of a directory.@stdlib/fs-read-json
: read a file as JSON.@stdlib/fs-write-file
: write data to a file.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.