Skip to content

SullyGreene/Tuxedo-Repo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Tuxedo-Repo

This repository is the official package source and central database for the Tuxedo-Termux CLI marketplace.

📖 What is This Repository?

This is not a runnable application. It is a collection of simple JSON files that act as a database of package metadata. The Tuxedo-Termux client reads the files in this repository to learn what packages are available for installation, where their installers are located, and how to verify their integrity.

The core of the Tuxedo marketplace lives here, and its growth depends on community contributions.

🤝 How to Contribute a Package

Adding a new tool to the marketplace is easy. The entire process is managed through Pull Requests. If you have a script or tool for rooted Android devices that you'd like to share, follow these steps.

Step 1: Fork & Create a New Branch

  1. Fork this repository to your own GitHub account.
  2. Create a new, descriptive branch for the package you are adding (e.g., git checkout -b add-cool-new-tool).

Step 2: Create the Package JSON File

  1. In the apps/ directory, create a new file named after your package. The filename should be lowercase and contain no spaces (e.g., cool-new-tool.json).
  2. Copy the template below and fill it out with your package's information.

JSON Template

{
  "name": "Your Tool Name",
  "version": "1.0.0",
  "author": "Your Name or Handle",
  "description": "A concise and clear description of what this tool does.",
  "category": "utility",
  "aliases": ["alias1", "alias2"],
  "dependencies": ["dependency1", "dependency2"],
  "install_script_url": "https://raw.githubusercontent.com/user/project/main/install.sh",
  "uninstall_script_url": "https://raw.githubusercontent.com/user/project/main/uninstall.sh",
  "homepage": "https://github.com/user/project",
  "sha256_checksum": "PASTE_YOUR_CHECKSUM_HERE"
}

Step 3: Understand the JSON Schema

Each field is important. Please fill them out accurately.

Key Type Required Description
name String Yes The official, human-readable name of the package.
version String Yes The current version of your tool. Please use Semantic Versioning (e.g., 1.2.3).
author String Yes The name or GitHub handle of the original tool creator.
description String Yes A short (1-2 sentence) description of the package's purpose.
category String Yes The category of the tool. Use one of: system, networking, utility, security, customization.
aliases Array No An array of shorter, alternative names for your package.
dependencies Array No An array of official Termux packages required for your tool to run (e.g., ncurses, python).
install_script_url String Yes Crucial: A direct raw link to the installer shell script.
uninstall_script_url String No A direct raw link to a script that cleanly removes the package. Highly recommended.
homepage String No A link to the project's official website or source code repository.
sha256_checksum String Yes Crucial: The SHA256 checksum of your install_script_url file. See below for how to generate this.

🛡️ Generating the SHA256 Checksum

This is our primary security measure. It ensures that the user downloads the exact same installer script you intended, protecting against tampering.

To generate the checksum on Linux, macOS, or in Termux, run:

sha256sum /path/to/your/install.sh

Or, to download from a URL and check it:

curl -sL https://raw.githubusercontent.com/user/project/main/install.sh | sha256sum

Copy the long string of characters and paste it as the value for sha256_checksum.

Step 4: Submit a Pull Request

Once your JSON file is complete and you have tested that your install script works, commit the changes and push them to your fork. Then, open a Pull Request to merge your branch into the main branch of this repository.

Your submission will be reviewed for accuracy, security, and relevance before being merged.

📜 License

The package definitions in this repository are licensed under the MIT License. The individual tools they point to are subject to their own respective licenses.

About

The official package source for the Tuxedo-Termux CLI. This repository contains the JSON package definitions for all applications available in the marketplace.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors