Bit Repository Manager

Bit Repository Manager is a simple and efficient command-line tool designed to help you manage your Bit repositories with ease. It allows you to initialize a new Bit repository, add files, read files, and hash files seamlessly.

Features

✅ Initialize a new Bit repository
✅ Add files to the Bit repository
✅ Read file contents from the repository
✅ Generate a hash for files
✅ Simple and lightweight command-line tool
✅ Easy setup and installation

Installation (User)

npm i -g bitshit

Installation (Development)

To install Bit Repository Manager, follow these steps:

# Clone the repository
git clone https://github.com/TheAvtarSingh/bit

# Navigate to the project directory
cd bit

# Install dependencies
npm install

Usage

Once installed, you can use the following commands to manage your Bit repository:

Initialize a new Bit repository

bit init

This command initializes a new Bit repository in your current directory.

• Support till v1.0.0

Add files to the Bit repository

bit add <filename>

Replace <filename> with the name of the file you want to add to the repository.

Read file contents from the repository

bit read-file <hash>

This command retrieves the contents of a file stored in the repository using its hash.

Generate a hash for a file

bit hash-my-file <filename>

This command generates a unique hash for a file and stores it in the Bit repository.

Example Workflow

1. Initialize a new Bit repository:

   bit init

   Output: "Bit repository initialized successfully!"

2. Add a file to the repository:

   bit add example.txt

   Output: "File 'example.txt' added to the repository."

3. Read file contents using its hash:

   bit read-file a1b2c3d4e5f6g7h8i9j0k

   Output: "File content: Hello, world!"

4. Generate a hash for a file:

   bit hash-my-file example.txt

   Output: "Generated hash for example.txt: a1b2c3d4e5f6g7h8i9j0k"

Screenshots

Initializing a Bit Repository

Initialize Bit Repo

Adding and Reading Files from the Repository

Adding Files

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-<yourname>-<feature>).
3. Commit your changes (git commit -m '<yourname>-<Feature Description>').
4. Push to the branch (git push origin feature-<yourname>-<feature>).
5. Open a Pull Request.

License

This project is licensed under the MIT License.

Support

For any issues or feature requests, feel free to open an issue or contact us at [email protected].