Skip to content

Install Theos

Actions

About

Install Theos and prepare it for building projects
v1.5
Latest
Star (41)

theos-action

Build Theos projects (usually iOS tweaks) with GitHub Actions easily.

Wait, what's Theos?

Theos is a cross-platform building suite for iOS and MacOS. It's mainly used for developing and compiling jailbroken iOS tweaks for the iPhone/iPad.

Why?

Theos is a bit of a pain to set up sometimes. It requires quite a few dependencies, and it takes a considerable amount of storage space. It's not easy to set up manually in a CI workflow. That's where this comes in! Additionally, this allows people to build their tweaks without having to install Xcode on their own machine, or even without a computer at all!

Usage

You must use a MacOS or Linux runner. Windows is not supported, and probably never will be.

- uses: Randomblock1/theos-action@v1
  with:
    # All of these are optional. Defaults are filled in below.
    
    # This is where Theos is downloaded to.
    theos-dir: 'theos'
    
    # This is where Theos will be git cloned from.
    theos-src: 'https://github.com/theos/theos'
    
    # This is where the Theos SDKs will be downloaded from.
    # Useful for using frameworks that aren't in the official repo.
    theos-sdks: 'https://github.com/theos/sdks'

    # Which branch to clone from theos-sdks repo.
    theos-sdks-branch: 'master'

Example

See this workflow as an example of how to use this. It configures a custom SDK repository, uses GitHub Actions cache to speed up downloads (Theos and the SDKs are rarely updated), builds a tweak, and packages it up using GitHub Artifacts.

That workflow should work out-of-the-box for most Theos projects. Some tweaking is required, but it's basically just copy-paste.

License

This project is released under the MIT License.

Install Theos is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Install Theos and prepare it for building projects
v1.5
Latest

Install Theos is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.