Getting Started

Learn how to integrate the plugins into your project

Overview

Use the plugins by including as a package to your project and declaring in the plugins section of your target.

Note: You must use swift-tools version 5.6 or greater for package plugins and target macOS(.v13) or greater.

// swift-tools-version: 5.10

import PackageDescription

let package = Package(
  platforms:[.macOS(.v13)],
  dependencies: [
    ...,
    .package(url: "https://github.com/m-housh/swift-cli-version.git", from: "0.2.0")
  ],
  targets: [
    .executableTarget(
      name: "<target name>",
      dependencies: [...],
      plugins: [
        .plugin(name: "BuildWithVersionPlugin", package: "swift-cli-version")
      ]
    )
  ]
)

The above example uses the build tool plugin. The BuildWithVersionPlugin will give you access to a VERSION variable in your project that you can use to supply the version of the tool.

Example

import ArgumentParser

@main
struct MyCliTool: ParsableCommand {
  static let configuration = CommandConfiguration(
    abstract: "My awesome cli tool",
    version: VERSION
  )

  func run() throws {
    print("Version: \(VERSION)")
  }
}

After you enable the plugin, you will have access to the VERSION string variable even though it is not declared in your source files.

Note: If your DerivedData folder lives in a directory that is a mounted volume / or somewhere that is not under your home folder then you may get build failures using the build tool plugin, it will work if you build from the command line and pass the --disable-sandbox flag to the build command or use one of the manual methods.

1.7 KiB Raw Blame History

Getting Started

Overview

Example

See Also

1.7 KiB

Raw Blame History