Skip to content

xt0rted/dotnet-rimraf

Repository files navigation

dotnet-rimraf

CI build status NuGet Package GitHub Package Registry Project license

Deep deletion command for .NET (like rm -rf).

This is based on the node tool of the same name.

Installation

This tool can be used as a dotnet global tool, or a dotnet local tool. If using it as part of a build script it's recommended to install it as a local tool.

Global

dotnet tool install rimraf --global

Local

dotnet new tool-manifest
dotnet tool install rimraf

Keeping current

Tools like Dependabot (community/community#13825) and Renovate don't currently support updating dotnet local tools. One way to automate this is to use a GitHub Actions workflow to check for updates and create PRs when new versions are available, which is what this repo does.

Options

Name Description
--dry-run See what would be deleted (enables --verbose)
--no-preserve-root Delete the directory being acted on instead of preserving it
--verbose Enable verbose output
--version Show version information
--help Show help and usage information

Usage

Use dotnet rimraf (rimraf if using as a global tool) to delete files and directories. You can pass one or more paths or globs to delete. Globbing is handled by the DotNet.Glob library and supports of all its patterns and wildcards.

rimraf artifacts coverage
rimraf artifacts/**/*-pre*.nupkg
rimraf **/bin **/obj

Working directory

The working directory is the directory that rimraf is run from.

Development

This project uses the run-script dotnet tool to manage its build and test scripts. To use this you'll need to run dotnet tool install and then dotnet r to see the available commands or look at the scripts section in the global.json.