CodeKeeper - תיעוד API
אתר זה מספק ממשק לניהול קבצי קוד ומסמכי מארקדאון, לוחות פתקים דביקים, וחיבור MCP המאפשר לסוכן ה-AI לעבוד איתם (לקרוא, לחפש ולכתוב בהם) & בוט טלגרם לגיבוי ריפוזיטורי.
למפתחים ולסוכני AI:
- התחלה מהירה - סוכני AI
- התחלה מהירה - מפתחים
- Quickstart לתרומה
- הנחיות מלאות לסוכני AI
- 🚦 מערכת Rate Limiting לסוכני AI ולווב
- Doc Authoring Guide (Sphinx/RTD)
- Style & Naming Glossary
- Versioning & Stable Anchors
- What’s New
- 2026-11-15
- 2026-11-14
- 2026-11-13
- 2026-11-12
- 2026-11-10
- 2026-11-09
- 2026-11-08
- 2026-11-06
- 2026-11-05
- 2026-11-04
- 2026-11-03
- 2026-10-31
- 2026-10-30
- 2026-10-29
- 2026-10-28
- 2026-10-27
- 2026-10-25
- 2026-10-24
- 2026-10-23
- 2026-10-22
- 2026-10-19
- 2026-10-18
- 2026-10-17
- 2026-10-16
- 2026-10-14
- 2026-10-13
- 2026-10-12
- 2026-10-11
- 2026-10-10
- 2026-10-07
- 2026-10-06
- 2026-10-05
- 2026-10-04
- 2026-10-01
- 2026-09-30
- 2026-09-29
- 2026-09-28
- 2026-09-27
- 2026-09-23
- 2026-09-22
- 2026-09-21
- 2026-09-20
- 2026-09-17
- 2026-09-16
- 2026-09-15
- 2026-09-14
- 2026-09-13
- 2026-09-10
- 2026-09-09
- 2026-09-08
- 2026-09-07
- 2026-09-06
- 2026-09-02
- 2026-09-01
- 2026-08-31
- 2026-08-25
- 2026-08-21
- 2026-01-29
- 2025-12-11
- 2025-11-11
- 2025-11-06
- 2025-11-05
- 2025-10-30
- 2025-10-29
- 2025-10-15
- ארכיטקטורה
- עקרונות להוספת פיצ’ר לסטיקי-נוטס
- עקרונות להוספת פיצ’ר לסטיקי-נוטס — השרת, המסד והחוזים בין השירותים
- היעד: בדיוק אחד, ובשכבה טהורה אחת
- המכסה:
fail-closed, והפטור-לאדמין שהורג מכסות בשקט - אינדקס ייחודי: ממוספר, ונבנה לפני שמפילים
- אכיפה שנבנית רק בצד אחד היא הבטחה שהצד השני מפר בשקט
- זהות לעומת נורמליזציה: אותה פונקציה בשני הקצוות
- יתומים: זיהוי בקריאה, לא בכתיבה
- מצב התזכורת: שדה אחד מתאר, שניים סוטים
- השם של פתק בשורה אחת: פונקציה אחת לפוש, לפעמון ולדשבורד
updated_at: רק כשהתוכן או השם משתנים- איפה הפתק יושב: שורת המיקום ב“פתקים אחרונים“
- הקישור הקבוע של פתק על קובץ: הגרסה האחרונה, בזמן הקריאה
- עדכון בזמן אמת: הבסיס, הפיוס, ו-409 שאינו דורס
- הדגימה: כשל אינו ”אין“, ו-401 אינו כשל
- התוכן: נשמר כמו שנשלח, וה-escape שייך לתצוגה
- העדפה שיש לה גם מצב ”רק במכשיר זה“
- גודל הטקסט בעמוד ההגדרות: מה שמסוכן יושב סביב הבורר
- צבע: מזהה במסד,
hexנגזר, וכינוי במקום מיגרציה - חיפוש בפתקים: למה רג’קס ולא
$text - שרשורי תגובות: השרת
- ארכיון: היעד הרביעי
- נעיצה לעמוד הקבצים: שדה לצד היעד, ולא יעד
- מה לבדוק, ובמה
- עקרונות להוספת פיצ’ר לסטיקי-נוטס — מנוע הרינדור והמארקדאון של הפתק
- המנוע כקובץ משותף:
sticky-md-render.js - רינדור בתצוגה:
innerHTMLאף פעם לא על טקסט לא-מהימן - אינדקס המשימות: התאמה מלאה בין שרת ללקוח
- טבלאות: בלוק רב-שורתי בתוך מנוע של שורה-לשורה
- קינון רשימות: שאלה אחת, מקום אחד, ומקור מדיד
- קוד בשורה: יחידה אחת, שקודמת לכל מפריד
- בלוק קוד: כשצריכה של בלוק שלם מוחקת שלושה סייגים
- בלוקי אלרט: הבלוק הראשון שמכיל שורות אחרות
- ההיסט של לחיצה כשהתוכן מתחלף מתחתיה
- המנוע כקובץ משותף:
- עקרונות להוספת פיצ’ר לסטיקי-נוטס — הממשק בדפדפן: גאומטריה, אינטראקציה וניגודיות
- עיגון שורה בפתקי ריפו: למה
anchoredאינו זמין - פתקי ריפו: המשטח הוא התוכן של הגולל, לא הקונטיינר
- סדר:
flushלפני כל פעולה הרסנית - גודל: מה שנקבע לעומת מה שנכנס
- גודל של פתק חדש, והגיבוי של פתק בלי גודל
- העתקת מזהה הפתק: בשורת השם, והמזהה נקרא ברגע הלחיצה
- תפריט ⋮: הפעולות הנדירות, ומה קובע לאן הוא נפתח
- כלי MD: חלונית בלי מודאל, הסמן שהדפדפן זוכר, ומה מסומן אחרי
- גודל הטקסט: טוקן אחד, ולמה דווקא בפיקסלים
- מקור אחד למחלקה, ומקור אחד לסדר
- חיפוש בתוך פתק: מודול הדגשה אחד, ומה שהפתק מוסיף עליו
- שרשורי תגובות: השרת והממשק בוובאפ
- ההתראה ”יש עדכון חדש לפתק“: פריט flex, הדיו של הפתק, והפוקוס נשאר בתיבה
- ארכיון: המנהל במצב ארכיון, העמוד וחלון השם
- עמוד הקבצים: שורה אחת של כרטיסים, ”+N“, ופס רק כשאין גובה
- מה לבדוק, ובמה
- עיגון שורה בפתקי ריפו: למה
- מדריך תרומה
- Branch Protection & PR Rules
מדריכים בסיסיים:
API Reference:
עזרה ודוגמאות:
- דוגמאות שימוש
- Testing Guide
- 🚀 Quickstart לטסטים
- הנחיות קריטיות
- טעינת Stubs לטלגרם
- דוגמת שימוש ב‑tmp_path
- מחיקה בטוחה
- Mocking HTTP ב‑github_menu_handler
- השהיות של קוד הייצור בטסטים
- רישום Blueprint בסביבת טסטים
- בדיקות מול מונגו אמיתי
- כיסוי בדיקות (pytest-cov)
- CI נתמך
- טסטי Markdown כבדים (
md_heavy) - בדיקות דפדפן, ותקרת הזמן
- Sentry בבדיקות
- מצב שקוד הייצור זוכר בזיכרון התהליך
- ספרייה חסרה בבדיקה
- הקפאת זמן ותהליכוני רקע
- בדיקות ביצועים (Performance)
- קישורים
- דוגמאות טסטים – Rate Limiting ואסינכרוניות
- בדיקות ביצועים (Performance Tests)
- CI/CD Guide
- Conversation Handlers & States
- מצב היועץ (/advisor)
- Troubleshooting Guide
- Development Workflow
- Pre-commit Hooks
- כלי עזר למפתחים
- סקריפטים שימושיים
scripts/cleanup_repo_tags.pyscripts/migrate_reminder_acked_status.pyscripts/dev_seed.py- scripts/import_snippets_from_markdown.py
scripts/measure_md_parse_cost.pyscripts/md_parser_upgrade_zero_diff.py- scripts/migrate_workspace_collections.py
scripts/run_log_aggregator.pyscripts/start_webapp.shscripts/start_with_worker.shscripts/run_all.sh
- בינאום ותמיכה בשפות
- Integrations
- שרת ה-MCP — חיבור Claude ל-CodeKeeper
- מה זה נותן
- ארכיטקטורה בקצרה
- מודל הריצה של הכלים
- הכלים
- תצוגה בתוך Claude — MCP App
- הקבועים, התקרות ואוצר המילים של התשובה
- אימות והרשאות
- תקרת התשובה — מה כלי מצהיר, ומי אוכף
- גבולות הבקשה — גודל הגוף והקצב
- פריימר לסוכן —
GET /api/agent/primer - העלאת תוכן בלי לעבור דרך המודל
- הורדת קובץ לדיסק בלי לעבור דרך המודל
- הפעלה — צעד אחר צעד
- חיבור לקוחות
- דפדפן הריפו — איך זה עובד
- מדידת שימוש (PostHog MCP Analytics)
- מדיניות הפרטיות של המחבר (
/privacy#mcp) - אבטחה — עקרונות
- פתרון תקלות
- סעיפים שעברו לעמודים אחרים
- ראו גם
- שרת ה-MCP — קבצים ופתקים במסד: גרסאות, עקביות ומחזור חיים
- עדכון תיאור בלי גרסה חדשה
- תיאור ארוך בשמירה —
description_saved - גיל התיאור —
description_age_versions - האם זו הגרסה האחרונה —
is_latest - טביעת אצבע לתוכן —
content_sha256ו-content_changed - כמה עריכות בגרסה אחת —
codekeeper_multi_edit_file - קריאת פתק בודד —
codekeeper_get_note - היסטוריית פתקים
- שרשורי תגובות על פתקים —
codekeeper_comment_note - התראה כשסוכן שומר קובץ
- שרת ה-MCP — קריאה, פרסור וחיפוש בתוכן
- ענף שלא במראה, מול קובץ שלא קיים
- איזה קובץ
docs_get_sectionקורא, ובאיזה ריפו - איפה מפת ה-Markdown חולקת על GitHub
- איך
docs_get_sectionמוצא כותרת - מפת סימבולים (
outline) - קריאת טווח שורות
- כמה מופעים יש באמת (
totalמולtotal_at_least) - איך מחפשים קובץ ופתק —
codekeeper_search_codeו-codekeeper_search_notes - חיפוש בתוך קובץ שמור (
query) - קריאה לפי סעיף בקובץ Markdown שמור (
tocו-section) - גודל וספירת שורות ברשימת הריפו
- קריאה קבוצתית —
codekeeper_read_batch
- Repository Integrations
- Security Guide
- Smart Observability v7 – Predictive Health & Adaptive Feedback
- Git LFS Integration
- סימניות (Bookmarks)
- פתקים דביקים (Sticky Notes)
- מהם פתקים דביקים?
- איך מוסיפים ומנהלים פתקים
- עיגון יציב לעומת מיקום קבוע
- שילוב עם סימניות
- מגבלות, פרטיות ואבטחה
- פתק שהשתנה ממקום אחר
- לוחות פתקים
- פתקים על קבצי ריפו
- שרשורי תגובות על פתקים
- ארכיון
- נעיצה בראש עמוד הקבצים
- ”פתקים אחרונים“ בדשבורד
- טיפים שימושיים
- API קצר (למפתחים)
- התראות ותזכורות (Reminders)
- Troubleshooting קצר
- תזכורות בבוט
- האוספים שלי (My Collections)
- שיתוף קוד (חשוב)
- עיון בקוד GitHub (כולל חיפוש בשם קובץ)
- הורדת ריפו
- תכנית בדיקות לבוט – Composition Root (Container) לשירות Snippet
זרימות עבודה:
מנועי המערכת:
- מנועי המערכת (System Engines)
- מנוע חיפוש (Search Engine)
- מנוע רפקטורינג (Refactoring Engine)
- יכולות מתקדמות (Smart Clustering, Cycle Guard)
- מצב שכבות (Layered Mode)
- Safe Decomposition ל‑models.py (פיצול בטוח לחבילת models/)
- מעבד קוד (Code Processor)
- מנוע ניתוח (Code Analyzer)
- מנוע גיבויים (Backup Service)
- מנוע אינטגרציות (Integration Services)
- מנוע Observability
- קישורים
Edge Cases וטיפול בשגיאות:
הערה
חלק מהפיצ’רים (Bookmarks, Collections, Sticky Notes) זמינים ב‑WebApp בלבד (לא בבוט). ראו המיני Web App (סקירה) לפרטים נוספים.
איכות וקונבנציות:
WebApp:
- המיני Web App (סקירה)
- דפדפן קוד (Code Browser)
- ממשקי משתמשים (Web)
- גלריית צילומי המסך (
/gallery) - העורך הציבורי (
/markdown-editor) - ייצוא HTML מעוצב מעמוד הקובץ
- ספריית סניפטים (Web)
- Caching & HTTP Validators (ETag / Last-Modified / 304)
- מערכת Caching מתקדמת עם TTL דינמי
- Cache Inspector (לוח בקרה של Redis)
- Config Inspector (סקירת משתני סביבה)
- MCP Analytics (מדידת השימוש בכלי ה-MCP)
- Static Performance & Security Checklist (gzip/br, Cache, SRI)
- תחזוקת קטלוג הפקודות (
commands.json) - חיפוש גלובלי — סוגי החיפוש
- הרצת קוד (Code Execution Playground)
- WebApp API Reference
- Bulk actions (בחירה מרובה)
- ⌨️ עורך קוד (WebApp Editor)
- Markdown – מצב מצומצם (קיפול כותרות ###) – אדמין בלבד
- מדריך סגנונות וארכיטקטורת Markdown
- Smooth Scrolling (WebApp) — מדריך תמציתי לסוכני AI
- מודולים פנימיים ב-WebApp
activity_tracker.py– דגימת פעילות משתמשיםcommunity_library_api.py– REST עבור אוסף הקהילהcommunity_library_ui.py– תצוגת Websnippet_library_api.pyו-snippet_library_ui.pypush_api.py– Web Push Subscriptionsworkspace_api.py– ניהול Kanban (Workspaces)config_radar.py– רנטגן קונפיגורציה- איך להשתמש בעמוד זה
Frontend > Theming
Observability
- אובזרווביליות (Observability)
- Background Jobs Monitor
- 📡 Observability Dashboard & API
- Query Performance Profiler
- 🧠 Quick Fix חכם (Queue Delay + עומס/DB) – הנחיות למפתחים ולסוכני AI
- Asyncio תחת WSGI: הרצת קורוטינות בבטחה
- Visual Rule Engine - מנוע כללים ויזואלי
- Coverage Report (Runbooks / Quick Fixes)
- 🧠 Observability AI Explain API
- Rate Limiting
- 📊 הנחיות Observability ואירועים
- סכמת לוגים
- מדדים (Metrics)
- Resilience לשירותים חיצוניים
- התראות (Alerts)
- התראות מבוססות לוגים (Log‑based Alerts)
- מה זה ולמה
- הרכיבים בקוד
- קבצי קונפיג
- Option B – חיבור בתוך הקוד (מומש)
- Option A – Sidecar מזרם לוגים
- ספים וקיבוץ – ברירות מחדל
- אסטרטגיית fingerprint וקנוניקליזציה
- צ’קליסט למפתחים
- בדיקה מקומית (סימולציה)
- הנחיות לסוכני AI
- אבטחה ופרטיות
- Rollout מומלץ
- Troubleshooting
- ראו גם
- קישורים לקוד
- טקסונומיית שגיאות וחתימות
- תצוגה ב‑ChatOps
- קריאת המשך –
classify_error()
- מנוע ניתוח לוגים (Log Event Aggregator)
- Sentry
- Incident Checklist (On‑Call)
- שינוי רמות לוגים
- GitHub Backup & Restore Runbook
- Runbooks – SLO Incidents
פריסה ו-Workers
ChatOps
- ChatOps – סקירה כללית
- פקודות ChatOps
- כרטיסיות חיפוש (Ctrl/Cmd+K)
- /status
- /health
- /uptime
- /system_info
- /check commands
- /metrics
- /observe
- /observe -v (מפורט)
- /observe -vv (מפורט מאוד)
- /errors
- /alerts
- /jobs
- /incidents
- /triage
- /predict
- /accuracy
- /rate_limit
- /enable_backoff
- /disable_backoff
- /sen
- /lang
- /lang_debug
- /dm
- /ban
- /unban
- /blocked
- /silence
- /unsilence
- /silences
- /cache_stats
- /clear_cache
- /cache_warm
- /cache_clear_stale
- /debug_cache
- /status_worker
- /version_history
- ChatOps – /observe: הרחבות -v ו- -vv
- הגבלת קצב לפקודות רגישות
- Playbooks – תרחישים נפוצים
- הרשאות ו-Rate Limit
- פתרון תקלות (FAQ)
- שאלות נפוצות
Observability – Advanced
סקירה כללית
CodeKeeper הוא אתר לניהול קוד & בוט טלגרם המאפשרים:
💾 שמירה וניהול של קטעי קוד
🔍 חיפוש מתקדם בקוד
🎨 הדגשת תחביר לשפות תכנות מרובות
📊 סטטיסטיקות שימוש מפורטות
🔗 אינטגרציה עם GitHub
📦 גיבוי ושחזור נתונים
🔐 אבטחה והצפנה
📑 סימניות ואוספים - ארגון מתקדם של הקוד
📝 פתקים דביקים - הערות ויזואליות
⏰ תזכורות - ניהול זמן ומשימות
תכונות עיקריות
- ניהול קוד:
שמירת קטעי קוד עם מטא-דאטה
תמיכה בשפות תכנות מרובות
הדגשת תחביר אוטומטית
חיפוש וסינון מתקדם
- אינטגרציות:
העלאה ל-GitHub Gist
ייצוא לפורמטים שונים
שיתוף קוד בקלות
- כלי ניהול:
גיבוי אוטומטי
סטטיסטיקות שימוש
ניהול משתמשים
- ארגון וניהול אישי:
סימניות (Bookmarks) - סימון נקודות חשובות בקוד
אוספים (Collections) - ארגון קבצים לפי נושאים
פתקים דביקים (Sticky Notes) - הערות ויזואליות על הקוד
מועדפים (Favorites) - סימון קבצים חשובים
תזכורות (Reminders) - תזכורות זמן משימות
התחלה מהירה
from main import create_application
from config import config
# יצירת אפליקציית הבוט
app = create_application(config.BOT_TOKEN)
# הפעלת הבוט
app.run_polling()
דרישות מערכת
Python — גרסת המינימום והסיבה לה: התקנה והגדרה
MongoDB — גרסת המינימום והסיבה לה: התקנה והגדרה
Telegram Bot API Token
Redis (אופציונלי, לקאש)