keyviz - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #golang #rust #deep-learning #linux #docker #macos #windows #awesome-list #pytorch

keyviz

(★ 9,586)

Keyviz is a free and open-source tool to visualize your keystrokes ⌨️ and 🖱️ mouse actions in real-time.

파일 탐색기

최종 버전 다운로드 (.zip)

- - winget.yml
- FUNDING.yml
- extensions.json
- mouse-indicator.gif
- settings.png
- visualization.png
- logo-pro.svg
- logo.svg
- - custom-filter.tsx
  - key-overlay.tsx
  - mouse-indicator.tsx
  - mouse-overlay.tsx
  - shortcut-recorder.tsx
  - theme-mode-toggle.tsx
  - theme-provider.tsx
- - keymaps.ts
  - utils.ts
- - settings.tsx
  - visualization.tsx
- - key_event.ts
  - key_style.ts
  - storage.ts
  - sync.ts
- - event.ts
  - style.ts
- App.css
- App.tsx
- main.tsx
- vite-env.d.ts
- - default.json
- - 128x128.png
  - 128x128@2x.png
  - 32x32.png
  - icon.icns
  - icon.ico
  - icon.png
  - Square107x107Logo.png
  - Square142x142Logo.png
  - Square150x150Logo.png
  - Square284x284Logo.png
  - Square30x30Logo.png
  - Square310x310Logo.png
  - Square44x44Logo.png
  - Square71x71Logo.png
  - Square89x89Logo.png
  - StoreLogo.png
  - tray-disabled.png
  - tray.png
- - lib.rs
  - main.rs
- - banner.png
  - dialog-image.png
- .gitignore
- 2
- build.rs
- Cargo.lock
- Cargo.toml
- tauri.conf.json
- tauri.windows.conf.json
.gitignore
components.json
index.html
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tsconfig.node.json
vite.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/mulaRahul/keyviz

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd keyviz

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Rust

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

cd src-tauri

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

cargo build --release

Rust 프로젝트를 컴파일합니다.

cargo run

빌드 후 바로 실행까지 진행합니다.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [Keyviz](https://keyviz.org)

<div>
   <img src="https://img.shields.io/github/v/release/mulaRahul/keyviz?style=flat-square" alt="Releases">
   <img src="https://img.shields.io/github/downloads/mulaRahul/keyviz/total?style=flat-square" alt="Downloads">
   <img src="https://img.shields.io/github/stars/mulaRahul/keyviz?style=flat-square" alt="Stars">
   <img src="https://img.shields.io/github/license/mulaRahul/keyviz?style=flat-square" alt="License">
   <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS-lightgrey?style=flat-square" alt="Platform Support">
</div>

Keyviz is a **free and open-source** tool that visualizes your keypresses and mouse actions in real-time. Let your audience know what handy shortcuts you're pressing during tutorials, presentations, collaborations, or whenever you need.

## ⌨️ Keypress & 🖱️ Mouse Actions
Along with normal keys, you can also visualize mouse actions like <kbd>Cmd</kbd> + <kbd>Click</kbd>, <kbd>Alt</kbd> + <kbd>Drag</kbd>, etc.

<img src="previews/visualization.png" alt="Keystroke Visualization" width="450">

Display mouse clicks and scroll wheel movements alongside your cursor.

<img src="previews/mouse-indicator.gif" alt="Mouse Indicator" width="450">

</br>

## ⚙️ Full Customization
Don't settle for defaults. Every aspect of the visualization is under your control:
- **Styling:** Change colors (modifier vs. regular keys), size, layout, border, and background.
- **Filtering:** Control which keys are shown using hotkey or custom filters.
- **History:** Keep a visual trail of your recent inputs.
- **Position:** Move the visualization to any part of your screen.
- **Animations:** Customize how inputs appear and disappear with preset entry and exit animations.

</br>

<img src="previews/settings.png" alt="Settings Panel" width="600">

</br>

## 📥 Installation

### Windows & macOS
You can download the latest version of Keyviz from the **[GitHub Releases](https://github.com/mulaRahul/keyviz/releases)** page.

*   **Windows:** Download the `.msi` installer, run it, and follow the steps.
*   **macOS:** Download the `.dmg`. 
    **Note:** Keyviz requires **Input Monitoring** and **Accessibility** permissions. Enable them here:
    `Settings > Privacy & Security > Input Monitoring & Accessibility`

### Linux (x11)
Keyviz is compatible with Linux using the X11 protocol. Currently, you can try it out by following the build instructions below.

</br>

## 🛠️ Build Instructions

If you want to contribute or build the latest features from the source, ensure you have [Node.js](https://nodejs.org/) and [Tauri](https://v2.tauri.app/start) set up on your system.

1.  **Clone the repository:**
    ```bash
    git clone https://github.com/mulaRahul/keyviz.git
    cd keyviz
    ```

2.  **Install dependencies:**
    ```bash
    npm install
    ```

3.  **Build the executable:**
    ```bash
    npx tauri build
    ```

<br/>

## 💖 Support the Project

*   **Star the Repo:** It helps others discover the project!
*   **GitHub Sponsors:** [Sponsor @mularahul](https://github.com/sponsors/mulaRahul)
*   **Keyviz Pro:** Get access to exclusive features while supporting the development of this open-source project.

👉 **[Upgrade to Pro at keyviz.org/pro](https://keyviz.org/pro)**

</br>

---

Built with 🦀 and ❤️ using <a href="https://v2.tauri.app/">Tauri</a>.