BushelKit

Open source components of Bushel for developers.

Table of Contents

• Introduction
• Usage
• Roadmap
• Documentation
• License

Introduction

This is an open-source component for Bushel, a macOS virtual machine app for developers. This will utilitized in the future for build open-source apps such as a command line app and more.

Requirements

Apple Platforms

• Xcode 16.0 or later
• Swift 6.0 or later
• iOS 17 / watchOS 10.0 / tvOS 17 / macOS 14 or later deployment targets

Linux

• Ubuntu 20.04 or later
• Swift 6.0 or later

Usage

If you'd like to use BushelKit, add the products you'd like to use in your app.

let package = Package(
  ...
  dependencies: [
    .package(url: "https://github.com/brightdigit/BushelKit.git", from: "2.0.0")
  ],
  targets: [
      .target(
          name: "YourApp",
          dependencies: [
            .product(name: "BushelLibrary", package: "BushelKit"),
            .product(name: "BushelMachine", package: "BushelKit"),
            ...
      ]),
  ]
)

Roadmap

This library is still under construction. Here are the plans for the future.

v2.1

• #10 (docs) - Finish Documentation for bushel CLI

2.2

• #48 - bushel CLI v.x
• #47 - Add Tutorials for Creating a Machine / #11 - docs
• #34 - Finish Documentation for BushelMachine DocC

2.3

• #47 - Add Tutorial for Creating a Library / #12 docs
• #45 - Add Tutorial for Importing/Downloading an Image Into a Library / #13 docs
• #30 - Finish Documentation for BushelLibrary DocC

2.4

• #38 - Finish Documentation for BushelUtilities DocC
• #27 - Finish Documentation for BushelHub DocC
• #43 - Add Tutorial for Creating A Machine From A Snapshot / #15 docs
• #41 - Add Tutorial for Verifying An Image / #17 docs

2.5

• #24 - Finish Documentation for BushelFoundation DocC
• #23 - Finish Documentation for BushelFactory DocC
• #42 - Add Tutorial for Booting Up Machine / #16 docs
• #18 (docs) - Finish Documentation for Bushel REST API
• #44 - Add Tutorial for Creating A Snapshot / #14 docs

Future Release

• #40 - Finish Documentation for bushel DocC
• #37 - Finish Documentation for BushelUT DocC
• #36 - Finish Documentation for BushelTestUtilities DocC
• #35 - Finish Documentation for BushelMachineWax DocC
• #33 - Finish Documentation for BushelMacOSCore DocC
• #32 - Finish Documentation for BushelLogging DocC
• #31 - Finish Documentation for BushelLibraryWax DocC
• #29 - Finish Documentation for BushelHubMacOS DocC
• #28 - Finish Documentation for BushelHubIPSW DocC
• #26 - Finish Documentation for BushelGuestProfile DocC
• #25 - Finish Documentation for BushelFoundationWax DocC
• #22 - Finish Documentation for BushelDocs DocC
• #21 - Finish Documentation for BushelArgs DocC

Documentation

To learn more, check out the full documentation.

License

This code is distributed under the MIT license. See the LICENSE file for more info.