STRUCT

Tuist

Contents

• Properties
  • project
  • fullHandle
  • inspectOptions
  • url
• Methods
  • init(compatibleXcodeVersions:cloud:fullHandle:url:swiftVersion:plugins:generationOptions:inspectOptions:installOptions:)
  • init(fullHandle:inspectOptions:url:project:)

public struct Tuist: Codable, Equatable, Sendable

Properties

project

public let project: TuistProject

Configures the project Tuist will interact with. When no project is provided, Tuist defaults to the workspace or project in the current directory.

fullHandle

public let fullHandle: String?

The full project handle such as tuist-org/tuist.

inspectOptions

public let inspectOptions: InspectOptions

The options to use when running tuist inspect.

url

public let url: String

The base URL that points to the Tuist server.

Methods

init(compatibleXcodeVersions:cloud:fullHandle:url:swiftVersion:plugins:generationOptions:inspectOptions:installOptions:)

public init(
    compatibleXcodeVersions: CompatibleXcodeVersions = .all,
    cloud: Cloud? = nil,
    fullHandle: String? = nil,
    url: String = "https://tuist.dev",
    swiftVersion: Version? = nil,
    plugins: [PluginLocation] = [],
    generationOptions: GenerationOptions = .options(),
    inspectOptions: InspectOptions = .options(),
    installOptions: InstallOptions = .options()
)

Creates a tuist configuration.

• Parameters:
  • compatibleXcodeVersions: List of Xcode versions the project is compatible with.
  • cloud: Cloud configuration.
  • swiftVersion: The version of Swift that will be used by Tuist.
  • plugins: A list of plugins to extend Tuist.
  • generationOptions: List of options to use when generating the project.
  • installOptions: List of options to use when running tuist install.

Parameters

Name	Description
compatibleXcodeVersions	List of Xcode versions the project is compatible with.
cloud	Cloud configuration.
swiftVersion	The version of Swift that will be used by Tuist.
plugins	A list of plugins to extend Tuist.
generationOptions	List of options to use when generating the project.
installOptions	List of options to use when running tuist install.

init(fullHandle:inspectOptions:url:project:)

public init(
    fullHandle: String? = nil,
    inspectOptions: InspectOptions = .options(),
    url: String = "https://tuist.dev",
    project: TuistProject
)