[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Crates.io][crates-shield]][crates-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]
Logo

Bonk

The blazingly fast touch alternative written in rust. Made for the sole purpose to create files.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
## About The Project [![Product Name Screen Shot][product-screenshot]](https://example.com) There are many ways to create a file via cli depending on the OS you are on but me currently being on windows, though some command are aliased they don't feel natural (`New-Item` instead of `touch`) and I miss using some of the unix commands that I am so used to. Thats how bonk came to be. Here's why: - Works on all OS' - Can Also create directories recursively - Why not?

(back to top)

## Getting Started ### Installation _Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ 1. Clone the repo ```sh git clone https://github.com/elliot40404/bonk.git ``` 1. Build and Install the rust binary ```sh cd bonk cargo build --release cargo install --path . ``` or ```pwsh # install directly from this repo scoop install https://raw.githubusercontent.com/elliot40404/bonk/master/bonk.json ``` ```pwsh # Additionally you can add my bucket and install from there scoop bucket add elliot scoop install elliot/bonk ``` ```sh cargo install bonky ``` Note: name of the executable is `bonk` though the crate is named bonky. ```sh sudo curl -L https://github.com/elliot40404/bonk/releases/latest/download/bonk_linux_x64 -o /usr/local/bin/bonk && sudo chmod +x /usr/local/bin/bonk ``` Download the binary from the releases page [here](https://github.com/elliot40404/bonk/releases/latest)

(back to top)

## Usage Print Help ```bash bonk -h ``` ```bash bonk --help ``` Create a file ```bash bonk main.rs ``` Create a directory ```bash bonk src/ ``` Create a nested file ```bash bonk src/main.rs ``` Create nested directories ```bash bonk src/bonky/ ``` Create nested file inside nested directories ```bash bonk src/bonky/mod.rs ```

(back to top)

## Roadmap - [ ] Handle Non-UTF8 files/folders - [ ] Add timestamp modification functionality See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 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

(back to top)

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

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/elliot40404/bonk.svg?style=for-the-badge [contributors-url]: https://github.com/elliot40404/bonk/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/elliot40404/bonk.svg?style=for-the-badge [forks-url]: https://github.com/elliot40404/bonk/network/members [stars-shield]: https://img.shields.io/github/stars/elliot40404/bonk.svg?style=for-the-badge [crates-shield]: https://img.shields.io/crates/d/bonky?style=for-the-badge [stars-url]: https://github.com/elliot40404/bonk/stargazers [crates-url]: https://crates.io/crates/bonky [issues-shield]: https://img.shields.io/github/issues/elliot40404/bonk.svg?style=for-the-badge [issues-url]: https://github.com/elliot40404/bonk/issues [license-shield]: https://img.shields.io/github/license/elliot40404/bonk.svg?style=for-the-badge [license-url]: https://github.com/elliot40404/bonk/blob/master/LICENSE [product-screenshot]: bonk.png