Skip to content

hakyung4/flowkey

Repository files navigation

FlowKey

A local automation layer that learns how you work.

FlowKey는 내 컴퓨터의 반복 작업과 파일/앱 흐름을 관찰해, 안전하게 되돌릴 수 있는 개인 자동화 워크플로로 바꿔주는 로컬 OS 레이어입니다.

  • 로컬 우선: 모든 이벤트는 디스크에 머무릅니다. 네트워크/계정 없음.
  • 저수준 엔진: C로 작성된 데몬 + IPC. UI는 분리.
  • 안전한 실행: dry-run · confirm · undo · journal.

구성

flowkeyd   백그라운드 데몬 (관찰 · 패턴 · 실행 엔진)
flowctl    CLI 클라이언트 (status, tail, run, undo …)
libflowkey 코어 정적 라이브러리 (arena, ring, journal, event)

자세한 설계는 docs/architecture.md, 제품 컨셉은 docs/concept.md, 로드맵은 docs/roadmap.md.

빌드

make            # release 빌드 (LTO, -O3)
make debug      # ASan/UBSan
make test       # 유닛 테스트
make run        # 데몬 실행 (foreground)

크로스 플랫폼 빌드 (Windows/Linux/macOS):

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j

요구사항: macOS 12+ / Windows 10+ / Linux 5.4+ · C11 컴파일러 (clang 13+, MSVC 19.30+, gcc 11+).

빠른 시작

flowctl init                 # ~/.flowkey 스캐폴딩
flowkeyd -f                  # 다른 터미널에서 데몬 실행
flowctl tail                 # 실시간 이벤트 스트림
flowctl patterns             # 학습된 패턴
flowctl suggestions          # 자동화 제안 + 절약 시간 추정
flowctl rules                # 로드된 규칙
flowctl run recipe.rec       # 레시피 실행
flowctl undo run-...         # 되돌리기
flowctl pause / flowctl resume

규칙 예시 (~/.flowkey/rules.txt)

rule "archive new PDFs"
  on fs.create
  in ~/Downloads
  ext .pdf
  run ~/.flowkey/recipes/archive_pdf.rec

레시피 예시 (~/.flowkey/recipes/archive_pdf.rec)

name: archive pdf
mkdir ~/Downloads/Archive
move {path} ~/Downloads/Archive/{basename}

프라이버시 (~/.flowkey/excludes.txt)

~/Downloads/private
~/Documents/.git

매칭되는 경로 접두사는 저널·패턴·규칙·IPC 어디에도 기록되지 않습니다.

라이선스

TBD.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors