Forrest logo
tool overview
On this page you find all important commands for the CLI tool detox. If the command you are looking for is missing please ask our AI.

detox

Detox is a command line tool used for renaming files by stripping special characters and non-ASCII characters from filenames. It is commonly used to sanitize file names for compatibility with various operating systems, file systems, and environments.

Some key features of Detox include:

  1. Character mapping: Detox provides extensive character mapping options to replace specific characters in filenames. This allows you to customize the renaming process according to your needs.

  2. Recursive mode: You can use Detox in recursive mode, which enables renaming of files not only in a single directory but also in all subdirectories, making it efficient for performing bulk renaming operations.

  3. Preview mode: Detox allows you to preview the changes before actually renaming the files. This helps ensure that the desired modifications are applied correctly and that no unintended changes occur.

  4. Dry-run mode: Similar to the preview mode, the dry-run mode offers a way to simulate the renaming process without actually modifying the files. This is useful for validating the output and verifying the expected changes.

  5. Support for multiple platforms: Detox is cross-platform and is available for various operating systems like Linux, macOS, and Windows. This makes it a versatile tool that can be used on different systems.

  6. Regular expression support: Detox supports regular expressions, allowing for advanced pattern matching and substitution. This gives you great flexibility in renaming files based on complex criteria.

Overall, Detox is a reliable tool that simplifies the process of batch renaming files, making them compatible with different systems and removing incompatible characters.

List of commands for detox:

  • detox:tldr:3d37d detox: Remove spaces and other undesirable characters from a file's name.
    $ detox ${filename}
    try on your machine
    explain this command
  • detox:tldr:a0f0c detox: Show how detox would rename all the files in a directory tree.
    $ detox --dry-run -r ${path-to-directory}
    try on your machine
    explain this command
  • detox:tldr:b9d6b detox: Remove spaces and other undesirable characters from all files in a directory tree.
    $ detox -r ${path-to-directory}
    try on your machine
    explain this command
tool overview