Skip to content

Deltabae is a command-line utility that leverages the capabilities of `delta` and `ansifilter` to generate a side-by-side, syntax-highlighted diff of two text files and output it as an HTML file. It is designed to provide a visually appealing and user-friendly way to compare text files, especially useful for code reviews and similar tasks.

License

Notifications You must be signed in to change notification settings

koemigg/deltabae

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deltabae: Delta Diff to HTML

Deltabae is a command line tool that generates a side-by-side, colored HTML diff of two text files using delta and ansifilter.

Requirements

To use Deltabae, you'll need to have both delta and ansifilter installed.

Usage

You can use Deltabae by providing the names of the two files you want to compare. Here's a basic example:

deltabae.sh -f your_first_file -s your_second_file

This will generate a file named diff.html in the ./tmp directory.

Command Line Options

Deltabae accepts the following command line options:

  • -f : Specifies the first file to compare (required).
  • -s : Specifies the second file to compare (required).
  • -o : Specifies the directory where the HTML output should be saved. If the directory doesn't exist, it will be created. Default is ./tmp.
  • -n : Specifies the name of the output HTML file (without the .html extension). Default is diff.

For example, to compare file1.txt and file2.txt, output the result to the path/to/my-project/results directory, and name the output file my_diff.html, you would run:

deltabae.sh -f file1.txt -s file2.txt -o path/to/my-project/results -n my_diff

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Deltabae is licensed under the MIT License. See LICENSE for more information.

About

Deltabae is a command-line utility that leverages the capabilities of `delta` and `ansifilter` to generate a side-by-side, syntax-highlighted diff of two text files and output it as an HTML file. It is designed to provide a visually appealing and user-friendly way to compare text files, especially useful for code reviews and similar tasks.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published