5 unstable releases
0.4.0 | Jan 23, 2024 |
---|---|
0.3.2 | Oct 6, 2022 |
0.3.1 | Oct 6, 2022 |
0.3.0 | Sep 27, 2022 |
0.2.0 | Sep 26, 2022 |
#494 in Development tools
11KB
70 lines
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
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.
- Clone the repo
git clone https://github.com/elliot40404/bonk.git
- Build and Install the rust binary
cd bonk cargo build --release cargo install --path .
or
# install directly from this repo
scoop install https://raw.githubusercontent.com/elliot40404/bonk/master/bonk.json
# Additionally you can add my bucket and install from there
scoop bucket add elliot
scoop install elliot/bonk
cargo install bonky
Note: name of the executable is bonk
though the crate is named bonky.
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
Usage
Print Help
bonk -h
bonk --help
Create a file
bonk main.rs
Create a directory
bonk src/
Create a nested file
bonk src/main.rs
Create nested directories
bonk src/bonky/
Create nested file inside nested directories
bonk src/bonky/mod.rs
Roadmap
- Handle Non-UTF8 files/folders
- Add timestamp modification functionality
See the open 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.