tsugi/lib

The PHP Library to build interoperable learning tools

26.1.3 2026-01-20 04:52 UTC

Requires

• php: >=8.4.0
• ezyang/htmlpurifier: v4.18.0
• firebase/php-jwt: v6.11.1
• laravel/lumen-framework: v11.2.0
• phpseclib/phpseclib: 3.0.43

Requires (Dev)

• phpunit/php-timer: v5.0.3
• phpunit/phpunit: 9.*

Apache-2.0

• csev

README

The Tsugi PHP library is developed only in the main tsugi monorepo. The standalone tsugi-php repository is a read-only mirror used for Packagist distribution.

Canonical Rule

All changes to the Tsugi PHP library must be committed and pushed to
tsugi master before they are mirrored to tsugi-php.

Changes flow one way:

tsugi (master, lib/) → tsugi-php (master) → Packagist

Direct commits or pull requests to tsugi-php are not accepted and may be overwritten.

Step-by-Step Workflow

1. Work in the main Tsugi repository

Clone and work in the canonical repository:

git clone https://github.com/tsugiproject/tsugi.git
cd tsugi

Make all code changes only under the lib/ directory.

2. Commit and push to tsugi master

Before mirroring, changes must be committed and pushed to the canonical branch:

git status
git add lib/
git commit -m "Describe the change to the Tsugi PHP library"
git push origin master

Only committed changes are eligible to be mirrored.

3. Mirror lib/ to the tsugi-php repository

From the tsugi repository root, run the mirror script:

qa/mirror-tsugi-php.sh

This script:

1. Extracts the lib/ directory history
2. Reconstructs it as a standalone repository
3. Force-updates tsugi-php master using --force-with-lease

The result is an exact mirror of tsugi/lib.

4. Verify (optional)

After mirroring, you may verify that the change appears in the standalone repo:

git ls-remote https://github.com/tsugiproject/tsugi-php.git

or by browsing the repository on GitHub.

Important Notes

• The history in tsugi-php is a projection of the monorepo history and may differ from earlier standalone commits.
• Any commits made directly to tsugi-php may be replaced during the next mirror operation.
• All development discussion, issues, and pull requests belong in the main tsugi repository.

Summary

If you remember only one thing:

Commit and push to tsugi master first.
tsugi-php is generated from that state.