Quickstart
Three ways in. Install the App for pull requests, scan a public repository for a report, or run the CLI on a checkout.
Installpick repos
- First scanevery manifest
- Configure Teirea PR with teire.yml
- Fix runsurgent first
- Pull requestsready · draft · issue
Install Teire on GitHub
Open github.com/apps/teire-bot and pick the repositories. GitHub then sends you to /welcome. Sign in with GitHub there to watch each repository's first scan.
Read the first scan
Teire downloads each repository at one commit and reads every manifest and lockfile. It checks each dependency against its registry and the APIs your code calls against their change pages.
If the repository has no teire.yml, Teire opens a pull request named Configure Teire. It adds only .github/teire.yml with the defaults. Its body lists what Teire found and the upgrades it will open once you merge.
A repository that already has a teire.yml skips this and goes straight to work. One where Teire can read nothing (no manifest in its six ecosystems, no API or model in the code) gets no pull request; the dashboard says what was searched. Closing Configure Teire without merging means "no thanks": the repository is paused until @teire resume. Teire works the same on an organisation or a personal account.
Merge Configure Teire
The repository becomes active and is scanned again. Teire queues a fix run for each change that reaches your code, most urgent first, then a plain upgrade for every other outdated direct dependency. Turn those off with upgrades.plainBumps: false. By default at most 5 Teire PRs are open at once and 2 new ones open per hour. The Teire Dashboard issue appears and stays current.
Review the pull requests
Each PR is ready when your checks pass after the change and nothing got worse than before, with tests counted. It is a draft when something could not be proven, and the PR says what. When the fix breaks a check, no check can be found, or a check times out, Teire opens an issue for a person instead. See Anatomy of a Teire PR.
