Colack / guts

Code version control system written in C

guts

Introducing guts, a simple tool to manage and create code repositories. (Essentially just a simpler version of git)

Guts is split into 2 programs, the server and the client. The server allows you to manage repositories from a command line interface, and the client allows you to connect to a server and manage repositories remotely.

The root directory holds the guts.c file, which is the entry point. There are different directories for the server and client, along with included programs and libraries.

All the code is written in C, with some bash scripts to help with installation and updating. You can find all code in the ./guts-core directory.

Features

• Create and manage repositories
• Server mode to manage repositories from a command line interface
• Client mode to connect to a server and manage repositories remotely
• Database to store all repository and user information
• User authentication
• Admin privileges
• Backup system

Table of Contents

• guts
• Features
• Installation
• Usage
  • Program Options
  • Configuration File
  • Repository Options
  • Commands
  • Server Mode
  • Server Database
  • Server Commands
  • Client Mode
  • Client Commands
• Notes
• License

Installation

To install guts simply run the following command:

curl -s https://raw.githubusercontent.com/colack/guts/install.sh | bash

Usage

Program Options

• --version, -v Print version information
• --help, -h Print a help message
• --config, -c Specify a configuration file
• --debug, -d Enable debug mode
• --quiet, -q Suppress all output
• --update, -u Update the program
• --uninstall, -U Uninstall the program
• --fix-install, -f Fix the installation

Configuration File

The configuration file is a JSON file that contains the following options:

• repo: The base repository for the whole program
• directory: Directory of all repositories
• server: The server mode for the program
• port: The port for the server mode
• default: The default repository options for creating new repositories

Repository Options

The repository options are as follows:

• name: The name of the repository
• description: The description of the repository
• files: The files in the repository
• commits: The commits in the repository
• branches: The branches in the repository
• tags: The tags in the repository

Commands

• create <name>: Create a new repository
• delete <name>: Delete a repository
• list: List all repositories
• add <name> <file>: Add a file to a repository
• remove <name> <file>: Remove a file from a repository
• commit <name>: Commit changes to a repository
• push <name>: Push changes to a repository
• pull <name>: Pull changes from a repository
• status <name>: Get the status of a repository
• move <name> <newname>: Move a repository to a new name
• clone <name>: Clone a repository
• rename <name> <newname>: Rename a repository
• log <name>: Get the log of a repository
• history <name>: Get the history of a repository

Server Mode

The server mode allows you to manage repositories from a command line interface. Clients can connect to the server and manage repositories remotely. You can connect to the server by running the following command:

guts connect <server> <port>

Note: Servers will require username and password authentication.

Server Database

The server mode also comes with a database that stores all the repositories and their information, along with user information. The database is a 2 file system that contains the following files:

• users.json: Contains all the user information
• repositories.json: Contains all the repository information

Server Commands

• users: List all users
• adduser <username>: Add a user
• removeuser <username>: Remove a user
• changepassword <username> <password>: Change a user's password
• user <username>: Get a user's information
• ban <username>: Ban a user
• update: Update the server (requires admin privileges and a restart of the server)
• restart: Restart the server (requires admin privileges)
• stop: Stop the server (requires admin privileges)
• quit: Quit the server (requires admin privileges)
• login <username> <password>: Login to the server
• backup: Backup all the server data along with repositories and user information. (Requires admin privileges)

Client Mode

The client mode allows you to manage repositories from a command line interface. You can connect to a server by running the following command:

guts connect <server> <port>

Client Commands

• connect <server> <port>: Connect to a server
• login <username> <password>: Login to the server
• register <username> <password>: Register a new user (You will have to have your account approved by an admin.)
• create <name>: Create a new repository
• delete <name>: Delete a repository
• list: List all repositories
• add <name> <file>: Add a file to a repository
• remove <name> <file>: Remove a file from a repository
• commit <name>: Commit changes to a repository
• push <name>: Push changes to a repository
• pull <name>: Pull changes from a repository
• status <name>: Get the status of a repository
• move <name> <newname>: Move a repository to a new name
• clone <name>: Clone a repository
• rename <name> <newname>: Rename a repository
• log <name>: Get the log of a repository
• history <name>: Get the history of a repository
• quit: Quit the server

Notes

This whole program is still in development and is not yet ready for production. Please use at your own risk.

License

This project is licensed under the GPL v3 License - see the LICENSE file for details