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
- Build and Install the rust binary
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
Note: name of the executable is bonk
though the crate is named bonky.
&&
Download the binary from the releases page here
Usage
Print Help
Create a file
Create a directory
Create a nested file
Create nested directories
Create nested file inside nested directories
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.