https://github.com/elliot40404/bonk
The blazingly fast touch alternative with a sprinkle of mkdir written in rust.
https://github.com/elliot40404/bonk
cargo cli command-line-tool linux rust rust-lang touch
Last synced: 7 months ago
JSON representation
The blazingly fast touch alternative with a sprinkle of mkdir written in rust.
- Host: GitHub
- URL: https://github.com/elliot40404/bonk
- Owner: elliot40404
- License: mit
- Created: 2022-09-23T12:11:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-27T14:41:25.000Z (almost 2 years ago)
- Last Synced: 2025-06-11T18:44:00.187Z (7 months ago)
- Topics: cargo, cli, command-line-tool, linux, rust, rust-lang, touch
- Language: Rust
- Homepage:
- Size: 82 KB
- Stars: 103
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![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]
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
## 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?
## 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)
## 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
```
## 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).
## 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
## License
Distributed under the MIT License. See `LICENSE` for more information.
[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