Beam Make it yours
Commands, quicklinks and scripts
Turn anything you do twice into a keyword or hotkey.
Command kinds
| Kind | Does |
|---|---|
| Open URL (quicklink) | Opens a web address. Use {query} where your typing goes. |
| Run Shell Command | Runs a shell command. {query} is inserted single-quoted. |
| Open Apps & Files | Opens a set of apps and files. |
Each has a keyword and an optional hotkey. In URLs, {query} is percent-encoded. Example: https://github.com/search?q={query}.
Every command can also be run from outside Beam with a deep link: beam://command/<id>.
Beam seeds eight quicklinks: g, gh, yt, w, maps, tr, gpt, r.
Output of shell commands
Choose one: show result briefly (HUD), run silently, show output in Beam, copy output, or paste output.
Gallery
46 ready-made commands in seven groups: Search the Web, Developer, System, Network & Info, Text, Open, Downloaders. Examples: Kill Process on Port, Clear Xcode DerivedData, Generate UUID, Format JSON in Clipboard, Flush DNS, Keep Awake 1h, Toggle Wi-Fi, Toggle Hidden Files, Restart Dock, Restart Finder, Copy Public IP, Copy Local IP, Speed Test, Battery Status, Disk Space, UPPERCASE and lowercase Clipboard, Random Password, Word Count. Downloaders drive yt-dlp, which you install yourself.
Script commands
Put scripts in ~/.config/beam/scripts (add more folders in settings). Beam reads headers in both @raycast.* and @beam.* form, after a comment prefix of #, //, -- or ;.
| Header | Meaning |
|---|---|
| title | Name. |
| mode | silent, compact, fullOutput or inline. Inline scripts with no arguments run when Beam loads and show the first line of output as the result's subtitle. |
| refreshTime | For inline scripts: how often to re-run, such as 10s, 5m, 1h or 1d. Anything under 10 seconds is raised to 10. |
| schemaVersion, packageName, icon, iconDark, description, author | Metadata. |
| currentDirectoryPath | Working directory. |
| needsConfirmation | Ask before running. |
| argument1 to argument3 | Up to three, text, password or dropdown, optional or percent encoded. |
#!/bin/bash
# @beam.title Say Hello
# @beam.mode compact
# @beam.argument1 { "type": "text", "placeholder": "Name" }
echo "Hello, $1"Reload Scripts picks up changes and Edit Script opens one. Scripts run directly or through an interpreter, with an extended PATH.