HAMMERSPOON · API DOCUMENTATION

Hammerspoon API 문서 한글판

원문(hammerspoon.org/docs)의 모듈 목록을 한글로 옮기고, 용도별로 묶어서 찾기 쉽게 정리했습니다. 카드를 누르면 해당 모듈의 원문 상세 문서가 새 탭으로 열립니다.

📘 시작 가이드(한글) 보기 설치부터 단축키·창 관리·이벤트 자동화까지
140전체 모듈
12용도별 분류
3주의 표시 (실험적 · 폐기 예정 · 고급)

📖 이름 읽는 법

모듈 이름에 규칙이 있어서, 이름만 봐도 성격을 짐작할 수 있습니다.

hs.모듈

모든 모듈은 hs.로 시작합니다. Lua 설정 파일에서 hs.hotkey.bind(...)처럼 바로 호출합니다.

hs.A.watcher

감시자 “~가 바뀌면 알려줘” 형태의 이벤트 구독 모듈입니다. 예: 앱 실행, USB 연결, 배터리 상태 변화.

hs.A.B

상위 모듈 hs.A의 하위 모듈입니다. 대개 상위 모듈을 먼저 이해한 뒤 보면 됩니다.

배지 색상

실험적 실사용 금지  폐기 예정 대체 모듈 사용  고급 · 내부용 대부분 직접 쓸 일 없음

⭐ 먼저 살펴볼 만한 모듈

자동화 스크립트에서 자주 등장하는 모듈만 추렸습니다. (원문 페이지의 구분이 아닌 정리자의 선별입니다.) 사용 예제는 시작 가이드에서 볼 수 있습니다.

hs.hotkey전역 단축키 등록가장 먼저 만나게 되는 모듈. “이 키를 누르면 이 함수 실행”hs.window창 이동 · 크기 조절창을 화면 절반으로 붙이기 같은 창 관리 자동화의 중심hs.application앱 실행 · 전환앱을 켜고, 포커스 주고, 종료하는 기본 도구hs.timer주기 / 지연 실행N초 뒤, N초마다 함수 실행hs.task셸 명령 실행백그라운드로 프로세스를 돌리고 결과 받기hs.alert화면 알림동작 확인용 가장 간단한 피드백 표시hs.pathwatcher파일 변경 감시설정 파일이 바뀌면 자동으로 리로드하는 패턴에 사용hs.eventtap입력 이벤트 가로채기키보드 / 마우스 이벤트를 관찰하고 바꾸는 고급 입력 제어

🔗 프로젝트 링크

🧰핵심 · 유틸리티14개

언어 보조, 데이터 변환, 저장 등 어디서나 쓰는 기반 도구

🪟앱 · 창 · 스페이스17개

앱과 창을 찾고, 옮기고, 배치하고, 전환

⌨️키보드 · 마우스 입력9개

단축키 등록, 입력 이벤트 가로채기, 마우스 제어

🖥️화면 · 그리기10개

모니터 제어와 화면 위에 도형·이미지·텍스트 그리기

💬UI · 알림12개

사용자에게 보여주는 알림, 대화상자, 메뉴바, 웹뷰

🎧오디오 · 미디어 · 음성11개

오디오 장치, 음악 플레이어, 음성 합성 / 인식, 카메라

🔋시스템 · 하드웨어 · 장치16개

전원, 배터리, USB, 위치, 그리고 외부 하드웨어 제어

📁파일 · 클립보드 · 검색9개

파일 시스템, 변경 감시, Spotlight 검색, 클립보드

🌐네트워크20개

HTTP, 소켓, WiFi, Bonjour 등 네트워크 통신과 상태 감시

hs.network

네트워크 상태 조회 및 변경 감시

hs.network.configuration고급 · 내부용하위 모듈

시스템 동적 저장소에 있는 현재 위치(location) 세트의 설정 접근

hs.network.host하위 모듈

호스트 이름, 주소, 도달 가능성 등 호스트 정보 확인

hs.network.ping하위 모듈

호스트 가용성을 확인하는 기본 ping 함수. 대상까지의 경로가 있는지, 응답하는지 확인

hs.network.ping.echoRequest고급 · 내부용하위 모듈

hs.network.ping이 사용하는 ICMP Echo Request 인프라에 대한 저수준 접근. 특별한 요구가 없다면 직접 쓸 일이 거의 없음

hs.network.reachability하위 모듈

대상 호스트의 도달 가능성 확인. 패킷이 로컬 기기를 떠날 수 있으면 도달 가능으로 간주하며, 실제 수신까지 보장하지는 않음

hs.wifi

WiFi 네트워크 조회

hs.wifi.watcher감시자하위 모듈

연결된 WiFi 네트워크 변경 감시

hs.bonjour

멀티캐스트 DNS(Bonjour)로 알려지는 네트워크 서비스를 찾거나 게시

hs.bonjour.service하위 모듈

hs.bonjour가 발견했거나 게시한 서비스 레코드를 표현하는 객체

hs.http

HTTP 요청 수행

hs.httpserver

간단한 HTTP 서버

hs.httpserver.hsminweb하위 모듈

Hammerspoon용 최소 기능 웹 서버

hs.httpserver.hsminweb.cgilua고급 · 내부용하위 모듈

Hammerspoon 최소 웹 서버의 Lua 템플릿을 위한 cgilua 모듈 지원 함수

hs.httpserver.hsminweb.cgilua.lp고급 · 내부용하위 모듈

Lua 템플릿 페이지를 Lua 코드로 변환·포함해 HTTP 요청에 동적 콘텐츠를 제공하는 CGILua 호환 모듈의 지원 함수

hs.httpserver.hsminweb.cgilua.urlcode고급 · 내부용하위 모듈

RFC 3986에 따른 URL 구성요소 인코딩 / 디코딩 지원 함수 (CGILua 호환 모듈용)

hs.socket

비동기 TCP 소켓 또는 UNIX 파일 소켓으로 사용자 정의 프로토콜과 통신

hs.socket.udp하위 모듈

비동기 UDP 소켓으로 사용자 정의 프로토콜과 통신

hs.websocket

간단한 웹소켓 클라이언트

hs.ipc

프로세스 간 통신(IPC)을 위한 로컬 / 원격 메시지 포트 생성 (hs 커맨드라인 도구가 사용)

⚙️스크립트 실행 · 타이머 · 연동12개

셸 / AppleScript 실행, 타이머, URL 이벤트, 다른 앱 · 서비스와 연동

♿접근성 · UI 요소5개

다른 앱의 UI 요소를 읽고 감시하는 접근성 API

🛠️문서 · 개발자용5개

내장 도움말 문서 시스템과 Hammerspoon 개발자용 기능