Question 1

How do I add dependencies to a Beak script?

Accepted Answer

Add a comment at the top of your Swift file like '// beak: user/repo @ version'. For example, '// beak: kylef/PathKit @ 1.0.0' imports PathKit. Use 'beak edit' to generate an Xcode project with code completion for these dependencies.

Question 2

Can Beak run on Linux or without Xcode?

Accepted Answer

Yes, Beak supports Linux for basic CLI generation and execution, but features like 'beak edit' for Xcode integration won't work. You'll need the Swift toolchain installed, but Xcode is optional for core functionality.

Question 3

Beak vs swift sh: which is better for Swift scripting?

Accepted Answer

Beak is ideal for structured task automation with automatic CLI generation from functions, while swift sh focuses on general-purpose scripting with inline dependency management. Choose Beak for make-like files, swift sh for ad-hoc scripts.

Question 4

How to make a Beak script executable with a shebang?

Accepted Answer

Add '#!/usr/bin/env beak --path' or '#!/usr/bin/env beak run --path' at the top of your Swift file, then run 'chmod a+x filename.swift'. This allows direct execution like './filename.swift run function', as shown in the README example.

Question 5

Does Beak support async functions or advanced error handling?

Accepted Answer

The README only mentions synchronous throwing functions; async support isn't documented. Errors are handled via CustomStringConvertible for thrown exceptions, but complex error types might require additional workarounds.

Question 6

What happens if I have non-public functions in my Beak script?

Accepted Answer

Non-public functions are ignored by Beak and can be used as helper functions. Only public global functions are discovered and exposed in the CLI, as specified in the Functions section of the README.

Beak

What is Beak?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Open Source Alternative To

Frequently Asked Questions