https://github.com/brightdigit/eggseed
Command Line Tool for Starting Your Swift Packages with Continuous Integration
https://github.com/brightdigit/eggseed
badges codecov codefactor github-actions hound swift swift-package-manager swiftpm travis
Last synced: about 1 month ago
JSON representation
Command Line Tool for Starting Your Swift Packages with Continuous Integration
- Host: GitHub
- URL: https://github.com/brightdigit/eggseed
- Owner: brightdigit
- License: mit
- Created: 2020-02-04T18:29:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-18T16:48:37.000Z (over 4 years ago)
- Last Synced: 2025-04-01T09:51:13.869Z (about 2 months ago)
- Topics: badges, codecov, codefactor, github-actions, hound, swift, swift-package-manager, swiftpm, travis
- Language: Swift
- Homepage:
- Size: 269 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://swift.org)
[](http://twitter.com/leogdion)
[](https://github.com/brightdigit/EggSeed/actions?query=workflow%3AmacOS)
[](https://github.com/brightdigit/EggSeed/actions?query=workflow%3Aubuntu)
[](https://github.com/brightdigit/EggSeed/actions?query=workflow%3Aarm)
[](https://travis-ci.com/brightdigit/EggSeed)
[](https://circleci.com/gh/brightdigit/EggSeed)
[](https://app.bitrise.io/app/238176596b2afbd3)
[](https://codecov.io/gh/brightdigit/EggSeed)
[](https://www.codefactor.io/repository/github/brightdigit/EggSeed)
[](https://codebeat.co/projects/github-com-brightdigit-EggSeed-master)
[](https://codeclimate.com/github/brightdigit/EggSeed)
[](https://codeclimate.com/github/brightdigit/EggSeed)
[](https://codeclimate.com/github/brightdigit/EggSeed)
[](https://houndci.com)
---
**EggSeed** is a command-line tool for creating swift pacakges with continous integration support. While `swift package init`, creates simple packages, there is no guarantee that your package will work on everyone else's device. That's where _continuous integration_ goes in.
By using `eggseed`, you can create a package with full integration into CI services such as: _[GitHub Actions](https://github.com/actions), [Travis-CI](https://travis-ci.com/), [BitRise](https://www.bitrise.io), [CircleCI](https://circleci.com)_ and more. Not only that but **EggSeed** also sets up code documentation, linting, and more...
Check out the [roadmap below](#roadmap) for more details on future integrations.
# Installation
### [Mint](https://github.com/yonaskolb/mint)
```sh
mint install brightdigit/EggSeed
```
### Swift Package Manager
**Use as CLI**
```shell
git clone https://github.com/brightdigit/EggSeed.git
cd EggSeed
swift run eggseed
```
**Use as dependency**
Add the following to your Package.swift file's dependencies:
```swift
.package(url: "https://github.com/brightdigit/EggSeed.git", from: "0.2.0"),
```
And then import wherever needed: `import EggSeed`
# Usage
```
USAGE: eggseed [--package-type ] [--user-name ] [--path ]
OPTIONS:
--package-type
Swift Package Type (default: library)
--user-name User name or Owner of Repostory.
--path Root path of the Swift Package.
-h, --help Show help information.
```
**Eggseed** can be run without any options. However there are a few options which can help customize your package:
## Package Type `--package-type` (library or executable)
Desginates what type of package you are creating.
## User Name `--user-name`
The owner to user name of the repository. If not specified, EggSeed will attempt to parse the URL for that information.
## Path `--path`
Directory to create the Swift Package in, otherwise use the current directory.
# Documentation
All code [documentation is here.](/Documentation/Reference/README.md)
# Roadmap
Future Released Will Include:
* Choosing a License ([MIT](https://choosealicense.com/licenses/mit/), [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/), [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/), etc...)
* Choosing Target OS and Version for CI (macOS v10_12, watchOS v6_2, Ubuntu Focal, iOS 12, etc...)
* Choosing CI Services ([GitHub Actions](https://github.com/actions), [Travis-CI](https://travis-ci.com/), [BitRise](https://www.bitrise.io), [CircleCI](https://circleci.com), etc...)
* Custom Template URLs
* Adding [Cocoapod](https://cocoapods.org) Support
* Adding [Carthage](https://github.com/Carthage/Carthage) Support
* Adding [Homebrew](https://brew.sh) Support
* Choosing Code Documentation Tool ([SourceDocs](https://github.com/eneko/SourceDocs), [Jazzy](https://github.com/realm/jazzy), etc...)
* Choosing Linting Support ([SwiftFormat](https://github.com/nicklockwood/SwiftFormat), [SwiftLint](https://github.com/realm/SwiftLint), etc...)
* Allow For Multiple Products On Setup
* Choosing Architecture Support (amd64, aarch64, etc...)
* Support for [Komondor](https://github.com/shibapm/Komondor)
* Support for [Rocket](https://github.com/shibapm/Rocket)
* Support for [Swift Package Index](https://swiftpackageindex.com)
* Automated Code Quality Integrations ([codebeat](https://codebeat.co), [Code Climate](https://codeclimate.com), [Code Factory](https://www.codefactor.io), etc...)
* README template and badges
Feel free to [add an issue for any suggestions](https://github.com/brightdigit/EggSeed/issues).
## Contact
Follow and contact me on [Twitter](http://twitter.com/leogdion). If you find an issue,
just [open a ticket](https://github.com/brightdigit/EggSeed/issues/new) on it. Pull
requests are warmly welcome as well.
# License
EggSeed is licensed under the MIT license. See [LICENSE](LICENSE) for more info.