TEC Utilities
TEC UTilities (or tut
) are a collection of tools for managing plugins.
/^\
L L / \ L L
__/|/|_ / . \ _|\|\__
/_| [_[_\ / .-\ /_]_] |_\
/__\ __`-\_____ / . \ _____/-`__ /__\
/___] /=@> _ {> /-. \ <} _ <@=\ [___\
/____/ /` `--/ / . \ \--` `\ \____\
/____/ \____/`-._> / \ <_.-`\____/ \____\
/____/ /__/ /-._ . _.- \ \__\ \____\
/____/ /__/ / . \ \__\ \____\
|____/_ _/__/ / . \ \__\_ _\____|
\__/_ ``_|_/ / -._ . _.-\ \_|_`` _\___/
/__`-`__\ <_ `-; _> /__`-`__\
`-` `-._ ; _.-` `-`
`-._ ; _.-`
`-._.-`
Installation
- Clone the repository
git clone [email protected]:the-events-calendar/tut.git
- Go to the new directory
cd tut
. - Copy
.env.sample
to.env
. (you don't have to fill in the values for most commands to work) - Run
composer install
- Add the cloned repo into your PATH (edit your
.bashrc
/.bash_profile
/.zshrc
or whatever)
export PATH=/path/to/tut:$PATH
Typical use cases
Top-level Commands
Command | Description |
---|---|
analyze |
Changelog entries for Hooks and Template changes |
build |
Mass composer/npm/gulp building |
changed-views |
Find all view changes in a branch |
generate-css-override |
Finds CSS rules for the purposes of providing overrides. |
get-build-number |
Gets the build number based on recent commit timestamp |
get-hash |
Gets current repo hash |
get-zip-filename |
Gets the expected zip filename for the plugin |
list-templates |
List templates in plugin |
package |
Package zips for release |
release-date |
Updates the release date in the readme.txt changelog |
reset |
Resets repo back to main/master |
sync |
Git branch synchronization |
submodule-sync |
Synchronizes submodules between repositories |
tbd |
TBD Locator |
upgrade |
Upgrades tut ! |
version |
Update version numbers |
Git Subcommands
Command | Description |
---|---|
git:clone |
Clone a repository |
git:file |
Fetch a file from a repository |
Extension Subcommands
Command | Description |
---|---|
extension:create |
Create a TEC/ET extension |
extension:set-dependency |
Modifies or adds a dependency to an extension repo on GitHub |