setup
Sets up a Mac or Windows PC for ButterCut. Installs all required dependencies (Homebrew on a Mac, Ruby, Python, FFmpeg, WhisperX). Use when user says "install buttercut", "set up my mac", "set up my pc", "get started", "first time setup", "install dependencies" or "check my installation".
How do I install this agent skill?
npx skills add https://github.com/barefootford/buttercut --skill setupIs this agent skill safe to install?
- Gen Agent Trust Hubwarn
This skill automates the installation of development dependencies on macOS. It modifies multiple system shell profiles to ensure environment persistent availability and includes troubleshooting steps requiring administrative privileges (sudo). It also facilitates the installation of Homebrew via a remote script and generates local wrapper scripts.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
4/4 files flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Skill: Setup
Sets up a Mac or Windows PC for ButterCut. On a Mac, two installation paths are available based on user preference.
Step 0: Which platform is this?
uname -s
Darwin→ macOS. Continue with Step 1 below.MINGW…/MSYS…/CYGWIN…→ Windows (Git Bash). Read and followskills/setup/windows-setup.md— it has its own check-current-state flow — then come back for Step 5 (the error-reporting question).unamenot found at all → almost certainly PowerShell on Windows without Git for Windows; that's the first thingwindows-setup.mdinstalls.
Step 1: Check Current State
(macOS path — Windows machines went through windows-setup.md in Step 0.) Run each check below. Each command exits 0 when the dependency is present. Note which ones fail — that's what setup needs to install.
- Xcode CLI Tools —
xcode-select -p(fix:xcode-select --install) - Homebrew —
which brew(fix: see https://brew.sh) - Ruby 3.3.x —
ruby --version | grep -q 'ruby 3\.3'(fix: install Ruby 3.3.6, see.ruby-version) - Bundler —
which bundle(fix:gem install bundler) - Python 3.12.x —
python3 --version | grep -q 'Python 3\.12'(fix: install Python 3.12.8, see.python-version) - FFmpeg —
which ffmpeg(fix: see FFmpeg install in the setup file below — must be thehomebrew-ffmpeg/ffmpegtap build) - FFmpeg drawtext filter —
ffmpeg -hide_banner -filters 2>/dev/null | grep -q ' drawtext '(fix: the stockbrew install ffmpegformula often omits drawtext; replace it with thehomebrew-ffmpeg/ffmpegtap build — see setup file) - WhisperX —
which whisperx || test -x ~/.buttercut/whisperx || test -x ~/.buttercut/venv/bin/whisperx(fix: see setup steps below) - Gems installed —
bundle check(fix:bundle installin buttercut directory)
If everything passes, tell the user they're ready to go and stop.
Step 2: Ask User Preference
If dependencies are missing, use AskUserQuestion:
Question: "How would you like to install ButterCut?"
Header: "Install type"
Options:
1. "Simple (recommended)" - "Fully automatic setup. We'll install everything for you using sensible defaults."
2. "Advanced" - "For developers who want control. You manage Ruby/Python versions with your preferred tools."
Step 3: Run Appropriate Setup
Based on user choice:
- Simple: Read and follow
skills/setup/simple-setup.md - Advanced: Read and follow
skills/setup/advanced-setup.md
Step 4: Verify Installation
After setup completes, re-run the checklist from Step 1 and report results to the user.
Step 5: Ask About Error Reports
Only if ruby lib/buttercut/report.rb consent prints error_reporting=unset — otherwise this user has already answered, so leave it alone.
Ask the two questions in skills/report-bug/SKILL.md (step 2), worded for a fresh install rather than a crash: "ButterCut sometimes hits errors. Want me to send those to the team so they can fix them?" Save the answers by setting error_reporting: and error_report_email: in libraries/settings.yaml.
Keep it to those two questions and move on — it's the last thing standing between them and their first cut.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/barefootford/buttercut/setup">View setup on skillZs</a>