Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darrarski/swift-shell
Library for running shell scripts and other executables from swift code.
https://github.com/darrarski/swift-shell
bash-scripting cli shell-scripts swift swift-package
Last synced: 29 days ago
JSON representation
Library for running shell scripts and other executables from swift code.
- Host: GitHub
- URL: https://github.com/darrarski/swift-shell
- Owner: darrarski
- License: mit
- Created: 2024-07-20T18:40:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T09:50:25.000Z (5 months ago)
- Last Synced: 2024-12-06T05:45:11.935Z (about 1 month ago)
- Topics: bash-scripting, cli, shell-scripts, swift, swift-package
- Language: Swift
- Homepage:
- Size: 328 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🐚 Swift Shell
Library for running shell scripts and other executables from swift code.
## 📖 Documentation
The library is distributed as a swift package.
```swift
// in your Package.swift, add package dependency:
.package(url: "https://github.com/darrarski/swift-shell.git", from: "0.1.0"),
// and add the library as a dependency to your target:
.product(name: "SwiftShell", package: "swift-shell"),
```
The code is dressed in documentation comments that explain the purpose of each variable and function. The examples described below and the library [unit tests](Tests/SwiftShellTests) explain how to use it. You can also check out the auto-generated [documentation hosted on SwiftPackageIndex](https://swiftpackageindex.com/darrarski/swift-shell/main/documentation/swiftshell).
## 📚 Examples
Run bash script, send input, and retrieve the script's output:
```swift
let process = ShellProcess(.bash("IFS= read -r NAME; echo Hello, $NAME!"))
try await process.run()
try await process.send(input: "Swift\n".data(using: .utf8)!)
let output = try await process.output()!
print(String(data: output, encoding: .utf8)!) // Hello, Swift!
```
Check out the examples included in this repository:
Send input and stream bash script's output.
#### InputOutputExample
[Source code](Examples/Sources/InputOutputExample/InputOutputExample.swift)
Run example:
```sh
$ Examples/run.sh -- InputOutputExample
```
---
Stream and decorate bash script's output.
#### DecorateOutputExample
[Source code](Examples/Sources/DecorateOutputExample/DecorateOutputExample.swift)
Run example:
```sh
$ Examples/run.sh -- DecorateOutputExample
```
---
## 🛠 Development
- Use Xcode (≥15.4).
- Clone the repository or create a fork & clone it.
- Open `SwiftShell.xcworkspace` in Xcode.
- Use the `SwiftShell` scheme for building and testing the library.
- Use other schemes to build or test examples.
- If you want to contribute, create a pull request containing your changes or bug fixes. Make sure to include tests for new/updated code.
## ☕️ Do you like the project?
I would love to hear if you like my work. I can help you apply any of the solutions used in this repository in your app too! Feel free to reach out to me, or if you just want to say "thanks", you can buy me a coffee.
## 📄 License
Copyright © 2024 Dariusz Rybicki Darrarski
License: [MIT](LICENSE)