OpenLore

📜 OpenLore

สนับสนุนโดย

ให้บริการเอกสารของคุณแก่เอเจนต์ AI ผ่าน SSH

OpenLore คือฐานความรู้แบบเอเจนต์เนทีฟที่เรียบง่ายและขยายได้ ซึ่งช่วยให้บริบทที่ใช้ร่วมกันเป็นปัจจุบันและตรวจสอบได้

---

เกี่ยวกับ

เอเจนต์เขียนโค้ด AI รู้วิธีสำรวจไฟล์ด้วย ls, cat, grep, find, ไพพ์ และลูปเชลล์อยู่แล้ว OpenLore มอบอินเทอร์เฟซเดียวกันนั้นผ่าน SSH โดยมีเอกสารของคุณเป็นแบ็กเอนด์แทนเครื่องจริง

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

มันเริ่มต้นเป็นเซิร์ฟเวอร์เอกสารแบบอ่านอย่างเดียว ไบนารีเดียว ไม่ต้องตั้งค่าใดๆ เมื่อ คุณต้องการฐานความรู้แบบสด คุณสามารถเพิ่มการเข้าถึงตามตัวตน การเผยแพร่แบบควบคุม การเขียนแบบอะตอมมิก การตรวจสอบความถูกต้อง และการอนุมัติโดยมนุษย์ โดยไม่ต้องเปลี่ยนวิธีที่เอเจนต์อ่านหรือนำทางเนื้อหา

จัดเก็บและดึงข้อมูล Markdown

ใส่เอกสาร คู่มือปฏิบัติงาน บริบทโปรเจกต์ หรือบันทึกที่เขียนโดยเอเจนต์ใน ไฟล์ Markdown ทั่วไป ไม่มีไปป์ไลน์การนำเข้า: ชี้ OpenLore ไปที่ ไดเรกทอรีแล้วมันจะให้บริการลำดับชั้นที่มีอยู่โดยตรง จัดระเบียบเอกสาร ด้วยโฟลเดอร์ เชื่อมต่อด้วยลิงก์ Markdown มาตรฐาน และจัดกลุ่มเป็น ชุดเอกสารเมื่อบุคคลหรือเอเจนต์ต่างกันต้องการการเข้าถึงต่างกัน OpenLore เป็นแบบอ่านอย่างเดียวโดยค่าเริ่มต้น; เปิดใช้งานการเขียนเมื่อคุณต้องการให้เอเจนต์สร้างและอัปเดต Markdown ด้วย

เริ่มต้นอย่างรวดเร็ว

เส้นทางที่เร็วที่สุดคือให้เอเจนต์ของคุณตั้งค่า 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 บน localhost:2222
• มุมมองเว็บสำหรับมนุษย์บน http://localhost:8080
• MCP ผ่าน HTTP บน http://localhost:8080/mcp

ดู การติดตั้ง สำหรับวิธีติดตั้งและแพ็กเกจ OpenLore เพิ่มเติม

คุณสมบัติ

• การดึงข้อมูลแบบเอเจนต์เนทีฟ — เอเจนต์ใช้เครื่องมือเชลล์และรูปแบบ การประกอบที่เข้าใจอยู่แล้วแทนที่จะเรียนรู้ API การดึงข้อมูลเฉพาะทาง
• พื้นผิวความรู้เดียว หลายช่องทาง — ให้บริการระบบไฟล์เสมือนเดียวกัน ผ่าน SSH, SFTP/SSHFS, MCP และมุมมองเว็บที่ใช้งานง่ายสำหรับมนุษย์
• ความรู้สดและมีการกำกับ — เก็บเนื้อหาแบบอ่านอย่างเดียว อนุญาตการเผยแพร่แบบจำกัดขอบเขต หรือเปิดใช้งานการเขียนเต็มรูปแบบต่อชุดเอกสาร การเขียนเป็นแบบอะตอมมิก รับรู้ความขัดแย้ง และสามารถ ต้องมีการอนุมัติจากมนุษย์
• มุมมองตามตัวตน — ให้แต่ละบุคคลหรือเอเจนต์เฉพาะชุดเอกสารที่ ต้องการ พร้อมสิทธิ์ตามบทบาท ro, publish, และ rw, นามแฝงเส้นทาง และ ไดเรกทอรีบ้านส่วนตัว
• ปลอดภัยโดยการออกแบบ — เชลล์เป็นอินเทอร์พรีเตอร์ Go ในหน่วยความจำ ไม่ใช่ เชลล์ระบบปฏิบัติการจริง ไม่มีการหลบหนีจากเชลล์ การรันกระบวนการตามอำเภอใจ หรือการเข้าถึงเครือข่ายโดยรอบในเซสชันปกติ
• ชุดความรู้แบบพกพา — ฝังเอกสารลงในไบนารีแบบครบวงจร สร้างชุดข้ามแพลตฟอร์มด้วย GitHub Action หรือแพ็กเกจเป็น ส่วนขยาย MCP สำหรับเดสก์ท็อป
• ความรู้แบบมีโครงสร้างโดยไม่ต้องใช้ภาษาคิวรีใหม่ — ตรวจสอบ frontmatter เป็น NDJSON ด้วย lore meta, คิวรีด้วย jq, และตรวจสอบความถูกต้องของ Open Knowledge Format (OKF) ของ Google และ Agent Skills ใกล้กับเส้นทางการเขียน
• นโยบายและการประมวลผลที่ขยายได้ — ปลั๊กอินสามารถเพิ่มการตรวจสอบความถูกต้อง สิทธิ์ มิดเดิลแวร์อ่าน/เขียน เมทาดาทา และการประมวลผลหลังคอมมิต ขณะที่รักษา อินเทอร์เฟซระบบไฟล์เดียวกัน

กรณีการใช้งาน

• คลังการเรียนรู้ต่อเนื่อง — เก็บเซสชันและบทเรียนในเซิร์ฟเวอร์ร่วมหนึ่งเครื่อง เพิ่มเมตริกเพื่อให้คุณปรับให้เหมาะสม อนุญาตให้เอเจนต์แบ่งปันบทเรียนระหว่างกันขณะรักษาการแยกผู้ใช้
• คลังสิ่งประดิษฐ์ของทีม — แบ่งปันเอกสาร markdown, HTML, JSON, Excel ฯลฯ ที่คุณสร้างขึ้นขณะรักษาการควบคุมการเข้าถึง เป็นธรรมชาติกว่า git มาก และเป็นเอเจนต์เนทีฟมากกว่า Confluence/Notion
• เอกสารสำหรับเอเจนต์เขียนโค้ด — ใส่เอกสาร API ภายใน คู่มือปฏิบัติงาน บริบทผลิตภัณฑ์ และบันทึกสถาปัตยกรรมไว้เบื้องหลังอินเทอร์เฟซที่คุ้นเคยและค้นหาได้
• ความทรงจำสดร่วมสำหรับทีมเอเจนต์ — ให้เอเจนต์มีชุดเอกสารแยกหรือร่วม เพื่อให้พวกเขาสามารถเผยแพร่ผลการค้นพบ ส่งต่องาน และสะสมบริบทที่ยั่งยืน ข้ามเซสชัน
• เว็บไซต์เอกสารสาธารณะ — เพิ่มไฟล์ใดๆ ลงในชุดเอกสารสาธารณะของคุณ เปิดใช้งานการเข้าถึงสาธารณะแล้วมันจะแสดงแก่เอเจนต์ใดก็ตามที่พบเว็บไซต์ของคุณ ปรับปรุง AEO/GEO โดยไม่ต้องแก้ไขเอกสารที่มีอยู่
• การแบ่งปันทักษะ — เผยแพร่ Agent Skills ลงในคอลเล็กชันร่วมเพื่อให้ เอเจนต์ที่ได้รับอนุญาตทุกตัวสามารถค้นพบและใช้ขั้นตอนการกำกับเดียวกัน
• คลังปลั๊กอินเอเจนต์ — ปักหมุดเวอร์ชัน Agent Plugins จาก GitHub และให้บริการแก่เอเจนต์ของทีมของคุณ ทักษะที่แพ็กเกจในมาตรฐานเปิดจะอัปเดตโดยอัตโนมัติ
• การมีส่วนร่วมความรู้แบบมีการกำกับ — ให้ผู้มีส่วนร่วมเผยแพร่ลงในกล่องขาเข้า ขณะที่สงวนเส้นทางที่ละเอียดอ่อนสำหรับผู้อนุมัติและป้องกันการเขียนทับโดยไม่ตั้งใจ
• การตรวจสอบสิ่งประดิษฐ์ของเอเจนต์ระยะไกล — เปิดเผยรายงาน โลกรายงาน ภาพหน้าจอ และ ไฟล์ที่สร้างขึ้นผ่านเบราว์เซอร์หรือ SSH โดยไม่ต้องสร้างตัวแสดงสิ่งประดิษฐ์แบบกำหนดเอง หรือให้การเข้าถึงเครื่องของเอเจนต์
• พื้นที่ทำงานเฉพาะตัวตน — เมานต์บ้านส่วนตัวสำหรับแต่ละเอเจนต์บวก ความรู้ทีมร่วม ทั้งหมดผ่านเซิร์ฟเวอร์เดียวและโมเดลการอนุญาตเดียว
• ความรู้ลูกค้าหรือโปรเจกต์แบบพกพา — ส่งไฟล์ปฏิบัติการแบบมีเวอร์ชันพร้อม เอกสารที่เกี่ยวข้องฝังอยู่ หรือแจกจ่ายความรู้เดียวกันเป็นส่วนขยายเดสก์ท็อป MCPB
• แคตตาล็อกความรู้ที่ตรวจสอบแล้ว — บังคับใช้ข้อกำหนด frontmatter และชุดรวม ตรวจสอบเมทาดาทาอย่างมีประสิทธิภาพ และหยุดความรู้ที่ผิดรูปแบบ ณ เวลาที่รับเข้า

วิธีการทำงาน

OpenLore สร้างบน Wish สำหรับการส่งผ่าน SSH การเชื่อมต่อถูกจัดการทั้งหมดกับระบบไฟล์เสมือน:

1. ตรวจสอบสิทธิ์ — เชื่อมต่อแบบไม่ต้องใช้คีย์หรือแก้ไขคีย์ SSH ใบรับรอง passkey หรือการเข้าสู่ระบบ OAuth เป็นตัวตน
2. ประกอบมุมมอง — เมานต์เฉพาะชุดเอกสารและเส้นทางที่ได้รับอนุญาตสำหรับตัวตนนั้น
3. สำรวจ — รันคำสั่งเชลล์ที่ใช้งานเป็นฟังก์ชัน Go บริสุทธิ์บนมุมมองนั้น หรือใช้เครื่องมือ MCP shell ที่เทียบเท่า
4. มีส่วนร่วมอย่างปลอดภัย — หากเปิดใช้งานการเขียน อนุญาตและตรวจสอบ การเปลี่ยนแปลงทั้งไฟล์ก่อนคอมมิตแบบอะตอมมิกหรือส่งต่อเพื่อการอนุมัติ

ไคลเอ็นต์ OAuth ใช้ตัวตนที่ได้รับมอบหมาย ดังนั้นที่มาของการเขียนที่คงทนจึงแยกแยะ งานโดยตรงโดย adil จากงานที่ดำเนินการเป็น adil/claude@claude.ai ผู้รับมอบ ไม่สามารถสืบทอดอำนาจมากกว่าตัวการและสามารถจำกัดแคบลงได้โดย รายการปฏิเสธชุดเอกสารและความสามารถ ไคลเอ็นต์ CIMD สามารถตรวจสอบสิทธิ์เพิ่มเติม ด้วยเมทาดาทาที่โฮสต์โดยผู้ขายและ private_key_jwt; ดู ไคลเอ็นต์ OAuth ที่ตรวจสอบสิทธิ์แล้ว

เชลล์ปกติไม่สามารถเรียก bash, exec, curl, หรือกระบวนการโฮสต์ตามอำเภอใจ เอกสารที่ฝังอยู่เป็นแบบอ่านอย่างเดียวเสมอ ตัวตนที่เชื่อถืออย่างชัดเจน สามารถได้รับสิทธิ์การประมวลผลแบบอะซิงโครนัสที่จำกัดขอบเขตแคบผ่าน ความสามารถ 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 ปฏิเสธ การแก้ไขที่ล้าสมัยโดยค่าเริ่มต้น สิทธิ์ชุดเอกสารจำกัดเป้าหมาย และเส้นทางที่เลือกสามารถ สร้างชุดการเปลี่ยนแปลงที่ตรวจสอบได้ภายใต้ /requests แทนการคอมมิตโดยตรง

ดู การเขียนและการเผยแพร่ สำหรับการตั้งค่าที่ผู้ใช้เผชิญ และ ภายในระบบการเขียน สำหรับโมเดลการใช้งาน

การติดตั้ง

ติดตั้งด้วย 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

ดู วิธีใช้ OpenLore สำหรับ MCP stdio, การแพ็กเกจเดสก์ท็อป MCPB, SSHFS และการใช้งานไลบรารี Go

สร้างการติดตั้งที่ปรับแต่ง

ใช้ทักษะ setup ที่มาพร้อมกันเพื่อสร้าง <team>-lore, คลังที่ลูกค้าเป็นเจ้าของขนาดเล็ก ที่ประกอบด้วย openlore.yml, Containerfile แบบบางที่ปักหมุดกับ OpenLore รีลีสอย่างเป็นทางการ และสิ่งประดิษฐ์การติดตั้ง มันสร้างเซิร์ฟเวอร์ท้องถิ่นที่ทำงาน และตรวจสอบ HTTP, MCP, SSH ที่ตรวจสอบสิทธิ์แล้ว การเขียน และความคงทนก่อน การติดตั้ง:

ssh openlore.sh setup | amp

คลังที่สร้างขึ้นเก็บนโยบาย lore.json เริ่มต้นและไฟล์ที่มองเห็นผ่าน SSH ภายใต้ .local/ ที่ถูก gitignore การติดตั้งครั้งแรกเริ่มต้นวอลุ่มคงทนว่างเปล่า จากสถานะนั้น openlore.yml ระดับรากยังคงเป็นผู้มีอำนาจ Git/IaC และ ถูกติดตั้งแยกต่างหากไปยัง /var/lib/openlore/config/openlore.yml; มันไม่ได้ถูกฝัง ในอิมเมจ การแก้ไข lore.json และระบบไฟล์บนเซิร์ฟเวอร์ในภายหลังเป็น ผู้มีอำนาจและไม่ถูกเขียนทับโดยการอัปเดตอิมเมจ

คำสั่งคำแนะนำเพิ่มเติมรองรับวงจรชีวิตเต็มรูปแบบ:

• onboarding เพิ่มตัวตน บทบาท บ้าน และโฟลเดอร์เริ่มต้นในเครื่อง;
• deploy เลือก Fly.io, Railway, AWS, Google Cloud, Azure, DigitalOcean หรือ การติดตั้งแบบกำหนดเองและตรวจสอบสัญญาเครือข่าย/ความคงทนร่วม;
• upgrade เตรียมเฉพาะการเปลี่ยนแปลงเวอร์ชันอิมเมจฐานที่ปักหมุดเพื่อให้ CD ที่มีอยู่ สามารถติดตั้งได้

การติดตั้งผู้ให้บริการต้องใช้ HTTPS/MCP, OpenLore SSH ที่ตรวจสอบสิทธิ์แล้ว การเข้าถึงเชลล์ผู้ดูแลระบบ และวอลุ่ม /var/lib/openlore ที่คงทน ที่ไหน ที่ผู้ให้บริการรองรับ การติดตั้งกำหนดค่าพอร์ตสาธารณะ 22 เพื่อส่งต่อไปยัง พอร์ต OpenLore 2222 มิฉะนั้นมันรายงานพอร์ตที่กำหนดและแนะนำ ระบบส่งต่อ TCP ภายนอก

คอนเทนเนอร์ที่เผยแพร่มีเฉพาะ OpenLore มันจงใจไม่มี นโยบายการเริ่มต้นหรือการกำหนดค่าเซิร์ฟเวอร์ ก่อนที่บริการจะเริ่ม การติดตั้งต้องวาง openlore.yml และ lore.json ในไดเรกทอรีการกำหนดค่าคงทน และรัน:

./out --config /var/lib/openlore/config/openlore.yml

สิ่งนี้ทำให้การกำหนดค่าสามารถติดตั้งได้อย่างอิสระ: การติดตั้งง่ายสามารถ คัดลอก openlore.yml ลงบนวอลุ่ม ในขณะที่ Kubernetes สามารถฉายไฟล์เดียวกัน จาก ConfigMap ใช้ทักษะ deploy สำหรับ Fly.io, Railway, AWS, Google Cloud, Azure, DigitalOcean หรือโครงสร้างพื้นฐานแบบกำหนดเอง ไฟล์ Railpack และ Fly ของคลังให้อิมเมจ วอลุ่มคงทน และการเชื่อมต่อพอร์ต; พวกมันไม่ได้ เพาะหรือกลายพันธุ์การกำหนดค่าที่กระบวนการเริ่มต้น

Railway กำหนดพร็อกซี TCP SSH เป็นโฮสต์เนมและพอร์ตสาธารณะ SSH มาตรฐาน พอร์ต 22 ต้องใช้ตัวปรับสมดุลโหลด TCP ดิบภายนอก Fly.io สามารถแมปพอร์ตสาธารณะ 22 ไปยัง พอร์ตภายใน 2222 ของ OpenLore ด้วยที่อยู่เฉพาะ SSH ดิบไม่มีโฮสต์เนม หรือการกำหนดเส้นทาง SNI ดังนั้นตัวฟังหนึ่งตัวไม่สามารถกำหนดเส้นทางหลายโดเมนบนพอร์ต 22

เวิร์กโฟลว์คอนเทนเนอร์เผยแพร่ latest จาก main; รีลีสยังเผยแพร่ VERSION, vVERSION, major และ minor image tags

การอัปโหลดกล่องขาเข้าผ่าน HTTP

กำหนดค่าชุดเอกสาร inbox และบทบาทที่มีสิทธิ์ publish จากนั้นสร้าง ข้อมูลประจำตัวสำหรับตัวตนที่มีอยู่ (การกำหนดค่าเซิร์ฟเวอร์ต้องระบุชื่อ auth_file เพื่อให้ CLI สามารถตรวจสอบได้):

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 หรือ HMAC เนื้อหาที่แน่นอนโดยใช้ X-OpenLore-Token-Id และ X-OpenLore-Signature โทเค็นการเข้าถึง OAuth ถูกใช้ เฉพาะสำหรับ POST/GET /inbox/tokens และ DELETE /inbox/tokens/{id}; ข้อมูลประจำตัวกล่องขาเข้า แยกต่างหากและเพิกถอนได้ ดู การกำหนดค่าและตัวตน

เอกสาร

คู่มือ	เนื้อหา
วิธีใช้ OpenLore	SSH, MCP, เว็บ, SSHFS, ไบนารีแบบฝัง, GitHub Action, MCPB และการใช้งานไลบรารี
เอกสารอ้างอิงคำสั่ง	เชลล์, การตรวจสอบภายใน, การเผยแพร่, ไวยากรณ์, คำสั่ง CLI และเอกสารอ้างอิงแฟล็กที่สมบูรณ์
การกำหนดค่าและข้อมูลประจำตัว	openlore.yml, การรับรองความถูกต้อง, บทบาท, ชุดเอกสาร, นามแฝง, โฮม และการตรวจสอบโฮสต์
การรวมข้อมูลประจำตัวของเวิร์กโหลด	รับรองความถูกต้อง CI และเอเจนต์ด้วยโทเค็นข้อมูลประจำตัวภายนอกที่มีอายุสั้น
การเขียนและการเผยแพร่	โหมดการเขียน, กล่องขาเข้า, การจัดการข้อขัดแย้ง, การอนุมัติ และงาน
ปลั๊กอินและรูปแบบความรู้	การติดตั้งปลั๊กอิน, อินเทอร์เฟซ, การตรวจสอบ OKF, lore validate และ lore meta
ระบบภายในของการเขียน	การแบ่งชั้นระบบไฟล์, ตะเข็บการเขียน, ชุดการเปลี่ยนแปลง, ฮุค และงานแบบอะซิงโครนัส
การประเมินความปลอดภัย	โมเดลภัยคุกคามและคุณสมบัติด้านความปลอดภัย

ความปลอดภัย

• คำสั่งทำงานในอินเทอร์พรีเตอร์แบบ Go บริสุทธิ์ ไม่ผ่าน os/exec
• ระบบไฟล์เสมือนทำความสะอาดเส้นทางและบังคับขอบเขตชุดเอกสาร
• รูปแบบไฟล์ที่อนุญาตและไดเรกทอรีที่ถูกละเว้นช่วยกันความลับออกจากมุมมอง
• RBAC ควบคุมการอ่าน, การเผยแพร่, การเขียน, การอนุมัติ และความสามารถที่เชื่อถือได้
• ปลายทางเว็บสามารถเผยแพร่คีย์โฮสต์ SSH ผ่าน TLS เพื่อหลีกเลี่ยงการไว้วางใจแบบไม่เห็นหน้าในการใช้งานครั้งแรก; ใบรับรองผู้ใช้และโฮสต์ SSH ก็รองรับเช่นกัน

ดู SECURITY.md สำหรับการประเมินความปลอดภัยฉบับเต็ม

ใบอนุญาต

MIT — Adil Karim

OpenLore รวมส่วนประกอบโอเพนซอร์สจากบุคคลที่สาม ใบอนุญาตและประกาศที่จำเป็นของพวกเขาอยู่ใน assets/legal/THIRD_PARTY_NOTICES.md พร้อมข้อความใบอนุญาตฉบับเต็มใน assets/legal/licenses/ สิ่งเหล่านี้ถูกฝังในไบนารีและให้บริการโดยบริการที่ทำงานอยู่ที่ /legal