Contributors Forks Stargazers Issues MIT License


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

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:

(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
  2. Build and Install the rust binary sh cd bonk cargo install --path .

or

Download the binary from the releases page

(back to top)

Usage

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

See the open 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)