Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ Once setup finishes, type in any ordinary app to hear Klicky. Here's where to fi
| System | Where to look |
|---|---|
| **Windows** | Tray menu: choose a pack, change volume, Pause/Resume, retry audio or choose login startup. |
| **macOS** | Menu bar: toggle sounds. Terminal: choose a pack and set volume. |
| **Linux** | Terminal controls below; supported Omarchy setups also have a bar toggle. |
| **macOS** | Menu bar: choose a pack, change volume, Pause/Resume or choose login startup. Terminal controls are available too. |
| **Linux** | Terminal controls below. [Klicky Bar](docs/OMARCHY.md) adds pack, volume, Pause/Resume and startup controls on Omarchy 4.5+. |

On Linux and macOS, try:

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The daemon receives raw global key-down events, including events generated while
- Normal playback and aggregate benchmark diagnostics do not log key names or reconstruct typed text. Neither executable accesses the microphone.
- Local-only control pipes restrict access to the current logon and validate the server process identity. Shutdown waits retain the actual native process handle.
- Bundle leases protect against cooperating installer/process races; they do not protect a user from other software already running as that same user.
- Windows packages are unsigned. Verify release checksums and keep antivirus protection enabled. Report detections through the guidance above; a version number is not an antivirus determination.
- Standalone Windows EXE/ZIP downloads are unsigned; the Microsoft Store package is signed through Store delivery. Verify release checksums for standalone downloads and keep antivirus protection enabled. Report detections through the guidance above; signing or a version number is not an antivirus determination.

### Network behavior

Expand Down
1 change: 1 addition & 0 deletions packaging/apt/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ <h1>This page wandered off.</h1>
<li><a href="https://dev.to/muneer320/i-wanted-keyboard-sounds-on-linux-then-i-fell-down-the-audio-stack-3b1d">Audio deep dive (DEV)</a></li>
<li><a href="https://alternativeto.net/software/klicky/about/">AlternativeTo</a></li>
<li><a href="https://www.pitchhut.com/project/klicky">PitchHut</a></li>
<li><a href="https://www.saashub.com/klicky">SaaSHub</a></li>
</ul>
</div>
</nav>
Expand Down
32 changes: 20 additions & 12 deletions packaging/apt/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,16 +156,16 @@ <h2>Meet the app.</h2>
<tr>
<td>Linux</td>
<td>Debian/Arch packages; source installer</td>
<td>CLI, systemd; optional Omarchy toggle</td>
<td>CLI, systemd; optional Klicky Bar or older Omarchy toggle</td>
</tr>
<tr>
<td>macOS</td>
<td>Source installer</td>
<td>Menu toggle, CLI, launchd</td>
<td>Source installer; Homebrew tap on Apple Silicon</td>
<td>Menu bar, CLI, launchd</td>
</tr>
<tr>
<td>Windows 11 x64</td>
<td>Unsigned installer and portable ZIP</td>
<td>Microsoft Store, Scoop, standalone installer/ZIP</td>
<td>Native tray and CLI</td>
</tr>
</tbody>
Expand Down Expand Up @@ -344,8 +344,8 @@ <h2>macOS.</h2>
<pre><code>./scripts/install-macos.sh
./scripts/install-macos-menu-bar.sh</code></pre>
<p>
The menu toggles the daemon; change packs/volume through the CLI.
Quitting the helper closes the menu, not the daemon.
The menu offers Pause/Resume, volume, sound packs, engine start/stop
and login startup. Quitting the helper closes the menu, not the daemon.
</p>
</section>
<section id="homebrew">
Expand Down Expand Up @@ -459,8 +459,8 @@ <h2>Your first few clicks.</h2>
<pre><code>&amp; "$env:LOCALAPPDATA\Programs\Klicky\klicky.exe" status</code></pre>
<p>
Select the intended speakers/headphones and type briefly. On
Windows, Resume if paused. The macOS menu toggles sounds; Linux uses
its service controls.
Windows, macOS or Klicky Bar, choose Resume if paused. The CLI command
<code>klicky resume</code> also resumes playback without restarting the engine.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
</p>
</section>
<section id="cli">
Expand Down Expand Up @@ -497,6 +497,14 @@ <h2>CLI reference.</h2>
<td><code>volume LEVEL</code></td>
<td>Set a finite value from 0.0 (mute) to 1.0.</td>
</tr>
<tr>
<td><code>pause</code></td>
<td>Silence playback without stopping the engine.</td>
</tr>
<tr>
<td><code>resume</code></td>
<td>Resume playback without replaying paused keypresses.</td>
</tr>
<tr>
<td><code>status</code></td>
<td>Show settings and responsive live state.</td>
Expand Down Expand Up @@ -532,8 +540,8 @@ <h2>CLI reference.</h2>
</div>
<h3>Windows additions</h3>
<p>
<code>pause</code>, <code>resume</code>,
<code>retry-audio</code> and read-only <code>diagnostics</code>.
<code>retry-audio</code> and read-only <code>diagnostics</code>
are Windows-only commands.
<code>service start --paused</code> affects a newly launched
instance. Foreground <code>start</code> also takes
<code>--paused</code>, <code>--seconds N</code> (1–3600) and
Expand All @@ -543,8 +551,7 @@ <h3>Linux/macOS benchmark mode</h3>
<p>
<code>start --benchmark</code> prints mapped key names and internal
timing. Use only for controlled tests, never while typing sensitive
information. Windows-only pause/seconds/diagnostics commands do not
exist on Unix.
information.
</p>
<p>
A successful live pack/volume command confirms the change was
Expand Down Expand Up @@ -1079,6 +1086,7 @@ <h2>Help this little world grow.</h2>
<li><a href="https://dev.to/muneer320/i-wanted-keyboard-sounds-on-linux-then-i-fell-down-the-audio-stack-3b1d">Audio deep dive (DEV)</a></li>
<li><a href="https://alternativeto.net/software/klicky/about/">AlternativeTo</a></li>
<li><a href="https://www.pitchhut.com/project/klicky">PitchHut</a></li>
<li><a href="https://www.saashub.com/klicky">SaaSHub</a></li>
</ul>
</div>
</nav>
Expand Down
4 changes: 3 additions & 1 deletion packaging/apt/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@
"https://github.com/Muneer320/klicky",
"https://apps.microsoft.com/detail/9NLVFX7T2X6Q",
"https://alternativeto.net/software/klicky/about/",
"https://www.pitchhut.com/project/klicky"
"https://www.pitchhut.com/project/klicky",
"https://www.saashub.com/klicky"
],
"offers": {
"@type": "Offer",
Expand Down Expand Up @@ -1104,6 +1105,7 @@ <h2 id="faq-title">Before you move in.</h2>
<li><a href="https://dev.to/muneer320/i-wanted-keyboard-sounds-on-linux-then-i-fell-down-the-audio-stack-3b1d">Audio deep dive (DEV)</a></li>
<li><a href="https://alternativeto.net/software/klicky/about/">AlternativeTo</a></li>
<li><a href="https://www.pitchhut.com/project/klicky">PitchHut</a></li>
<li><a href="https://www.saashub.com/klicky">SaaSHub</a></li>
</ul>
</div>
</nav>
Expand Down
1 change: 1 addition & 0 deletions packaging/apt/privacy.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ <h2>Questions or concerns?</h2>
<li><a href="https://dev.to/muneer320/i-wanted-keyboard-sounds-on-linux-then-i-fell-down-the-audio-stack-3b1d">Audio deep dive (DEV)</a></li>
<li><a href="https://alternativeto.net/software/klicky/about/">AlternativeTo</a></li>
<li><a href="https://www.pitchhut.com/project/klicky">PitchHut</a></li>
<li><a href="https://www.saashub.com/klicky">SaaSHub</a></li>
</ul>
</div>
</nav>
Expand Down
Loading