Add OpenWhispr easy setup installer and companion files

Single-file bash installer (setup-openwhispr.sh) with distro detection,
dependency installation, STT/AI cleanup provider selection, API key
management, and first-run launch. Includes README, LICENSE (MIT),
CHANGELOG, .gitignore, ShellCheck CI, issue templates, PR template,
and GitHub setup guide.

https://claude.ai/code/session_01XKYC1basxdwtHy71tky7xm
This commit is contained in:
Claude
2026-03-25 12:57:53 +00:00
parent abf5062779
commit da73b43b1d
10 changed files with 996 additions and 0 deletions
+40
View File
@@ -0,0 +1,40 @@
---
name: Bug report
about: Report a problem with the installer
title: "[Bug] "
labels: bug
assignees: ""
---
## Describe the bug
A clear and concise description of what went wrong.
## Steps to reproduce
1. Run `bash setup-openwhispr.sh`
2. Choose option ...
3. See error ...
## Expected behaviour
What you expected to happen.
## Environment
- **Distro**: (e.g., Ubuntu 24.04)
- **Architecture**: (e.g., x86_64 / aarch64)
- **Session type**: (X11 / Wayland)
- **Desktop**: (GNOME / KDE / other)
- **OpenWhispr version**: (if already installed)
- **Script version**: (run `head -5 setup-openwhispr.sh`)
## Terminal output
```
Paste relevant output here
```
## Additional context
Anything else that might help.
+33
View File
@@ -0,0 +1,33 @@
---
name: Distro compatibility report
about: Report whether the installer works on your distro
title: "[Distro] "
labels: distro-report
assignees: ""
---
## Distribution details
- **Distro**: (e.g., Pop!_OS 24.04)
- **Based on**: (e.g., Ubuntu / Debian / Arch / independent)
- **Architecture**: (x86_64 / aarch64)
- **Session type**: (X11 / Wayland)
- **Desktop environment**: (GNOME / KDE / Sway / other)
## Result
- [ ] Script detected distro correctly
- [ ] OpenWhispr installed successfully
- [ ] Paste dependencies installed correctly
- [ ] API keys stored correctly
- [ ] OpenWhispr launched after install
## Notes
Any issues, workarounds, or suggestions for this distro.
## Terminal output
```
Paste full script output here
```
+19
View File
@@ -0,0 +1,19 @@
## What does this PR do?
Brief description of the change.
## Checklist
- [ ] `bash -n setup-openwhispr.sh` passes (no syntax errors)
- [ ] ShellCheck passes with no new warnings
- [ ] Tested on at least one supported distro
- [ ] Updated CHANGELOG.md if user-facing
- [ ] No hardcoded paths or usernames (uses YOUR_USERNAME placeholder or is generic)
## Testing
Describe how you tested this change.
## Related issues
Closes #
+23
View File
@@ -0,0 +1,23 @@
name: ShellCheck
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
jobs:
shellcheck:
name: ShellCheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install ShellCheck
run: sudo apt-get install -y shellcheck
- name: Run ShellCheck
run: shellcheck -x setup-openwhispr.sh