Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sma1lboy/cgit
https://github.com/sma1lboy/cgit
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sma1lboy/cgit
- Owner: Sma1lboy
- Created: 2024-01-17T23:42:22.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-19T03:09:08.000Z (9 months ago)
- Last Synced: 2024-02-19T04:25:20.004Z (9 months ago)
- Language: Java
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CGit: A Java-Based Version Control System
## Introduction
Cgitlet is a lightweight, Java-based version control system inspired by Git. It offers essential functionalities for tracking and managing changes in your codebase, making it suitable for personal projects and learning purposes.
## Features
cgitlet supports a variety of commands that are similar to Git, including but not limited to:
- `test`: Runs tests for the tool.
- `add `: Adds a file to the staging area.
- `commit `: Commits the staged changes with a given message.
- `rm `: Removes a file from the current tracking and staging area.
- `log`: Displays the commit history for the current branch.
- `global-log`: Shows the commit history across all branches.
- `find `: Finds and displays commits with a specific message.
- `status`: Displays the status of the working directory and staging area.
- `checkout `: Checks out a specific commit or branch.
- `branch `: Creates a new branch.
- `rm-branch `: Deletes a specified branch.
- `reset `: Resets the current branch's head to the specified commit.
- `merge `: Merges a specified branch into the current branch.
Advanced features such as handling remote repositories (`add-remote`, `rm-remote`, `push`, `fetch`, `pull`) are also available.
## Prerequisite
- CURL
- Linux
```bash
sudo apt install curl
```
- Mac
```bash
brew install curl
```
## Installation
### Building from Source
To build cgitlet from the source code, you need a Java Development Kit (JDK) installed on your system. Follow these steps:
1. Clone the repository: `git clone [URL to cgitlet repository]`.
2. Navigate to the project directory: `cd cgitlet`.
3. Compile the project: `javac [path to java files]`.
### Running the Pre-built Jar
If you prefer using the pre-built jar, `cgitlet.jar` can be downloaded and run directly. Ensure you have Java Runtime Environment (JRE) installed, then execute:
```shell
java -jar cgitlet.jar [command]
```
### Setting Up Alias for Easy Usage
For convenience, you can set up an alias in your command-line interface. For example, in a Unix-like environment, add this line to your `.bashrc` or `.bash_profile`:
```
shellCopy code
alias cgit='java -jar /path/to/cgitlet.jar'
```
Replace `/path/to/cgitlet.jar` with the actual path to the `cgitlet.jar` file. After setting up the alias, you can use `cgit` followed by the commands listed above.
## Contributing
We welcome contributions to cgitlet! Please read our contributing guidelines [MIT](https://opensource.org/license/mit/) for details on how to submit changes.