---
title: maniramezan/swiftyshell
framework: Swift Package Catalog
role: article
path: packages/maniramezan/swiftyshell
---

# maniramezan/swiftyshell

**Swift-typed shell support.** SwiftyShell models commands, arguments, pipelines, and workflows as Swift values. Use typed wrappers for supported tools, or `Command` for any executable.

## Start here

- [Getting started](Guides/GETTING_STARTED.md) — add the package and run a command - [Supported commands](Guides/SUPPORTED_COMMANDS.md) — wrappers, traits, and escape hatch - [Execution behavior](Guides/EXECUTION.md) — pipelines, output, timeouts, and spawned processes - [Development](Guides/DEVELOPMENT.md) — validation, Linux helpers, and contribution links - [DocC documentation](https://maniramezan.github.io/SwiftyShell/documentation/swiftyshell/) — tutorials, family guides, and full API reference

## Why SwiftyShell?

- Commands keep executable names, argv entries, environment, and output routing explicit. - Typed wrappers provide discoverable options and structured results where available. - `Workflow` composes asynchronous operations with gates such as “continue only if the working tree is clean.” - `MockExecutor` lets you test command construction without launching processes.

SwiftyShell is not a security boundary. Validate values according to the invoked tool, especially interpreter input, raw options, executable overrides, environment values, and writable paths.

## License

SwiftyShell is available under the MIT license. See [LICENSE](LICENSE) for details.

## Build output for automation

Use `.stdout(.teeTo(.stderr))` when a CLI writes JSON to stdout. Captured output retains its original stdout/stderr identity even when both live streams go to stderr.

For long builds, write complete logs while retaining bounded diagnostic tails:

```swift let output = try await Command("./gradlew", arguments: "assembleRelease")     .stdout(.log(path: "build.stdout.log", append: false, tailBytes: 65_536, tee: .stderr))     .stderr(.log(path: "build.stderr.log", append: false, tailBytes: 65_536, tee: .stderr))     .run() ```

Filling a tail does not terminate the build. The command's shared hard output limit still applies to retained bytes. See the `OutputDestination` DocC page for pipeline, spawn, and mock behavior.

The upcoming 0.7.0 release requires Swift 6.2 or later, supports macOS 15 or later and Linux, and uses swift-subprocess 1.0. Select a compatible toolchain in local development and CI before updating. Typed command families remain opt-in through package traits; core execution requires no traits.

## Package Metadata

Repository: maniramezan/swiftyshell

Default branch: main

README: README.md