https://github.com/meniny/swiftycli
💻 A tool helps you to build command line application with Swift.
https://github.com/meniny/swiftycli
Last synced: 11 months ago
JSON representation
💻 A tool helps you to build command line application with Swift.
- Host: GitHub
- URL: https://github.com/meniny/swiftycli
- Owner: Meniny
- License: mit
- Created: 2018-05-08T11:41:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-19T10:48:11.000Z (about 8 years ago)
- Last Synced: 2025-08-04T22:55:39.488Z (11 months ago)
- Language: Swift
- Homepage:
- Size: 201 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE.md
Awesome Lists containing this project
README
:name: SwiftyCLI
:author: Elias Abel
:mail: admin@meniny.cn
:desc: a Swifty command lint tool
:version: 1.0.0
:na: N/A
:yes: ✔️
:no: ❌
:ios: {na}
:macos: 10.9
:watchos: {na}
:tvos: {na}
:linux: {yes}
:xcode: 9.3
:swift: 4.1
:license: MIT
:platform: macOS
= Meet `{name}`
{author} <{mail}>
v{version}, 2018-05-08
[subs="attributes"]
++++
++++
:toc:
== 🏵 Introduction
**{name}** is {desc}.
== 📋 Requirements
[%header]
|===
2+^m|Type 1+^m|Requirement
1.5+^.^|Platform ^|iOS ^|{ios}+
^|macOS ^e|{macos}
^|tvOS ^e|{tvos}
^|watchOS ^e|{watchos}
^|Linux ^e|{linux}
^|IDE ^|Xcode ^| {xcode}+
^|Language ^|Swift ^| {swift}+
|===
== 📲 Installation
=== CocoaPods
`{name}` is available on link:https://cocoapods.org[CocoaPods].
[source, ruby, subs="verbatim,attributes"]
----
platform :osx, '{macos}'
use_frameworks!
pod '{name}'
----
==== Rome
Add `plugin 'cocoapods-rome'` to your `Podfile`.
Then, before you run `pod insall`, you have to install [cocoapods-rome](https://github.com/neonichu/Rome) plugin:
[source, console, subs="verbatim,attributes"]
----
$ gem install cocoapods-rome
----
[source, ruby, subs="verbatim,attributes"]
----
platform :osx, '10.10'
plugin 'cocoapods-rome', {
dsym: true,
configuration: 'Release'
}
target 'TargetName' do
use_frameworks!
pod '{name}', :path => '../'
end
----
=== Manually
Copy all files in the `{name}` directory into your project.
== 🛌 Dependency
{na}
== ❤️ Contribution
You are welcome to fork and submit pull requests.
== 🔖 License
`{name}` is open-sourced software, licensed under the link:./LICENSE.md[`{license}`] license.
== 🔫 Usage
.YourScript.swift
[source, swift, subs="verbatim,attributes"]
----
#!/usr/bin/env xcrun swift -F ./Rome/ -framework SwiftyCLI
import {name}
// ...
----
[CAUTION]
====
The tree of your folder should look like this:
[source, console, subs="verbatim"]
----
.
├── YourScript.swift
│
├── Podfile
├── Pods
│ └── ...
└── Rome
└── SwiftyCLI.framework
----
====
== ♨️ Running
To run your script file:
[source, console, subs="verbatim,attributes"]
----
$ chmod a+x YourScript.swift
$ ./YourScript.swift
----