Skip to content

A Windows port of the cat command, written in Rust.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE_APACHE.md
MIT
LICENSE_MIT.md
Notifications You must be signed in to change notification settings

walker84837/wincat-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wincat-rs

A Windows port of the cat coreutils program.

wincat is designed to mimic the functionality of the cat command found in Unix-like systems.

Installation

The only dependencies are the the Rust compiler and cargo. The binary is compiled only when using Windows targets:

$ cargo build --release

Usage

.\wincat.exe <FILEs>
  • <FILEs>: The files whose contents will be concatenated and written to stdout.
  • -v, --verbose: Logs file operations and error handling where applicable.

Contributing

Contributions are welcome! Here are the contributing guidelines:

  • Try to use the least amount of unsafe blocks. If that's needed make some safe wrapper function around it.
  • Since this repo is based around Windows, use functions from winapi when applicable. However, try keeping a tradeoff between safety and using the Windows API.
  • Prefer using the standard library over reinventing the wheel.
  • Format code with
    rustfmt --edition 2021
  • If you would like to make big changes (eg. changing libraries for checksums), open an issue, explaining what you'd like to change, the main reasons as to why.

Roadmap

  • Feature: Add option for line numbers
  • Enhancement: Add a similar functionality as the cat Coreutils program (I'm not expecting full similarity as Windows and Unix-based OSes work very differently).

Support

For help or issues, please open an issue.

License

This project is dual-licensed under the MIT or Apache 2.0 License - see the Apache, Version 2.0 and MIT License files for details.