Application
Table of Contents
Interfaces
- AssetExecutorInterface
- FarahAssetResolverInterface
- UnityProcessOutputHandlerInterface
- HubLocatorInterface
- Creates Unity Hub processes for a concrete platform or discovery strategy.
- PackageMetadataReaderInterface
- WorkspaceInitializerInterface
- Creates a Unity project at the exact requested workspace path.
Classes
- ExecutableBase
- Base strategy for Farah executables that return XML result documents.
- HelpExecutable
- Exposes Unity Hub help output as a Farah executable asset.
- InstallExecutable
- Creates a temporary Unity project with a local package installed.
- InstallParameters
- Defines Farah URL parameters for package installation requests.
- PackageExecutableBase
- Base strategy for Farah executables that operate on Unity packages.
- UnityWorkspaceInitializer
- Creates a filesystem-backed empty project for a package workspace.
- WorkspaceInstallExecutable
- Installs an embedded package into a missing, empty, or exact project root.
- WorkspaceInstallParameters
- Defines Farah URL parameters for workspace-aware package installation.
- BuildExecutable
- Runs a Unity player build for a project asset request.
- BuildParameters
- Defines Farah URL parameters for project build requests.
- EmptyProjectExecutable
- Creates an empty Unity project using the latest final matching editor.
- EmptyProjectParameters
- Defines Farah URL parameters for empty-project requests.
- MethodExecutable
- Executes a Unity editor method for a project asset request.
- MethodParameters
- Defines Farah URL parameters for editor method requests.
- ModuleExecutable
- Installs Unity editor modules for a project asset request.
- ModuleParameters
- Defines Farah URL parameters for editor module installation requests.
- ProjectExecutableBase
- Base strategy for Farah executables that operate on Unity projects.
- SettingExecutable
- Reads a Unity project setting into an XML document.
- SettingParameters
- Defines Farah URL parameters for project setting lookup requests.
- TestsExecutable
- Runs Unity Test Runner modes for a project asset request.
- TestsParameters
- Defines Farah URL parameters for Unity Test Runner requests.
- VersionExecutable
- Reads or writes a Unity project's bundle version.
- VersionParameters
- Defines Farah URL parameters for project version requests.
- TestResult
- Builds process result XML for executable asset runs.
- AbstractAssetCommand
- ApplicationFactory
- AssetExecutionResult
- AssetExecutor
- DefaultUnityProcessOutputHandler
- FarahAssetResolver
- BuildCommand
- EmptyProjectCommand
- MethodCommand
- ModuleInstallCommand
- PackageInstallCommand
- StartCommand
- TestsCommand
- AtomicReportWriter
- Publishes a complete report through a same-directory atomic rename.
- JUnitReporter
- High-level integration API for transforming, validating, and writing JUnit.
- JUnitReportTransformer
- Wraps operation data in a stable XML envelope and transforms it to JUnit.
- JUnitReportValidator
- Validates generated reports against the configured Farah JUnit schema while
allowing testcase-level output supported by Jenkins and Maven Surefire.
- OperationMetadata
- Describes one unity-command operation independently of its result document.
- ReportError
- Canonical error data used when no command-specific result document exists.
- ReportingException
- ReportTransformationException
- ReportValidationException
- ReportWriteException
- SymfonyProcessOutputHandler
- UnityApplication
- Symfony application that also reports command-line validation failures.
- UnityArgvInput
- Accepts the documented stdout destination spelling `--junit -`.
- Settings
- Creates DocFX configuration, templates, and table-of-contents files for Unity projects.
- FormatLog
- Converts dotnet format JSON reports into XML documents.
- ExecutionError
- Represents a Unity automation failure with process output that can be exported as JUnit-style XML.
- GitProject
- Wraps git command execution for historical automation workflows.
- JsonUtils
- Loads and saves JSON files used by Unity project and package metadata.
- JUnit
- Formats dates for JUnit-compatible XML reports.
- LocateHubFromCommand
- Locates Unity Hub through a configured command line.
- LocateHubFromWindowsRegistry
- Locates Unity Hub from the Windows registry.
- LocateHubNull
- Null object hub locator used when Unity Hub cannot be discovered.
- MailboxAccess
- Reads verification codes from an IMAP mailbox for external service logins.
- MLContext
- Manages a legacy ML-Agents Python environment for Unity training runs.
- MLParameters
- Parses legacy ML-Agents training parameters and renders shell arguments.
- MLTraining
- Coordinates legacy ML-Agents training runs for Unity projects.
- EmbeddedPackageReplacer
- Stages and transactionally activates exactly one embedded package.
- ManifestFileManager
- Reads, validates, merges, and atomically replaces Unity manifest JSON files.
- ManifestMerger
- Deterministically combines two decoded Unity manifest objects.
- PackageInstallationException
- Reports validation and filesystem failures during package installation.
- PackageMetadata
- Validated metadata used to derive an embedded package destination.
- PackageMetadataReader
- Validates package.json and its filesystem-safe Unity package name.
- PreparedWorkspace
- Describes the exact project root selected for package installation.
- WorkspaceClassification
- The result of examining one workspace path without searching around it.
- WorkspaceClassifier
- Classifies only the supplied path as a Unity workspace.
- WorkspacePreparer
- Reuses exact project roots and delegates Unity-backed project creation.
- AppBuild
- Builds Steam app build VDF files for SteamCMD uploads.
- SteamCMD
- Automates SteamCMD login, including optional Steam Guard code retrieval.
- UnityBuildTarget
- Maps logical build targets to Unity editor modules, output names, and batchmode arguments.
- UnityEditor
- Wraps one Unity Editor installation and executes batchmode commands.
- UnityEnvironment
- Reads Unity automation environment variables and formats process log output.
- UnityHub
- Process-wide facade for Unity Hub discovery, editor installation, and project/package lookup.
- UnityHubConfig
- UnityLicensor
- Signs Unity manual activation files through Unity's browser-based license flow.
- UnityPackage
- Represents a Unity package and creates temporary projects that install it locally.
- UnityPackageInfo
- Reads and writes Unity package metadata from package.json.
- UnityProject
- Represents a Unity project and exposes editor automation operations for it.
- UnityProjectInfo
- Reads and writes Unity project metadata from ProjectSettings and Packages files.
- UnityReleaseApi
- Resolves Unity editor releases through Unity's official Release API.
Enums
- WorkspaceState
- Exact-root states accepted by the workspace-first installation flow.