https://github.com/eneko/processrunner

Execute child processes and system commands from Swift
https://github.com/eneko/processrunner

child-process cli command package process shell swift swiftpm system

Last synced: 20 days ago
JSON representation

Execute child processes and system commands from Swift

• Host: GitHub
• URL: https://github.com/eneko/processrunner
• Owner: eneko
• License: mit
• Created: 2018-08-28T05:24:41.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2021-01-17T17:13:05.000Z (almost 4 years ago)
• Last Synced: 2024-09-16T16:18:49.072Z (2 months ago)
• Topics: child-process, cli, command, package, process, shell, swift, swiftpm, system
• Language: Swift
• Homepage:
• Size: 265 KB
• Stars: 18
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# ProcessRunner

![ProcessRunner](/processrunner.png)

![Release](https://img.shields.io/github/release/eneko/System.svg)

![Swift 5.0](https://img.shields.io/badge/Swift-5.0-orange.svg)

[![Build Status](https://travis-ci.org/eneko/System.svg?branch=master)](https://travis-ci.org/eneko/System)

[![codecov](https://codecov.io/gh/eneko/System/branch/master/graph/badge.svg)](https://codecov.io/gh/eneko/System)

[![codebeat badge](https://codebeat.co/badges/51605ed0-b4dc-498f-9b45-375ef5011659)](https://codebeat.co/projects/github-com-eneko-system-master)

![Linux Compatible](https://img.shields.io/badge/linux-compatible%20🐧-brightgreen.svg)

Easily execute system commands from a Swift script or command line tool.

**Features**

- ✅ Easily execute child processes with arguments 

- ✅ Easily execute shell commands with arguments

- ✅ Capture output or stream to stdout/stderr in real time

- ✅ Swift Package Manager compatible

- ✅ Linux compatible 🐧

## 🚀 Executing child Processes from Swift scripts and CLI tools 

Running child processes in Swift is not hard with `Process`, but it can be a

bit tedious and repetitive.

`System` makes this task extremely easy. If you are familiar with Ruby

scripting (Rakefile, Fastlane, Danger, etc), you will feel like home.

### 💻 Automatically redirect output to stdout 

```swift

import ProcessRunner

try system(command: "echo hello world") // prints "hello world" to stdout

```

### ✇ Capture process output 

```swift

import ProcessRunner

let output = try system(command: "echo hello world", captureOutput: true).standardOutput

print(output) // prints "hello world"

```

### ✔️ Check if process terminated gracefully 

```swift

import ProcessRunner

print(try system(command: "echo hello world").success) // prints "true"

```

### |> Easily execute Shell commands with pipes and redirects

```swift

import ProcessRunner

try system(shell: "echo hello cat > cat && cat cat | awk '{print $2}'") // prints "cat" to stdout

```

## Installation

Add `ProcessRunner` to your `Package.swift`:

```swift

import PackageDescription

let package = Package(

    name: "YourPackage",

    dependencies: [

        .package(url: "[email protected]:eneko/ProcessRunner.git", from: "1.0.0"),

    ],

    targets: [

        .target(

            name: "YourTarget",

            dependencies: ["ProcessRunner"]),

    ]

)

```

## 💌 Contact 

Follow and/or contact me on Twitter at [@eneko](https://www.twitter.com/eneko).

## 👏 Contributions

If you find an issue, just [open a ticket](https://github.com/eneko/System/issues/new)

on it. Pull requests are warmly welcome as well.

## 👮‍♂️ License

System is licensed under the MIT license. See [LICENSE](/LICENSE) for more info.