Skip to content

Browse API docs

ShipItKit

Classes
ActionRegistry
AppStoreConnectClient
GooglePlayJWTGenerator
JWTGenerator
PluginRegistry
RateLimiter
WorkloadIdentityFederationClient
Protocols
Action
EmptyBodyResponse
InfrastructureFailureClassifier
ShipItPlugin
TestArtifactLocator
TestRerunPlanner
TestResultParser
Structures
AIReadiness
AISessionBuilder
AISessionPayload
ASCApp
ASCBetaGroup
ASCBetaTester
ASCBuild
ASCListResponse
ASCResponse
ActionContext
ActionDescriptor
ActionResultEnvelope
ActionSchema
ActionValidationContext
ActionValidationRule
Agvtool
Altool
AmbiguityFlag
AndroidCLIConfig
AndroidCLIVersionAction
AndroidCLIWorkflowOptions
AndroidCLIWorkflowResult
AndroidConfig
AndroidCreateAction
AndroidDescribeAction
AndroidDocsAction
AndroidEmulatorAction
AndroidHelpAction
AndroidInfoAction
AndroidInfrastructureClassifier
AndroidInitAction
AndroidInstallAction
AndroidJUnitTestParser
AndroidLayoutAction
AndroidRunAction
AndroidSDKAction
AndroidScreenAction
AndroidSkillsAction
AndroidStudioAction
AndroidUpdateAction
AppConfig
AppStoreConnectConfig
AppStoreReleaseService
ArchiveAction
ArchiveConfig
AssetUploader
Bash
BuildAction
- Configuration
- BuildAction.Options
- Results
- BuildAction.Result
  - Initializers
  - init(appPath: String?, dsymPath: String?, apkPath: String?, exitCode: Int, warnings: Int)
  - init(from: any Decoder) throws
  - Instance Properties
  - let apkPath: String?
  - let appPath: String?
  - let dsymPath: String?
  - let exitCode: Int
  - let warnings: Int
- Initializers
- init()
- Instance Methods
- func run(with: BuildAction.Options, context: ActionContext) async throws -> BuildAction.Result
- Type Properties
- static let description: String
- static let name: String
- static var validationRules: [ActionValidationRule]
- Enumerations
- BuildAction.BuildConfiguration
  - Enumeration Cases
  - case debug
  - case release
  - Initializers
  - init?(rawValue: String)
  - Default Implementations
  - Equatable Implementations
    - Operators
    - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Initializers
    - init(from: any Decoder) throws
    - Instance Properties
    - var hashValue: Int
    - Instance Methods
    - func encode(to: any Encoder) throws
    - func hash(into: inout Hasher)
- Default Implementations
- Action Implementations
  - Type Methods
  - static func descriptor(for: Self, optionSchema: [SchemaField], platforms: Set<Platform>?, validationRules: [ActionValidationRule]) -> ActionDescriptor
BuildConfig
CLIOptions
CertVault
CertificateInfo
CertificateManager
CodeSigningConfig
ConfigResolver
CoverageAction
CustomActionConfig
CustomActionParameter
DsymAction
Environment
ExportAction
ExportConfig
FirebaseAppDistributionAction
FirebaseAppDistributionClient
FirebaseAppID
FirebaseRelease
FirebaseReleaseNotes
FirebaseUploadReleaseResponse
FlutterCLI
FlutterInfrastructureClassifier
FlutterMachineOutputParser
FrameAction
Frameit
GenerateProjectAction
GitAction
GitCLI
GooglePlayApk
GooglePlayBundle
GooglePlayClient
GooglePlayEdit
GooglePlayRelease
GooglePlayReleaseNote
GooglePlayTrack
GooglePlayUploadService
GoogleServiceAccountCredentials
GradleBuildSummary
IOSArchiveInfrastructureClassifier
IOSConfig
IOSInfrastructureClassifier
IOSXCResultTestParser
IPAUploadService
InferredConfigEntry
InfrastructureRetryScheduler
JSONReporter
JSScriptRunner
JestJSONTestParser
KMPInfrastructureClassifier
KeychainHelper
LintAction
MetadataAction
MetadataConfig
NextAction
NoContentResponse
NotificationsConfig
Notifier
NotifyAction
PagedLinks
ParsedTestCase
ParsedTestRun
ParsedTestSuite
ParsingDiagnostic
PlayStoreAction
Plutil
PrecheckAction
ProfileManager
ProjectGenerationConfig
ProjectInspection
ProjectInspector
ProvisionAction
ProvisioningProfileInfo
ReactNativeCLI
ReactNativeInfrastructureClassifier
ResolvedConfig
RetryPolicy
SchemaField
SchemaSection
ScreenshotsConfig
SecretDescriptor
SecurityCLI
Shipfile
ShipfileSuggester
ShipfileValidator
SignAction
Simctl
SimctlCommand
SimctlListTarget
SlackAttachment
SlackConfig
SlackPayload
SnapshotAction
SuggestedShipfile
TestAction
TestArtifact
TestAttempt
TestDeviceConfig
TestFlightAction
TestFlightConfig
TestParseContext
TestResultsAction
TestRunReport
TestSummary
UploadAction
UploadCommit
UploadHeader
UploadOperation
UploadReservation
ValidateArchiveAction
ValidateBundleAction
ValidationIssue
ValidationReport
VersionAction
VersionBumper
VersioningConfig
Which
Workflow
WorkflowConfig
WorkflowResult
WorkflowStep
WorkflowStepConfig
Xccov
XcodeBuildSummary
Xcrun
XcrunOption
Functions
func formatDurationSeconds(Double) -> String
Enumerations
AndroidBuildType
BuildNumberStrategy
BuildSystem
BuiltInSchemaCatalog
BuiltInValidationRules
CompositeAction
CoverageFormat
CoverageSort
FirebaseAppPlatform
FirebaseUploadResult
GooglePlayReleaseStatus
GradleTaskScope
InferenceConfidence
InferenceSource
JSONValue
JSPackageManager
JWTGeneratorError
ParsingDiagnosticSeverity
Platform
PlutilConversionFormat
PlutilConversionOutput
PlutilEmptyCollection
PlutilExtractionFormat
PlutilValue
PlutilValueType
SchemaFieldNode
SchemaValidator
SchemaValueKind
ShipItError
SuggestionGoal
TestArtifactKind
TestCaseStatus
TestDeviceStrategy
TestKind
TestRerunSelector
TestResultsFormat
ValidationIssueSeverity
WorkflowBuilder
Extended Modules
Logging
Swift

ShipItKit

Classes
ActionRegistry
AppStoreConnectClient
GooglePlayJWTGenerator
JWTGenerator
PluginRegistry
RateLimiter
WorkloadIdentityFederationClient
Protocols
Action
EmptyBodyResponse
InfrastructureFailureClassifier
ShipItPlugin
TestArtifactLocator
TestRerunPlanner
TestResultParser
Structures
AIReadiness
AISessionBuilder
AISessionPayload
ASCApp
ASCBetaGroup
ASCBetaTester
ASCBuild
ASCListResponse
ASCResponse
ActionContext
ActionDescriptor
ActionResultEnvelope
ActionSchema
ActionValidationContext
ActionValidationRule
Agvtool
Altool
AmbiguityFlag
AndroidCLIConfig
AndroidCLIVersionAction
AndroidCLIWorkflowOptions
AndroidCLIWorkflowResult
AndroidConfig
AndroidCreateAction
AndroidDescribeAction
AndroidDocsAction
AndroidEmulatorAction
AndroidHelpAction
AndroidInfoAction
AndroidInfrastructureClassifier
AndroidInitAction
AndroidInstallAction
AndroidJUnitTestParser
AndroidLayoutAction
AndroidRunAction
AndroidSDKAction
AndroidScreenAction
AndroidSkillsAction
AndroidStudioAction
AndroidUpdateAction
AppConfig
AppStoreConnectConfig
AppStoreReleaseService
ArchiveAction
ArchiveConfig
AssetUploader
Bash
BuildAction
- Configuration
- BuildAction.Options
- Results
- BuildAction.Result
  - Initializers
  - init(appPath: String?, dsymPath: String?, apkPath: String?, exitCode: Int, warnings: Int)
  - init(from: any Decoder) throws
  - Instance Properties
  - let apkPath: String?
  - let appPath: String?
  - let dsymPath: String?
  - let exitCode: Int
  - let warnings: Int
- Initializers
- init()
- Instance Methods
- func run(with: BuildAction.Options, context: ActionContext) async throws -> BuildAction.Result
- Type Properties
- static let description: String
- static let name: String
- static var validationRules: [ActionValidationRule]
- Enumerations
- BuildAction.BuildConfiguration
  - Enumeration Cases
  - case debug
  - case release
  - Initializers
  - init?(rawValue: String)
  - Default Implementations
  - Equatable Implementations
    - Operators
    - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Initializers
    - init(from: any Decoder) throws
    - Instance Properties
    - var hashValue: Int
    - Instance Methods
    - func encode(to: any Encoder) throws
    - func hash(into: inout Hasher)
- Default Implementations
- Action Implementations
  - Type Methods
  - static func descriptor(for: Self, optionSchema: [SchemaField], platforms: Set<Platform>?, validationRules: [ActionValidationRule]) -> ActionDescriptor
BuildConfig
CLIOptions
CertVault
CertificateInfo
CertificateManager
CodeSigningConfig
ConfigResolver
CoverageAction
CustomActionConfig
CustomActionParameter
DsymAction
Environment
ExportAction
ExportConfig
FirebaseAppDistributionAction
FirebaseAppDistributionClient
FirebaseAppID
FirebaseRelease
FirebaseReleaseNotes
FirebaseUploadReleaseResponse
FlutterCLI
FlutterInfrastructureClassifier
FlutterMachineOutputParser
FrameAction
Frameit
GenerateProjectAction
GitAction
GitCLI
GooglePlayApk
GooglePlayBundle
GooglePlayClient
GooglePlayEdit
GooglePlayRelease
GooglePlayReleaseNote
GooglePlayTrack
GooglePlayUploadService
GoogleServiceAccountCredentials
GradleBuildSummary
IOSArchiveInfrastructureClassifier
IOSConfig
IOSInfrastructureClassifier
IOSXCResultTestParser
IPAUploadService
InferredConfigEntry
InfrastructureRetryScheduler
JSONReporter
JSScriptRunner
JestJSONTestParser
KMPInfrastructureClassifier
KeychainHelper
LintAction
MetadataAction
MetadataConfig
NextAction
NoContentResponse
NotificationsConfig
Notifier
NotifyAction
PagedLinks
ParsedTestCase
ParsedTestRun
ParsedTestSuite
ParsingDiagnostic
PlayStoreAction
Plutil
PrecheckAction
ProfileManager
ProjectGenerationConfig
ProjectInspection
ProjectInspector
ProvisionAction
ProvisioningProfileInfo
ReactNativeCLI
ReactNativeInfrastructureClassifier
ResolvedConfig
RetryPolicy
SchemaField
SchemaSection
ScreenshotsConfig
SecretDescriptor
SecurityCLI
Shipfile
ShipfileSuggester
ShipfileValidator
SignAction
Simctl
SimctlCommand
SimctlListTarget
SlackAttachment
SlackConfig
SlackPayload
SnapshotAction
SuggestedShipfile
TestAction
TestArtifact
TestAttempt
TestDeviceConfig
TestFlightAction
TestFlightConfig
TestParseContext
TestResultsAction
TestRunReport
TestSummary
UploadAction
UploadCommit
UploadHeader
UploadOperation
UploadReservation
ValidateArchiveAction
ValidateBundleAction
ValidationIssue
ValidationReport
VersionAction
VersionBumper
VersioningConfig
Which
Workflow
WorkflowConfig
WorkflowResult
WorkflowStep
WorkflowStepConfig
Xccov
XcodeBuildSummary
Xcrun
XcrunOption
Functions
func formatDurationSeconds(Double) -> String
Enumerations
AndroidBuildType
BuildNumberStrategy
BuildSystem
BuiltInSchemaCatalog
BuiltInValidationRules
CompositeAction
CoverageFormat
CoverageSort
FirebaseAppPlatform
FirebaseUploadResult
GooglePlayReleaseStatus
GradleTaskScope
InferenceConfidence
InferenceSource
JSONValue
JSPackageManager
JWTGeneratorError
ParsingDiagnosticSeverity
Platform
PlutilConversionFormat
PlutilConversionOutput
PlutilEmptyCollection
PlutilExtractionFormat
PlutilValue
PlutilValueType
SchemaFieldNode
SchemaValidator
SchemaValueKind
ShipItError
SuggestionGoal
TestArtifactKind
TestCaseStatus
TestDeviceStrategy
TestKind
TestRerunSelector
TestResultsFormat
ValidationIssueSeverity
WorkflowBuilder
Extended Modules
Logging
Swift

Instance Property

apkPath

Path to the output APK file. (Android)

let apkPath: String?

Docs API Reference GitHub Releases License (MIT)

This site uses Vercel’s cookieless, anonymous analytics to count page views — no cookies, no cross-site tracking. The ShipItSwifty CLI itself collects zero telemetry.