{"_id":"@buildingwithai/soundfx","_rev":"5-72e0c4366752cbe1fe5d284bf8072bb3","name":"@buildingwithai/soundfx","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.0":{"name":"@buildingwithai/soundfx","version":"0.1.0","keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"author":{"name":"buildingwithai"},"license":"MIT","_id":"@buildingwithai/soundfx@0.1.0","maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"homepage":"https://github.com/buildingwithai/soundfx","bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"bin":{"soundfx":"src/core/cli.js"},"dist":{"shasum":"7df73fa7cfa0212c9aa9d68b666a33f168e2cf97","tarball":"https://registry.npmjs.org/@buildingwithai/soundfx/-/soundfx-0.1.0.tgz","fileCount":10,"integrity":"sha512-jP4piTU6JUWm3wIcOf6yPaOxFCrNMHXY2u2PPwcIwBXetHU2h6QdxaGleLlTrJch03wO+Lf6uPXRhVBwnc9FLg==","signatures":[{"sig":"MEYCIQCiIwdLBGZxrp3I/5xp2NqpL385XbBRNEgYCqjqkeutrQIhAMoM4wo7Z4tzo1nPDTmPtb7jMmqxzsKTAakQO6hW6nel","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":53440},"type":"module","engines":{"node":">=20"},"gitHead":"7c6171b79f8637588f7bcbf3255022ce8adf8ef9","scripts":{"doctor":"node ./src/core/cli.js doctor","events":"node ./src/core/cli.js events","sounds":"node ./src/core/cli.js sounds","test:tui":"node ./src/core/cli.js tui --test"},"_npmUser":{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"},"repository":{"url":"git+https://github.com/buildingwithai/soundfx.git","type":"git"},"_npmVersion":"10.9.7","description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","directories":{},"_nodeVersion":"22.22.2","dependencies":{"ink":"^7.0.1","react":"^19.0.0","ffmpeg-static":"^5.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/soundfx_0.1.0_1776618174056_0.6037076684653178","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@buildingwithai/soundfx","version":"0.1.1","keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"author":{"name":"buildingwithai"},"license":"MIT","_id":"@buildingwithai/soundfx@0.1.1","maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"homepage":"https://github.com/buildingwithai/soundfx","bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"bin":{"soundfx":"src/core/cli.js"},"dist":{"shasum":"0594038bbd43c62ec944dd4aa13cfeb4ba83a77f","tarball":"https://registry.npmjs.org/@buildingwithai/soundfx/-/soundfx-0.1.1.tgz","fileCount":10,"integrity":"sha512-BXK7UKBeTiWSUgBVtTcrFW13QPBfDhU4v2wvduXNVQnoSJtLBzRZXa+CwUn5x0S888aeAtmT0ZSnTpdbsyiRWQ==","signatures":[{"sig":"MEUCICoC76pPGGEIjHvAQrqt/w2x0j9lIin0Y4r25qGP7xFHAiEA8icfuhA7JDlO1GJTN01Cdd3j1LE8Dj8N9iBX7Iw+0kE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":60842},"type":"module","engines":{"node":">=20"},"gitHead":"e4aef3a89de86cc346e79fd85011464500487bf4","scripts":{"doctor":"node ./src/core/cli.js doctor","events":"node ./src/core/cli.js events","sounds":"node ./src/core/cli.js sounds","test:tui":"node ./src/core/cli.js tui --test"},"_npmUser":{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"},"repository":{"url":"git+https://github.com/buildingwithai/soundfx.git","type":"git"},"_npmVersion":"10.9.7","description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","directories":{},"_nodeVersion":"22.22.2","dependencies":{"ink":"^7.0.1","react":"^19.0.0","ffmpeg-static":"^5.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/soundfx_0.1.1_1776623034314_0.6326023662586666","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@buildingwithai/soundfx","version":"0.1.2","keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"author":{"name":"buildingwithai"},"license":"MIT","_id":"@buildingwithai/soundfx@0.1.2","maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"homepage":"https://github.com/buildingwithai/soundfx","bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"bin":{"soundfx":"src/core/cli.js"},"dist":{"shasum":"11f614ff02bb123aa247a2fba8341c936b84170f","tarball":"https://registry.npmjs.org/@buildingwithai/soundfx/-/soundfx-0.1.2.tgz","fileCount":10,"integrity":"sha512-7K1FAPh0qLu2qid+DMmFgdXzsDlyh8Gz8L9SLs9Mo3JFQ0amcAlPT4sxIDubiO8VODiXAVJ1vDBBcFvw4/oyWg==","signatures":[{"sig":"MEUCIQC9rC7PIEd7mPLvIHuBzn31XGf+5fC47d7wZX6e9Cs48gIgPQlLJDOUKxkQGRBFXChSLsmt+CHn+GhDwZD3dfcky9Q=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":69462},"type":"module","engines":{"node":">=20"},"gitHead":"62c0e13761e906fbfca951c1fbc0e08f3687e5cd","scripts":{"dev":"node ./website/server.js","doctor":"node ./src/core/cli.js doctor","events":"node ./src/core/cli.js events","sounds":"node ./src/core/cli.js sounds","website":"node ./website/server.js","test:tui":"node ./src/core/cli.js tui --test","build:website":"node ./scripts/build-website.mjs"},"_npmUser":{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"},"repository":{"url":"git+https://github.com/buildingwithai/soundfx.git","type":"git"},"_npmVersion":"10.9.7","description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","directories":{},"_nodeVersion":"22.22.2","dependencies":{"ink":"^7.0.1","react":"^19.0.0","ffmpeg-static":"^5.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/soundfx_0.1.2_1776745051811_0.9052177060927205","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@buildingwithai/soundfx","version":"0.1.3","keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"author":{"name":"buildingwithai"},"license":"MIT","_id":"@buildingwithai/soundfx@0.1.3","maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"homepage":"https://github.com/buildingwithai/soundfx","bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"bin":{"soundfx":"src/core/cli.js"},"dist":{"shasum":"54db8b85065c276d66c4a519ac8e30c69dfe2397","tarball":"https://registry.npmjs.org/@buildingwithai/soundfx/-/soundfx-0.1.3.tgz","fileCount":10,"integrity":"sha512-srqyyXdWQCKBsdXNg0RdXF5XkZsk7Ucs2DPCAwwPSna9PimNrn611hOM7kpT2xmSHys+YJSTLDlGSjhSqCgpng==","signatures":[{"sig":"MEQCICYfIvnTtSLUKF6bm41QhMdG3NTkLf51njiFXSA7hlbeAiBck2ujz27BYOtIPytULOetdNstRfetzF8DVbpGeLVfyw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":79681},"type":"module","engines":{"node":">=20"},"gitHead":"5c10e451f4e66aab4dce7e6a8953fd083fec6355","scripts":{"dev":"node ./website/server.js","doctor":"node ./src/core/cli.js doctor","events":"node ./src/core/cli.js events","sounds":"node ./src/core/cli.js sounds","website":"node ./website/server.js","test:tui":"node ./src/core/cli.js tui --test","build:website":"node ./scripts/build-website.mjs"},"_npmUser":{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"},"repository":{"url":"git+https://github.com/buildingwithai/soundfx.git","type":"git"},"_npmVersion":"10.9.7","description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","directories":{},"_nodeVersion":"22.22.2","dependencies":{"ink":"^7.0.1","react":"^19.0.0","ffmpeg-static":"^5.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/soundfx_0.1.3_1776755324985_0.1075767394930538","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@buildingwithai/soundfx","version":"0.1.4","description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","type":"module","bin":{"soundfx":"src/core/cli.js"},"scripts":{"dev":"node ./website/server.js","build:website":"node ./scripts/build-website.mjs","test":"node ./scripts/test-bug-fixes.mjs","test:bugs":"node ./scripts/test-bug-fixes.mjs","test:tui":"node ./src/core/cli.js tui --test","events":"node ./src/core/cli.js events","sounds":"node ./src/core/cli.js sounds","doctor":"node ./src/core/cli.js doctor","website":"node ./website/server.js"},"keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"author":{"name":"buildingwithai"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/buildingwithai/soundfx.git"},"homepage":"https://github.com/buildingwithai/soundfx","bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"engines":{"node":">=20"},"dependencies":{"ffmpeg-static":"^5.3.0","ink":"^7.0.1","react":"^19.0.0"},"publishConfig":{"access":"public"},"_id":"@buildingwithai/soundfx@0.1.4","gitHead":"2170481dfe83a140749b9d49c33f0d29c1a9c726","_nodeVersion":"22.22.2","_npmVersion":"10.9.7","dist":{"integrity":"sha512-g2mhob28Y0zbgDGCbCR46rFQqrJznJl/HFXdVJKs+mjU6VA93M+YaK3MJzWLUczNrQISoFMRCr7wMOD5fggE+A==","shasum":"9fd0111c01f4db6aff738a48aca9e3d29fa133a8","tarball":"https://registry.npmjs.org/@buildingwithai/soundfx/-/soundfx-0.1.4.tgz","fileCount":10,"unpackedSize":92937,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDQVLZ6hUlxuOjSHOhNpIiBaOQ7qnKwKOASRrW8GSCcJgIgWHfLyd0XkMu8+0W8EmPxFlfJo+HV8l3EzjzIkVfqVZs="}]},"_npmUser":{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"},"directories":{},"maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/soundfx_0.1.4_1776771673006_0.6427421383343057"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-19T17:02:53.960Z","modified":"2026-04-21T11:41:13.282Z","0.1.0":"2026-04-19T17:02:54.267Z","0.1.1":"2026-04-19T18:23:54.542Z","0.1.2":"2026-04-21T04:17:31.971Z","0.1.3":"2026-04-21T07:08:45.123Z","0.1.4":"2026-04-21T11:41:13.140Z"},"bugs":{"url":"https://github.com/buildingwithai/soundfx/issues"},"author":{"name":"buildingwithai"},"license":"MIT","homepage":"https://github.com/buildingwithai/soundfx","keywords":["cli","terminal","soundboard","powershell","bash","zsh","audio","hooks"],"repository":{"type":"git","url":"git+https://github.com/buildingwithai/soundfx.git"},"description":"Cross-platform terminal sound effects, shell hooks, and TUI configuration.","maintainers":[{"name":"tovar.jovanny","email":"jovannytovar@gmail.com"}],"readme":"# soundfx\n\nThis package contains only the terminal product:\n\n- shell hooks for `powershell`, `pwsh`, `bash`, and `zsh`\n- terminal-event to sound-effect mapping\n- a text UI for choosing event sounds\n- cross-platform audio playback adapters for Windows, macOS, and Linux\n\nThis package does **not** include:\n\n- the Electron desktop app\n- OBS desktop UI features\n- desktop packaging assets\n\n## Commands\n\n```bash\nsoundfx tui\nsoundfx doctor\nsoundfx uninstall <shell>\nsoundfx events\nsoundfx sounds\nsoundfx assign <eventId> <soundId>\nsoundfx test-event <eventId>\nsoundfx test-sound <soundId>\nsoundfx install-hook <shell>\nsoundfx uninstall-hook <shell>\nsoundfx hook-status <shell>\n```\n\n## Quick start\n\n```bash\nnpm install -g @buildingwithai/soundfx\nsoundfx\n```\n\nOn first launch, `soundfx` opens the terminal UI and, if needed, automatically connects itself to your shell profile so command-triggered sounds can work later.\n\nAfter that first launch, restart your terminal once. That is the one step the app cannot fully do for you, because your current shell session is already running.\n\nThen, if you want, you can quickly confirm audio with:\n\n```bash\nsoundfx test-sound default-1\n```\n\nBehind the scenes, soundfx still needs one small shell hook so it knows when commands succeed, fail, or are unknown. On first launch, the app installs that hook for you automatically.\n\nInside the TUI:\n\n- type to filter sounds with smart search\n- press `Ctrl+F` to add or remove a favorite\n- recently previewed or assigned sounds float toward the top\n- press `Esc` to clear the current filter\n- press `Space` to play or stop the selected preview\n\n## Uninstall\n\nIf you want to stop soundfx from hooking into your terminal:\n\n```bash\nsoundfx uninstall zsh\n```\n\nThen, if you also want to remove the package itself:\n\n```bash\nnpm uninstall -g @buildingwithai/soundfx\n```\n\n## Event meanings\n\n- `unknown_command`: you typed something your shell does not recognize\n- `command_success`: a command finished normally\n- `command_error`: a real command ran, but it finished with a failure\n- `command_interrupted`: you stopped a running command with `Ctrl+C`\n- `sudo_used`: the command started with `sudo`\n- `git_commit`: you ran `git commit`\n- `npm_install`: you ran an install command like `npm install`\n\n`unknown_command` and `command_error` are not the same thing.\n\n- `unknown_command` means the shell could not even find a command to run\n- `command_error` means the command did exist and started, but it ended badly\n\nExample:\n\n- `h` -> `unknown_command`\n- `cat missing-file.txt` -> `command_error`\n\n## Local development\n\nIf you cloned this repo and want to run the CLI locally on your machine:\n\n```bash\nnpm install\nnpm link\nsoundfx\n```\n\nIf you use `bash`, replace `zsh` with `bash`.\n\n## macOS notes\n\n- macOS playback uses the built-in `afplay` command.\n- In normal cases, macOS does not need a special privacy or security permission for this app to play sounds through your speakers.\n- On first launch, `soundfx` can update your shell profile automatically. After that, open a new terminal or run `exec zsh` once so the hook is actually loaded.\n- If `test-sound` works but command sounds do not, run `soundfx hook-status zsh` to confirm the hook is installed in the shell you are really using.\n- If your Mac is using the wrong audio output device, or the volume is muted, soundfx cannot override that. It will send audio to the same output your Mac is already using.\n- If you still do not hear audio, test your Mac audio path directly with:\n\n```bash\nafplay /System/Library/Sounds/Glass.aiff\n```\n\n## Shells\n\n- Windows PowerShell: `powershell`\n- PowerShell 7+: `pwsh`\n- macOS / Linux: `bash`, `zsh`\n\n## Platform layout\n\n- `src/core/`\n- `src/platform/windows/`\n- `src/platform/macos/`\n- `src/platform/linux/`\n","readmeFilename":"README.md"}