Files
SwiftShell/README.md
T
Kare Morstol a7a68866a1 Use $SWIFTSHELL_FRAMEWORK_PATH instead of $DYLD_FRAMEWORK_PATH in the swiftshell launcher script.
Because of this change in El Capitan:

	"Spawning children processes of processes restricted by System Integrity Protection, such as by launching a helper process in a bundle with NSTask or calling the exec(2) command, resets the Mach special ports of that child process. Any dynamic linker (dyld) environment variables, such as DYLD_LIBRARY_PATH, are purged when launching protected processes."

https://developer.apple.com/library/prerelease/mac/documentation/Security/Conceptual/System_Integrity_Protection_Guide/RuntimeProtections/RuntimeProtections.html
2015-11-09 22:07:23 +01:00

125 lines
3.3 KiB
Markdown

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
_Works with **Swift 2.0** (Xcode 7). Use [v0.2](https://github.com/kareman/SwiftShell/tree/v0.2) for Swift 1.2._
_For the future of SwiftShell, check out [SwiftShell 2.0](https://github.com/kareman/SwiftShell/tree/SwiftShell2) (work in progress)._
# SwiftShell
An OS X Framework for command line scripting in Swift. It supports joining together shell commands and Swift functions, like the pipe in shell commands and the pipe forward operator from functional programming.
## Usage
Put this at the beginning of each script file:
```swift
#!/usr/bin/env swiftshell
import SwiftShell
```
#### Commands
Shell commands return readable streams, which can be read all at once with "read()" or read lazily (as in piece by piece) with "readSome()". The latter is useful for long texts.
```swift
let result = run("some shell command").read()
```
Commands can be piped together:
```swift
run("echo piped to the next command") |> run("wc -w") |>> standardoutput
```
Use any sequence as parameters for a command:
```swift
run( "chmod +x" + parameters(files) )
```
For in-line commands, use `$("command")`:
```swift
print( "The time and date is " + $("date -u") )
```
#### Files
Files are streams too. They can be read line by line:
```swift
for line in open("file1.txt").lines() {
// Do something with each line
}
```
Or written to:
```swift
let file2 = open(forWriting: tempdirectory / "newfile.txt" )
run("echo line 1") |>> file2
file2.writeln("line 2")
```
And there's easy access to NSFileManager:
```swift
if File.fileExistsAtPath("fileiwant.txt") {...}
if File.isExecutableFileAtPath("program") {...}
...
```
#### Standard input
is also a stream:
```swift
var i = 1
for line in standardinput.lines() {
print("line \(i++): ", appendNewline: false)
print(line)
}
```
or
```swift
var i = 1
standardinput.lines() |> map {line in "line \(i++): \(line)\n"} |>> standardoutput
```
Launch with e.g. `ls | print_linenumbers.swift`
## Examples
- [trash.swift](https://gist.github.com/kareman/322c1091f3cc7e1078af): moves files and folders to the trash.
- [listallexecutablesinpath.swift](https://gist.github.com/kareman/d157c46858f91f1a22a7): lists all executables currently available in PATH.
## Documentation
- [generated from code](http://kareman.github.io/SwiftShell)
## Installation
- In the Terminal, go to where you want to download SwiftShell.
- Run
git clone https://github.com/kareman/SwiftShell.git
cd SwiftShell
- Copy/link `Misc/swiftshell` to your bin folder or anywhere in your PATH.
- To install the framework itself, either:
- run `xcodebuild install` from the project's root folder. This will install the SwiftShell framework in ~/Library/Frameworks.
- _or_ run `xcodebuild` and copy the resulting framework from the build folder to your library folder of choice. If that is not "~/Library/Frameworks", "/Library/Frameworks" or a folder mentioned in the $SWIFTSHELL_FRAMEWORK_PATH environment variable then you need to add your folder to $SWIFTSHELL_FRAMEWORK_PATH.
## License
Released under the MIT License (MIT), http://opensource.org/licenses/MIT
Some files are covered by other licences, see [included works](Misc/Included%20Works).
Kåre Morstøl, [NotTooBad Software](http://nottoobadsoftware.com)