https://github.com/walker84837/wincat-rs
A Windows port of the cat command, written in Rust.
https://github.com/walker84837/wincat-rs
cli command-line-app command-line-tool rust rust-cli rust-lang
Last synced: 8 months ago
JSON representation
A Windows port of the cat command, written in Rust.
- Host: GitHub
- URL: https://github.com/walker84837/wincat-rs
- Owner: walker84837
- License: apache-2.0
- Created: 2023-12-02T21:33:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T12:13:04.000Z (about 1 year ago)
- Last Synced: 2025-03-29T21:14:42.949Z (about 1 year ago)
- Topics: cli, command-line-app, command-line-tool, rust, rust-cli, rust-lang
- Language: Zig
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE_APACHE.md
Awesome Lists containing this project
README
# 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:
``` console
$ cargo build --release
```
## Usage
``` console
.\wincat.exe
```
- ``: 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
``` console
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](https://github.com/walker84837/wincat-rs/issues).
## License
This project is dual-licensed under the MIT or Apache 2.0 License - see the
[Apache, Version 2.0](LICENSE_APACHE.md) and [MIT License](LICENSE_MIT.md) files
for details.