josephleblanc/ploke

Ploke는 개발자와 LLM(Large Language Model) 간의 협업을 위한 Rust 중심의 터미널 기반 애플리케이션입니다. 이 도구는 Rust 코드베이스를 벡터-그래프 데이터베이스(vector-graph database)로 기본적으로 파싱하며, 시맨틱 검색/편집(semantic search/edits)과 같은 효율적인 LLM 검색/편집 기능과, LLM을 위해 테스트 출력을 파싱하고 필터링하는 네이티브 "cargo test" 도구와 같은 Rust 중심의 툴링을 제공합니다. Ploke는 vim 스타일의 바인딩(Insert 모드 vs Normal 모드), 인터랙티브 오버레이를 통한 광범위한 설정(사용 가능한 모든 OpenRouter 모델을 포함하는 모델 선택기, 도구 상세도(verbosity), 임베딩 선택기), 그리고 코드 분석 및 LLM 기능의 발견을 유도하는 디자인(LLM용 코드 검색 도구를 미러링하는 시맨틱 + bm25 검색 오버레이)을 제공하는 데 중점을 둡니다.

코딩 LLM이 귀하의 Rust 코드베이스를 깊이 있게 이해하기를 원한다면, 제대로 찾아오셨습니다.

시작하기 · 기능 · 문서 (mdBook) · 문제 해결 · 문의하기

🚧 경고: 초기 알파 버전 🚧

개발 중이며, 오류가 있는 크레이트(crate)를 파싱하려고 시도하거나 특정 알려진 제한 사항 또는 알 수 없는 버그가 있는 경우 충돌/패닉(crash/panic)이 발생할 수 있습니다. 버그를 발견하면 이슈(issue)를 생성해 주세요. 저희의 할 일 목록(todo list) 최상단으로 바로 올라갈 것입니다.

git clone https://github.com/josephleblanc/ploke.git
cd ploke
./install.sh

git clone https://github.com/josephleblanc/ploke.git
cd ploke
cargo build --release

이렇게 하면 ploke가 <git clone dir>/target/ploke에 위치하게 됩니다.

설치 후, OPENROUTER_API_KEY가 설정되어 있는지 확인하세요.

예시:

export OPENROUTER_API_KEY="sk-..." # OpenRouter 키

다음으로, Rust 프로젝트가 있는 디렉토리로 이동하여 ploke를 실행하기만 하면 됩니다:

cd ~/path/to/rust/crate-or-workspace
ploke

여기에서 몇 가지 명령어를 사용하여 모델과 임베딩 모델(embedding model)을 선택하고 코드베이스를 인덱싱할 수 있습니다.

모델 선택 (기본값: kimi-k2)

/model search <model>
예시:
/model search kimi

임베딩 모델 선택 (현재는 sentence-transformers를 사용하여 로컬 CPU 프로세싱을 기본값으로 하며, 느릴 수 있습니다!)

/embedding search <model>

OpenRouter의 모든 임베딩 모델(embedding models)은 여기에서 확인할 수 있습니다.

코드베이스를 위한 코드 그래프(code graph)를 생성합니다. 기본적으로 작업 디렉토리(working directory)로부터 그래프를 생성하며, 워크스페이스(workspace) 내에 있다면 워크스페이스를, 크레이트(crate) 내에 있다면 크레이트를 인덱싱(indexing)합니다.

/index start

이제 준비가 완료되었습니다. 다음에 LLM에 메시지를 보내면, ploke는 빠른 초기 컨텍스트(context) 확보를 위해 사용자의 메시지에 대해 시맨틱 검색(semantic search)을 자동으로 수행하여 관련 코드를 찾습니다. 또한 ploke의 LLM 내장 도구를 통해 모델이 코드 항목을 조회하거나 코드베이스를 시맨틱 검색할 수 있습니다.

기본적으로 모델의 컨텍스트 윈도우(context window)는 대화 전반에 걸쳐 관리되지만, Ctrl+f를 사용하여 이를 끌 수 있습니다.

임베딩 및 인덱싱된 코드베이스의 코드 그래프를 저장하려면 다음을 사용할 수 있습니다:

/save db

나중에 더 빠르게 로드하려면 다음을 사용하세요:

/load <crate-name>
/load <workspace-dir-name-only>

다음은 몇 가지 일반적인 명령어입니다. 사용 가능한 명령어에 대한 전체 참조는 ploke 내에서 /help를 사용하세요.

model_picker_demo.mp4

기본값: kimi-k2

이 명령은 모델/제공자(provider)를 탐색하고 선택할 수 있는 오버레이(overlay)를 엽니다. 검색은 정확한 문자열과 일치해야 하므로, 모든 gpt-family 모델을 보려면

종류	명령어	목적
Index	/index start [path]	가장 구체적인 crate 또는 workspace 타겟을 인덱싱 (indexing) 합니다.
	/index pause	활성화된 인덱싱 작업을 일시 중지합니다.
	/index resume	활성화된 인덱싱 작업을 재개합니다.
	/index cancel	활성화된 인덱싱 작업을 취소합니다.
Models	/model list	사용 가능한 모델 (models) 목록을 나열합니다.
	/model info	활성화된 모델 및 제공자 (provider) 설정을 보여줍니다.
	/model use <name>	별칭 (alias) 또는 ID를 통해 활성 모델을 전환합니다.
	/model <name>	/model use <name>의 이전 방식 단축 명령어입니다.
	/model refresh [--local]	모델 레지스트리 (registry)를 새로고침하거나, --local 옵션으로 API 키만 다시 로드합니다.
	/model load [path]	디스크에서 config.toml을 로드합니다.
	/model save [path] [--with-keys]	config.toml을 저장합니다. --with-keys가 설정되지 않으면 비밀 정보 (secrets)는 가려집니다 (redacting).
	/model search <keyword>	OpenRouter 모델을 검색하고 모델 브라우저를 엽니다.
	/embedding search <keyword>	OpenRouter 임베딩 (embedding) 모델을 검색하고 임베딩 브라우저를 엽니다.
Provider	/model providers <model_id>	모델에 대한 제공자 엔드포인트 (endpoints)를 나열하고 도구 (tool) 지원 여부를 보여줍니다.
	`/provider strictness <openrouter-only	allow-custom
	`/provider tools-only <on	off>`
	/provider select <model_id> <provider_slug>	모델을 특정 제공자 엔드포인트에 고정 (pin) 합니다.
	/provider pin <model_id> <provider_slug>	/provider select의 별칭 (alias) 입니다.
Context Search	/search <query>	인덱싱된 코드 컨텍스트 (context)를 검색하고 컨텍스트 브라우저를 엽니다.
BM25	/bm25 search <query> [top_k]	희소 (sparse) BM25 인덱스를 검색합니다.
	/hybrid <query> [top_k]	BM25와 밀집 검색 (dense retrieval)을 결합하여 검색합니다.
	/bm25 rebuild	희소 BM25 인덱스를 재구축 (rebuild) 합니다.
	/bm25 status	BM25 인덱스 상태를 보여줍니다.
	/bm25 save <path>	BM25 사이드카 (sidecar) 인덱스를 저장합니다.
	/bm25 load <path>	BM25 사이드카 (sidecar) 인덱스를 로드합니다.

| | /load workspace <name-or-id> | 저장된 워크스페이스 (workspace) 스냅샷을 로드합니다. |
| | /load crate <name-or-id> | 저장된 워크스페이스 (workspace) 스냅샷을 로드하는 레거시 (Legacy) 별칭입니다. |
| | /load crates <workspace> <crate> | 하나의 크레이트 (crate) 서브셋을 현재 워크스페이스 (workspace) 스냅샷으로 로드합니다. |
| | /save db | 활성 워크스페이스 (workspace) 스냅샷 및 레지스트리 (registry) 항목을 저장합니다. |
| | /sd | /save db 의 별칭입니다. |
| /workspace status | 현재 워크스페이스 (workspace) 상태를 표시합니다. |
| /workspace update | 파일 시스템 (filesystem) 변경 후 워크스페이스 (workspace) 상태를 새로고침합니다. |
| /update | 워크스페이스 (workspace)를 스캔하고 데이터베이스 (database) 업데이트가 필요한 파일을 보고합니다. |
| /workspace rm <crate> | 현재 워크스페이스 (workspace)에서 로드된 하나의 크레이트 (crate) 네임스페이스 (namespace)를 제거합니다. |
| Edits | /edit preview mode <code|diff> | 스테이징된 편집 (staged edits)을 미리 보는 방식을 선택합니다. |
| | /edit preview lines <N> | 섹션당 최대 미리보기 라인 수를 설정합니다. |
| | /edit auto <on|off> | 스테이징된 편집 (staged edits)의 자동 승인 여부를 토글합니다. |
| | /edit approve <request_id> | 스테이징된 코드 편집 (code edits)을 적용합니다. |
| | /edit deny <request_id> | 스테이징된 코드 편집 (code edits)을 폐기합니다. |
| | /create approve <request_id> | 스테이징된 파일 생성 제안을 적용합니다. |
| | /create deny <request_id> | 스테이징된 파일 생성 제안을 폐기합니다. |
| View | /preview [on|off|toggle] | 컨텍스트 (context) 미리보기 패널을 토글합니다. |
| Settings | /tool verbosity <minimal|normal|verbose|toggle> | 도구 출력의 상세도 (verbosity)를 확인하거나 변경합니다. |
| | /verbosity profile <minimal|normal|verbose|custom> | 대화 상세도 (conversation verbosity) 프로필을 확인하거나 변경합니다. |
| Utilities | /check api | API 키 설정 힌트를 표시합니다. |
| | /copy | 선택한 대화 메시지를 클립보드 (clipboard)에 복사합니다. |
| | /save history | 대화 기록 (history) 및 상태를 저장합니다. |
| | /query load [name file] | 디스크 (disk)에서 이름이 지정된 쿼리 (query)를 로드합니다. |
| | /ql | /query load 의 별칭입니다. |
| | /batch [prompt_file] [out_file] [max_hits] [threshold] | 배치 (batch) 프롬프트 검색을 실행하고 결과를 파일에 기록합니다. |
| | /context plan | 컨텍스트 플랜 (context plan) 오버레이를 엽니다. |
| | /contextplan | /context plan 의 별칭입니다.

| | /help [topic] | 일반 도움말 또는 특정 주제에 대한 도움말을 표시합니다. | |
| | /quit | 애플리케이션을 종료합니다. |

확장/축소 (Expand/Collapse)

모드 (Mode)	키 (Key)	동작 (Action)
Any	Ctrl+c	종료 (Quit)
Any	Ctrl+f	컨텍스트 관리 정책 (context management policy) 순환
Insert	Esc	일반 모드 (Normal mode)로 복귀
Insert	Enter / Shift+Enter	메시지 제출 (Submit message)
Insert	Tab	완성 (completion) 수락
Insert	Up / Down	제안 (suggestions) 순환
Insert	Ctrl+p / Ctrl+n	제안 (suggestions) 순환
Insert	Ctrl+Up / Ctrl+Down	입력창 스크롤
Command	Esc	일반 모드 (Normal mode)로 복귀
Command	Enter / Shift+Enter	명령 실행 (Execute command)
Command	Tab	완성 (completion) 수락
Command	Up / Down	제안 (suggestions) 순환
Command	Ctrl+p / Ctrl+n	제안 (suggestions) 순환
Command	Backspace	명령 버퍼 (command buffer) 편집
Normal	q	종료 (Quit)
Normal	i	입력 모드 (Insert mode) 진입
Normal	:	명령 모드 (command mode) 진입 (NeoVim 스타일)
Normal	/	하이브리드 검색 프롬프트 (hybrid search prompt) 열기
Normal	m	빠른 모델 선택 (quick model selection) 열기
Normal	?	도움말 표시
Normal	P	컨텍스트 미리보기 (context preview) 토글
Normal	v	도구 상세도 (tool verbosity) 순환
Normal	e	승인 (approvals) 열기
Normal	s	컨텍스트 검색 (context search) 열기
Normal	p	컨텍스트 플랜 (context plan) 열기
Normal	o	설정 / 도구 설정 (config / tool settings) 열기
Normal	Enter	선택된 항목 실행 (Trigger)
Normal	y	선택된 메시지 복사
Normal	Y	대기 중인 모든 편집 승인 (Approve all pending edits)
Normal	N	대기 중인 모든 편집 거부 (Deny all pending edits)
Normal	j / Down	아래로 이동
Normal	k / Up	위로 이동
Normal	h / Left	이전 브랜치 (Previous branch)
Normal	l / Right	다음 브랜치 (Next branch)
Normal	J	페이지 다운
Normal	K	페이지 업
Normal	gg	대화의 맨 위로 이동
Normal	G	대화의 맨 아래로 이동
Normal	Del	선택된 대화 항목 삭제
Normal	Ctrl+n / Ctrl+p	한 줄 아래/위로 스크롤

확장/축소 (Expand/Collapse)