Skip to content

Command line tool to view the raw hexadecimal data of a file, or portion of a file

License

Notifications You must be signed in to change notification settings

tip2tail/HexPrintFile

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

HexPrintFile

Command line tool to view the raw hexadecimal data for a given file, or selected part of a file.
Report Bug or Request Feature

Changelog

View the changes to this project: Changelog.

Screenshot

Screenshot

Built With

  • C#
  • .NET Core
  • VS Code

Installation

No installation is required, download a release from the Releases tab that applies to your system.

Alternatively, download and build on your local system.

Usage

A tool to print the hex representation of a file, or portion of a file

Usage: HexPrintFile [options] <file>

Arguments:
  file                          File to hex print

Options:
  -?|-h|--help                  Show help information
  -s|--start-byte <BYTE>        Byte to start reading from. 0 if excluded. Counted from index 0.
  -e|--end-byte <BYTE>          Byte to read to (inclusive). Reads to EOF if excluded. Counted from index 0. Cannot be used with -c.
  -c|--count-bytes <COUNT>      Returns X bytes from start byte (if provided). Cannot be used with -e.
  -r|--read-chunk-size <BYTES>  Sets the chunk size. Minimum 4, Maximum 64. Default is 16.
  -x|--extended                 Use extended ASCII characters in output.
  -o|--index-from-one           Index the bytes from 1 rather than 0.

> ----------------------------------------------------
> Created by Mark Young
> github.com/tip2tail
> ----------------------------------------------------
> Return Codes
> 0: Success
> 1: File not found
> 2: Satrt byte greater than the length of the file
> 3: End byte greater than or equal to the length of the file
> 4: General error displaying the data
> 5: Cannot use opptions -c and -e together
> 6: Start byte is less than zero
> 7: End byte less than start byte
> 8: Command line parsing exception
> 9: Start byte is less than one and index from one mode enabled
> 10: Read block size cannot be less than 4 bytes
> 11: Read block size cannot be more than 64 bytes
> ----------------------------------------------------
> Version:   1.1.1
> Buid Date: 2020-05-25 11:49:45
> ----------------------------------------------------

Roadmap

See the open issues for a list of proposed features (and known issues).

I cannot promisse I will take any of these forward, but all proposals are welcome.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contributors

  • Mark Young (tip2tail)

Build Release Version

To build a release version use the following commands.

  • Windows
dotnet publish -c Release --self-contained -r win-x64 /p:PublishSingleFile=true
  • Linux
dotnet publish -c Release --self-contained -r linux-x64 /p:PublishSingleFile=true
  • macOS
dotnet publish -c Release --self-contained -r osx-x64 /p:PublishSingleFile=true

License

Distributed under the MIT License. See LICENSE for more information.

Project Owner

Mark Young - @tip2tail

About

Command line tool to view the raw hexadecimal data of a file, or portion of a file

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages