https://github.com/021-projects/xfgit
Efficient management tool for XenForo add-on repositories, enabling symlink creation and easy detachment during builds.
https://github.com/021-projects/xfgit
Last synced: 10 months ago
JSON representation
Efficient management tool for XenForo add-on repositories, enabling symlink creation and easy detachment during builds.
- Host: GitHub
- URL: https://github.com/021-projects/xfgit
- Owner: 021-projects
- License: gpl-3.0
- Created: 2025-07-15T10:43:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-19T16:51:17.000Z (12 months ago)
- Last Synced: 2025-08-08T17:29:18.490Z (11 months ago)
- Language: TypeScript
- Size: 38.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xfgit
## What is xfgit?
xfgit allows for more efficient management of XenForo add-on repositories by creating symlinks and helping to detach them during the build process.
## Installation
### Download the latest release
You can download the latest release from the [release page](https://github.com/021-projects/xfgit/releases)
### Build from source
If you prefer to build xfgit from source, you will need to have the following dependencies installed:
- Bun 1.2.17 or later
You can build xfgit from source by cloning the repository and running the build script:
```bash
git clone https://github.com/021-projects/xfgit.git
cd xfgit
bun install
bun run build
```
Now your `xfgit` binary should be available in the `bin` directory.
If you are using a Unix-like operating system and want to make `xfgit` available globally, you can use the following command:
```bash
bun run install:unix
```
This command will build the binary for your platform and place it in `/usr/local/bin/xfgit`.
## Usage
### Init
Initializing a new add-on project with predefined directory structure
```bash
xfgit init --js
```
### Alias
Creating an alias for a XenForo directory in which you will be creating symlinks
```bash
xfgit alias
```
### Link
Creating an add-on symlinks in the specified XenForo directory
```bash
cd
xfgit link
```
### Build
Building the add-on: detaching symlinks and creating a zip archive
```bash
cd
xfgit build
```
### Config
#### Get current configuration
```bash
xfgit config
```
#### Get configuration path
```bash
xfgit config -p
```