kifi

Crates.iokifi
lib.rskifi
version0.4.10-alpha
sourcesrc
created_at2024-01-17 13:50:44.342304
updated_at2024-02-05 10:22:27.486409
descriptionA minimal Version Control System
homepage
repositoryhttps://github.com/Vaurkhorov/kifi
max_upload_size
id1102969
size71,825
Saurav Saswat Samantaray (Vaurkhorov)

documentation

README

kifi - Version Control

kifi is a Rust-based command-line interface (CLI) program that provides a simple way to manage and track changes in your projects and repositories. It offers four main commands to streamline your version control workflow.

Installation

Before using kifi, you need to build and install it. Here are the steps to get started:

Prerequisites

Before building kifi, make sure you have Rust installed on your system. You can install Rust by following the instructions at https://www.rust-lang.org/tools/install.

Install kifi

  1. Clone the kifi repository:

    git clone https://github.com/Vaurkhorov/kifi
    
  2. Install kifi using Cargo (Rust's package manager):

    cargo install --path kifi
    

    This command will compile kifi and create a release version in the "target/release" directory.

  3. To verify that the build was successful, run the following command:

    ./target/release/kifi --version
    

    You should see the version information for kifi. If you don't, verify whether Cargo's bin is present in the environment path variable.

Usage

kifi provides the following commands:

1. kifi init

This command initializes a new repository in the current directory. It sets up a kifi repository to start tracking files.

kifi init

2. kifi track <file_name>

Use this command to start tracking a specific file. Replace file_name with the name of the file you want to track.

kifi track file_name

3. kifi preview

Generate diffs between the current and already pushed versions of tracked files. This helps you review changes before committing.

kifi preview

4. kifi klick

This command takes a 'snapshot', making a commit to the repository.

kifi klick

License

This software is distributed under the GNU AGPLv3 license. See the LICENSE file for more details.

Commit count: 0

cargo fmt