https://github.com/yutailang0119/progressspinnerkit
A library to display an ActivityIndicator for CLI.
https://github.com/yutailang0119/progressspinnerkit
cli swift swift-package-manager
Last synced: 10 months ago
JSON representation
A library to display an ActivityIndicator for CLI.
- Host: GitHub
- URL: https://github.com/yutailang0119/progressspinnerkit
- Owner: yutailang0119
- License: mit
- Created: 2018-07-28T08:05:53.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T08:23:21.000Z (over 1 year ago)
- Last Synced: 2025-08-01T22:07:01.131Z (11 months ago)
- Topics: cli, swift, swift-package-manager
- Language: Swift
- Homepage: https://github.com/yutailang0119/ProgressSpinnerKit
- Size: 333 KB
- Stars: 43
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A library to display an ActivityIndicator for CLI.
Motivated by
* [apple/swift-tools-support-core//TSCUtility/ProgressAnimation](https://github.com/apple/swift-tools-support-core/blob/main/Sources/TSCUtility/ProgressAnimation.swift)
* [briandowns/spinner](https://github.com/briandowns/spinner)
## A Work In Progress
ProgressSpinnerKit is still in active development.
## Dome
## Installation
### [Swift Package Manager](https://swift.org/package-manager/)
```swift
// swift-tools-version:5.9
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "ExamplePackage",
dependencies: [
.package(url: "https://github.com/yutailang0119/ProgressSpinnerKit", from: "0.5.0"),
],
targets: [
.target(name: "ExampleTarget", dependencies: ["ProgressSpinnerKit"]),
]
)
```
https://github.com/apple/swift-package-manager
## Usage
```swift
import TSCBasic
import ProgressSpinnerKit
let task = Task {
let spinner = progressSpinner(for: TSCBasic.stdoutStream, header: " Loading:")
await spinner.start()
}
// Something on the main thread.
task.cancel()
```
## Author
[Yutaro Muta](https://github.com/yutailang0119)
- muta.yutaro@gmail.com
- [@yutailang0119](https://twitter.com/yutailang0119)
## License
ProgressSpinnerKit is available under the MIT license. See [the LICENSE file](./LICENSE) for more info.
This software includes the work that is distributed in the Apache License 2.0.