Get started
Supported systems
What bassclef runs on today. macOS is verified. Linux and WSL 2 likely work but are untested. Windows PowerShell native is not supported — use WSL 2.
Bassclef ships as a bash-first framework. Node 20+ and npm 10+ are required on every system.
| System | process.platform | Status | What that means |
|---|---|---|---|
| macOS 13 or later | darwin | ✅ verified | Every release runs a cold-adopter smoke test on a fresh macOS profile. Latest report: sunj-labs/bassclef-cli#147 (33 pass, 5 fail, 4 tracked defects, 1 expected-absent optional key). |
| Linux (glibc-based) | linux | 🟡 likely, untested | The framework is bash + POSIX tools + npm. Nothing in the code is obviously Linux-hostile. No smoke test has run in a Linux environment yet. First Linux adopter: open an issue. You become the test bed by natural selection. |
| Windows via WSL 2 | linux (WSL 2 runs a Linux kernel) | 🟡 likely, untested | Linux confidence applies. Same ask — first WSL adopter, open an issue. |
| Windows PowerShell native | win32 | 🔴 not supported | Framework hooks are bash scripts. Use WSL 2 instead. |
The @thebassclef/lite npm package pins "os": ["darwin", "linux"] starting with 1.2.0. Windows PowerShell installs fail at npm install with EBADPLATFORM, which is the intended signal.
Known limitations
Cross-system coverage is Phase 1 of sunj-labs/bassclef-cli#151. Post-launch work will:
- Audit framework bash for BSD-vs-GNU coreutils portability (tracked internally as a follow-on)
- Add CI matrix smoke on macOS + Linux runners (Phase 3 of #151)
- Consider Windows PowerShell coverage based on adopter signal (Phase 4 of #151)
Found a system-specific bug?
Open an issue on sunj-labs/bassclef-cli. Name the OS, Node version, and command that failed.