The recurse executable is a cross-platform, command line file management tool with default recursive directory traversal and regular expression pattern matching support. It is built in Rust and tested against the stable, beta, and nightly Rust toolchains on GNU/Linux, macOS, and Windows platforms.
Features are available through sub-commands of the recurse executable. Support currently includes:
recurse walk: recursive directory traversal file listingsThe following sub-commands are in development:
recurse contains: identify text file paths with text strings that match regular expression patternsrecurse find: identify lines in text files that match regular expression patternsrecurse replace: replace strings in text files that match regular expression patternsSee the Usage section below for additional details.
cargo from crates.ioUse cargo to install the recurse executable from crates.io:
$ cargo install recurse
cargo from the master branch of the repositoryClone the git repository, compile, and install the executable with the following commands:
$ git clone https://github.com/chrissimpkins/recurse.git
$ cd recurse
$ cargo install --path .
View the help documentation for any sub-command on the command line with the syntax:
$ recurse [SUB-COMMAND] --help
The help menu displays the available options and required arguments.
walk sub-command
$ recurse walk [OPTIONS] [ARGS] [PATH]
The default behavior of the walk sub-command is to recursively traverse directories below a user-specified path and list all file paths that are not hidden in the standard output stream. Hidden paths are defined as a directory or file that begins with a period (e.g., .hidden directory or .hidden.txt file). All directories and files below a hidden directory path are considered hidden. Directory traversal proceeds to the max directory depth below the user-specified path.
The default behavior is modified with command line options. Supported options for the walk sub-command include:
-d | --dir: Filter on directory paths only, do not list file paths-a | --all: Include hidden file and directory paths--symlinks: Follow symbolic links-e | --ext [EXTENSION]: Filter on paths include an EXTENSION argument extension. Enter an EXTENSION string argument to define the extension filter. The EXTENSION argument may be defined with or without a period character (e.g., txt or .txt)--maxdepth [DEPTH]: maximum depth to extend traversal of file system sub-directory structure. Enter an integer value for DEPTH to limit the directory traversal.--mindepth [DEPTH]: minimum depth to begin traversal of file system sub-directory structure. Enter an integer value for DEPTH to limit the directory traversal.Please submit new issues on the GitHub issue tracker.
Contributions under the Apache License, v2.0 are welcomed. Please open a pull request with your proposal for changes.
This project is licensed under the Apache License, v2.0. See LICENSE.md for the full text of the license.