📜 OpenLore

후원:

SSH를 통해 AI 에이전트에게 문서를 제공하세요.

OpenLore는 공유 컨텍스트를 최신 상태로 유지하고 검사 가능하게 해주는, 최소 구성의 확장 가능하고 에이전트 중심적인 지식 베이스입니다.

소개

AI 코딩 에이전트는 이미 ls, cat, grep, find, 파이프, 셸 루프로 파일을 탐색하는 방법을 알고 있습니다. OpenLore는 실제 머신 대신 문서를 기반으로 SSH 위에서 동일한 인터페이스를 제공합니다.

Agent ──SSH or MCP──▶ OpenLore ──▶ docs, knowledge, and artifacts

단일 바이너리, 제로 구성, 읽기 전용 문서 서버로 시작합니다. 라이브 지식 베이스가 필요해질 때, 에이전트가 콘텐츠를 읽거나 탐색하는 방식을 바꾸지 않고도 identity 범위의 접근, 통제된 게시, 원자적 쓰기, 검증, 사람의 승인을 추가할 수 있습니다.

Markdown 저장 및 검색

문서, 런북, 프로젝트 컨텍스트, 또는 에이전트가 작성한 노트를 일반 Markdown 파일에 넣으세요. 수집(ingestion) 파이프라인은 없습니다. OpenLore에 디렉터리를 지정하면 기존 계층 구조를 그대로 제공합니다. 폴더로 문서를 분류하고 표준 Markdown 링크로 연결하며, 서로 다른 사람이나 에이전트가 서로 다른 접근 권한이 필요하다면 docset으로 그룹화하세요. OpenLore는 기본적으로 읽기 전용입니다. 에이전트가 Markdown도 만들고 업데이트하기를 원한다면 쓰기를 활성화하세요.

Related MCP server: AgentBase

빠른 시작

가장 빠른 방법은 에이전트가 OpenLore를 설정하게 하는 것입니다:

# Teach your agent how to install, configure, and bundle OpenLore
ssh openlore.sh teach | your-agent-cli

# Add documentation access instructions to AGENTS.md
ssh openlore.sh agents >> AGENTS.md

또는 직접 설치해서 실행하세요:

go install github.com/aakarim/go-openlore/cmd/openlore@latest

openlore ./docs

ssh -p 2222 localhost
ssh -p 2222 localhost "grep -r 'authentication' /docs"

기본적으로 다음이 시작됩니다:

• SSH on localhost:2222

• 사람이 볼 수 있는 웹 뷰는 http://localhost:8080에서

• MCP over HTTP는 http://localhost:8080/mcp에서

OpenLore를 설치하고 패키징하는 더 많은 방법은 Installation을 참조하세요.

기능

• 에이전트별 검색 — 에이전트가 특수한 검색 API를 배우는 대신 이미 이해하고 있는 셸 도구와 조합(composition) 패턴을 그대로 사용합니다.

• 하나의 지식 표면, 다중 전송 — 동일한 가상 파일시스템을 SSH, SFTP/SSHFS, MCP, 그리고 사람 웹 인터페이스로 제공합니다.

• 살아 있는 관리형 지식 — 콘텐츠를 읽기 전용으로 유지하거나 범위가 제한된 게시를 허용하고, 문서 세트별로 쓰기 기능을 활성화할 수 있습니다. 쓰기는 원자적이며, 충돌을 인지하고, 사람 승인을 요구할 수 있습니다.

• Identity 범위의 뷰 — 역할 기반 ro, publish, rw 권한, 경로 별칭, 그리고 전용 홈 디렉터리를 제공하며 각 사용자나 에이전트에게 필요한 docset만 부여합니다.

• 구조적으로 안전한 설계 — 셸은 진짜 운영체제 셸이 아니라 인메모리 Go 인터프리터입니다. 일반 세션에서는 셸 탈출, 임의 프로세스 실행, 또는 앰비언트 네트워크 접근이 없습니다.

• 휴대용 지식 번들 — 하나의 독립적인 바이너리에 문서를 포함하거나, GitHub Action을 통해 크로스 플랫폼 번들을 만들고, 데스크톱 MCP 확장으로 패키징할 수 있습니다.

• 새 질의 언어 없이 구조화된 지식 — lore meta로 frontmatter를 NDJSON 내며 검사하고 jq로 질의하며, Google의 Open Knowledge Format (OKF) 번들과 Agent Skills를 쓰기 경로의 가까운 곳에서 검증합니다.

• 확장 가능한 정책과 처리 — 플러그인은 검증, 권한 부여, 읽기/쓰기 미들웨어, 메타데이터, 커밋 후 처리를 추가하면서 파일시스템 인터페이스는 유지합니다.

사용 사례

• 지속 학습 저장소 — 세션과 학습 내용을 하나의 공유 서버에 저장합니다. 지표를 추가하여 최적화할 수 있습니다. 에이전트가 사용자 격리를 유지하면서 서로 학습 내용을 공유할 수 있습니다.

• 팀 아티팩트 저장소 — 접근 제어를 유지하면서 만든 Markdown, HTML, JSON, Excel 문서를 공유합니다. Git보다 자연스럽고 Confluence/Notion보다 에이전트에 이해하기 쉽습니다.

• 코딩 에이전트용 문서 — 내부 API 문서, 런북, 제품 컨텍스트, 아키텍처 노트를 편안하고 검색 가능한 인퍼페이스에 제공합니다.

• 에이전트 팀을 위한 공유 라이브 메모리 — 에이전트에게 분리나 공유 docset를 제공해서 발견한 점을 발행하고 작업을 인계하며 여러 세션에 걸쳐 오래 쓸 수 있는 컨텍스트를 쌓을 수 있습니다.

• 공개 문서 사이트 - 공개 docset에 어떤 파일이든 추가하고 공개 접근을 켜면, 사이트를 지나가는 모든 에이전트가 맞습니다. 기존 문서를 수정하지 않고 AEO/GEO를 향상시킵니다.

• Skills 공유 — Authorized Agent Skills를 공유 컬렉션에 게시해서 모든 대상 에이전트가 동일한 관리 절차를 탐색하고 사용할 수 있게 합니다.

• Agent Plugins 저장소 — GitHub의 Agent Plugins 저장소를 버전으로 고정시키고 팀 에이전트에게 제공합니다. 오픈 표준으로 패키징된 Skills은 자동으로 최신을 유지합니다.

• 관리되는 지식 기여 — 참가자는 인박스에 게시할 수 있고, 민감하거나 중요한 경로는 승인자로 남아 있어 실수로 드물게 제거 인 상속되지 않게 합니다.

• 에이전트 아티팩트 원격 검토 — 리뷰나 보안 해제 없이 커스텀 뷰너를 구현하거나 에이전트 시스템에 접근 권한을 주지 않고, 보고서, 로그, 스크린샷, 생성된 파일을 브라우저나 SSH로 제공할 수 있습니다.

• identity 특정 작업 공간 — 하나의 서버와 인증 모 모델로 각 에이전트의 개인 홈과 공유 팀 지식을 연결할 수 있습니다.

• 휴대 가능한 고객 또는 프로젝트 지식 — 관련 문서가 포함된 배포 가능한 실행 파일을 출시하거나 같은 지식을 MCPB 데스크톱 확장으로 배포합니다.

• 검증된 지식 카탈로그 — frontmatter와 번들 규약을 강제하고, 메타데이터를 저렴하게 조사하며, 형식이 잘못된 지식은 수용 단계에서 막을 수 있습니다.

동작 방식

OpenLore는 SSH 전송을 위해 Wish 위에 구축됩니다. 연결은 전적으로 가상 파일시스템을 기반으로 처리됩니다:

1. Authenticate — 연결 없이 연결하거나 SSH 키, 인증서, 패스키, 또는 OAuth 로그인을 신원(identity)과 연결합니다.

2. Compose a view — 그 identity 에 부여된 docset과 경로만 마운트합니다.

3. Explore — 해당 하위 시각에 순수한 Go 함수로 구현된 셸 명령을 사용하거나, 그와 동일한 MCP shell 도구를 사용합니다.

4. Contribute safely — 쓰기가 허용된 경우, 전체 파일 변경을 원자적으로 커밋하거나 승인 절차에 제출하기 전에 검사하고 검증합니다.

OAuth 클라이언트는 위임된 정체성을 사용하므로, 영구적인 쓰기 프로세런스(provenance)는 adil의 직접 작업과 adil/claude@claude.ai 아이디로 수행된 작업을 구분합니다. 피위임자(Delegates)는 발행자보다 더 많은 권한을 가질 수 없으며, docset 및 능력 거부 권한으로 범위가 콘텐츠될 수 있습니다. CIMD 클라이언트는 추가로 공급업체 호스팅 메타데이터와 private_key_jwt로 인증할 수 있습니다. 자세한 내용은 Authenticated OAuth Clients를 참조하세요.

일반 셸은 bash, exec, curl 또는 임의의 호스트 프로세스를 실행할 수 없습니다. 임베드된 문서는 항상 읽기 전용입니다. 명시적으로 신뢰되는 identity에는 spawn 능력을 통해 범위가 제한된 비동기 처리를 허용할 수 있습니다.

관리되는 쓰기

OpenLore는 기본적으로 읽기 전용 입니다. 쓰기가 가능한 배포 설정에서는 리다이렉트, 추가모드, tee, patch, sed -i, 파일 이동, 출판, 그리고 승인된 외부 작업을 위해 하나의 정책 제어 쓰기 경로를 유지합니다.

echo "# Research" | publish backend findings.md
cat change.diff | patch /backend/api.md
sed -i 's/old/new/g' /backend/runbook.md

쓰기는 전체 개체 원자 스왑입니다. Compare-and-swap 보호는 낡은 편집을 기본으로 거부하고, docset 승인은 대상을 제한하며, 선택된 경로는 바로 커밋하는 대신 /requests 아래에 검토 가능한 변경 집합을 만들 수 있습니다.

사용자 설정 방법은 Writing and publishing을, 구현 모델은 Write system internals을 참조하세요.

설치

Go로 설치

Go 1.26 또는 그 이후가 필요합니다:

go install github.com/aakarim/go-openlore/cmd/openlore@latest

소스에서 빌드

git clone https://github.com/aakarim/go-openlore.git
cd go-openlore
go build -o openlore ./cmd/openlore

바이너리에 문서 포함

문의를 assets/lore/에 넣고 빌드합니다. 결과 바이너리는 문서를 포함하며, 정의한 디렉터로 실행하면 /docs에서 읽기 전용으로 서빙합니다:

go build -o my-docs ./cmd/openlore

GitHub Action으로 빌드

문서를 포함한 크로스 플랫폼 바이너리를 생성합니다:

- uses: aakarim/openlore@v1
  with:
    docs-dir: ./docs
    config: ./openlore.yml

MCP stdio, MCPB 데스크톱 배포, SSHFS, 그리고 Go 라이브러리 사용법은 Ways to use OpenLore를 참조하세요.

HTTP 인박스에 업로드

docset inbox와 역할 publish 권한을 설정한 후, 기존 identity의 사용자 이름을 만들어 CLI가 검증할 수 있도록 소스 코드가 auth_file을 지정해야 합니다:

openlore inbox token create --identity alice --label webhook --config openlore.yml
curl -H 'Authorization: Bearer olin_ID_SECRET' -H 'Content-Type: text/markdown' \
  --data-binary @note.md 'https://docs.example.com/inbox/docs?name=note.md'

POST /inbox/{docset}는 bearer 자격 증명 또는 정확한 본문의 X-OpenLore-Token-Id와 X-OpenLore-Signature를 사용하는 HMAC 값을 허용합니다. OAuth 액세스 토큰은 POST/GET /inbox/tokens와 DELETE /inbox/tokens/{id} HTTPS で만 사용됩니다. 인박스 자격 증명은 별도이며 취소 가능합니다. 자세한 내용은 Configuration and identity를 확인하세요.

Document

보안

• 명령은 os/exec을 통해 실행되지 않고 순수 Go 언어 인터프리터에서 실행됩니다.

• 가상 파르타 파일 시스템은 경로를 정리하고 docset 경계를 강제합니다.

• 허용 파일 패턴과 허용되지 않는 디렉터리가 시야에서 비밀번호을 차단합니다.

• RBAC로 읽기, 게시, 쓰기, 승인 및 신뢰할 수 있는 능력을 제어합니다.

• 웹엔드포인트는 첫 사용 시 안전하지 않은 신뢰(blind trust)를 피하기 위해 TLS를 통해 SSH 호스트 키를 제공할 수 있습니다; SSH 사용자 및 호스트 인증서도 지원됩니다.

전체 보안 평가는 SECURITY.md를 확인하세요.

License

MIT — Adil Karim

OpenLore는 thirdparty 오픈소스 컴포넌트를 포함합니다. 사용자가 조건과 공지사항은 assets/legal/THIRD_PARTY_NOTICES.md에, 전체 license 텍스트는 assets/legal/licenses/에 있습니다. 이들은 binary에 들어가 실행되는 서비스 HTTP /legal에서 제공됩니다.