Group 2 - SynCode: Demin, Suumil, Helia, Pranay, Shunzhi

DVCS User Guide & Acceptance Tests

Part A: DVCS Installation & User Guide

Installation

1. Git clone the repository and then navigate to the root of the project.

git clone https://github.com/BoaConst/syncode.git

cd syncode

2. Run the following command to build and install the binary.

cargo install --path .

For Unix-like systems (Linux, MacOS)

• Bash(Linux): Add to ~/.bashrc or ~/.bash_profile

export PATH="$HOME/.cargo/bin:$PATH"

• Zsh (macOs): Add to ~/.zshrc:

export PATH="$HOME/.cargo/bin:$PATH"

After adding the line, apply the changes:

source ~/.bashrc  # or source ~/.zshrc

• Windows: Add C:\Users<YourUserName>.cargo\bin to your system's PATH environment variable.

Usage

1. Initialize a Repository (init):

• Initialize a repository in the current working directory:

syncode init

• Or initialize a repository in a different directory:

syncode init <"path/to/another/dir">

2. Clone a Repository (clone):

• Clone a repository to the current working directory:

syncode clone <"path/to/source/repo">

• Or clone a repository to a different directory:

syncode clone <"path/to/source/repo"> <"path/to/destination/repo">

3. Add Files to Tracking (add):

• Add files to be tracked:

syncode add file1.txt file2.txt

4. Remove Files from Tracking (remove):

• Remove a file from being tracked:

syncode add file1.txt file2.txt

5. Commit Changes (commit):

• Commit the current state of the repository:

syncode commit

6. View Repository Status (status):

• View the status of tracked and untracked files:

syncode status

7. View Commit Log (log):

• View the commit history:

syncode log

8. View the differences/changes (diff):

• View the differences/changes between revisions:

syncode diff <"rev1"> <"rev2">

9. View current head/branch (heads):

• View the current head/branch of the repository:

syncode heads

10. View a file (cat):

• View the content of a file:

syncode cat <"file.txt">

11. Check out a specific revision (checkout):

• Check out a specific revision:

syncode checkout <"rev1">

12. Merge 2 different revisions (merge):

• Merge 2 different revisions:

syncode merge <"rev1"> <"rev2"> <"path/to/repo">

13. Push a commit (push):

• Push a commit:

syncode push <"remote"> <"local">

14. Pull a commit (pull):

• Pull a remote repo to local repo:

syncode push <"remote"> <"local">

15. View a help message (help):

• View the help message:

syncode help