Swift utilities for running commands.

Phil

Last update: Jan 2, 2023

Related tags

Command Line macos swift swift-package-manager commands spm subprocess

Overview

Swift Commands

Swift utilities for running commands.

The Commands module allows you to take a system command as a string and return the standard output.

API documentation can be found here.

Usage

import Commands

Bash

Execute shell commands.

let result = Commands.Task.run("bash -c ls")

let result = Commands.Task.run(["bash", "-c", "ls"])

let result = Commands.Bash.run("ls")

Python

Execute python scripts.

let result = Commands.Task.run("python main.py")

Execute python commands.

let result = Commands.Task.run("python -c import base64; print(base64.b64encode('qiuzhifei').decode('ascii'))")

let result = Commands.Python.run("import base64; print(base64.b64encode('qiuzhifei').decode('ascii'))")

Ruby

Execute ruby scripts.

let result = Commands.Task.run("ruby main.rb")

Execute ruby commands.

let result = Commands.Task.run("ruby -e require 'base64'; puts Base64.encode64('qiuzhifei')")

let result = Commands.Ruby.run("require 'base64'; puts Base64.encode64('qiuzhifei')")

Alias

Create a shortcut name for a command.

let node = Commands.Alias("/usr/local/bin/node", dashc: "-e")
let result = node.run("console.log('qiuzhifei')")

Setting global environment variables

Commands.ENV.global["http_proxy"] = "http://127.0.0.1:7890"

Commands.ENV.global.add(PATH: "/Users/zhifeiqiu/.rvm/bin")

Making Commands

let request: Commands.Request = "ruby -v"

let request: Commands.Request = ["ruby", "-v"]

let request = Commands.Request(executableURL: "ruby", arguments: "-v")

Change environment variables

var request: Commands.Request = "ruby -v"
request.environment?.add(PATH: "/usr/local/bin")
request.environment?["http_proxy"] = "http://127.0.0.1:7890"
request.environment?["https_proxy"] = "http://127.0.0.1:7890"
request.environment?["all_proxy"] = "socks5://127.0.0.1:7890"

let result = Commands.Task.run(request)

Result Handler

Returns the Commands.Result of running cmd in a subprocess.

let result = Commands.Task.run("ruby -v")
switch result {
case .Success(let request, let response):
  debugPrint("command: \(request.absoluteCommand), success output: \(response.output)")
case .Failure(let request, let response):
  debugPrint("command: \(request.absoluteCommand), failure output: \(response.errorOutput)")
}

Adding Commands as a Dependency

To use the Commands library in a SwiftPM project, add the following line to the dependencies in your Package.swift file:

let package = Package(
    // name, platforms, products, etc.
    dependencies: [
        .package(url: "https://github.com/qiuzhifei/swift-commands", from: "0.6.0"),
        // other dependencies
    ],
    targets: [
        .target(name: "<command-line-tool>", dependencies: [
            .product(name: "Commands", package: "swift-commands"),
        ]),
        // other targets
    ]
)

CocoaPods (OS X 10.9+)

You can use CocoaPods to install Commands by adding it to your Podfile:

pod 'Commands',        '~> 0.6.0'

QuickStart

git clone https://github.com/QiuZhiFei/swift-commands
cd swift-commands && open Package.swift

References

https://github.com/apple/swift-argument-parser

Comments

多个命令怎么组合？

Commands.Task.run("cd \(path)")
let result = Commands.Task.run("pod install")
switch result {
    case .Success( let request, let response):    
            print( "command: \(request.absoluteCommand), Success output: \(response.errorOutput)")
    case .Failure(let request, let response):
             print( "command: \(request.absoluteCommand), failure output: \(response.errorOutput)")
}

报错：command: pod install, failure output: The file “pod” doesn’t exist. 似乎是cd的操作独立于pod install导致的，请问这个要怎么处理？

opened by vitasapple 4

java可以么？

好像拿不到结果

 let result = Commands.Task.run("java -version")
            switch result {
            case .Success(let request, let response):
              debugPrint("command: \(request.absoluteCommand), success output: \(response.output)")
            case .Failure(let request, let response):
              debugPrint("command: \(request.absoluteCommand), failure output: \(response.errorOutput)")
            }

opened by qingweiSun 3

Process() not in scope issue

Hi @QiuZhiFei , I was trying to use this package so that I can run some command line stuff via swift to capture logs from an iPhone. But seems like there is an issue wherein it cannot find Process() in scope

Note: Swift Language Version is set to 5 in Build settings.

Am I missing something here in terms of the usage? Any help would be appreciated. Thanks

opened by gkvappium 1
mac应用执行pod相关命令报错
下面是我的测试代码，我用rvm管理的ruby版本

import Foundation import Commands Commands.ENV.global.add(PATH: "/Users/jensen/.rvm/gems/ruby-2.7.0/bin") var result = Commands.Task.run(["pod", "--version"]) print("\(result.statusCode)") print("\(result.output)") print("\(result.errorOutput)")

在命令行应用中可以正常执行，在我新建的mac app中报The file “pod” doesn’t exist.

帮忙看一下这是因为什么，感谢！
opened by Zhangyanshen 1

Cannot run command from /usr/local/bin

When you install mysql with homebrew you have access to mysql.server command, start, stop ...

but I cannot call it.

default installation is /usr/local/bin/mysql.server

   let request = Commands.Request("mysql.server start")
                //debugPrint(request)
                request.environment?.add(PATH: "${PATH}:/usr/local/bin")
                 
                let result = Commands.Task.run(request)

//"command: mysql.server start, failure output: The file “mysql.server” doesn’t exist."

with Commands.Bash..run(request) same.

opened by flakerimi 1

Releases(0.6.0)

0.6.0(Sep 13, 2021)

Source code(tar.gz)
Source code(zip)
0.5.0(Aug 31, 2021)

Source code(tar.gz)
Source code(zip)
0.4.0(Aug 30, 2021)

Source code(tar.gz)
Source code(zip)
0.3.0(Aug 25, 2021)

Source code(tar.gz)
Source code(zip)
0.2.0(Aug 4, 2021)

Source code(tar.gz)
Source code(zip)
0.1.0(Aug 3, 2021)

Source code(tar.gz)
Source code(zip)

Owner

Phil

GitHub

This app is a sample app that recognizes specific voice commands such as "make it red", "make it blue", "make it green", and "make it black" and change the background color of the view in the frame.

VoiceOperationSample This app is a sample app that recognizes specific voice commands such as "make it red", "make it blue", "make it green", and "mak