תיעוד

הגדרה עם עוזר ה־AI שלכם

מדריך הפעולות שבו עוקב העוזר שלכם אחר ההנחיות כדי להכין את מאגרי הקוד, לספק לכם גישה ל־CoRoid ולוודא שכל פרויקט יכול להידרש ולהיבדק.

דף זה הוא מדריך פעולות שנכתב עבור עוזר AI: Claude Code, Codex, Cursor, או כל עוזר שיכול לקרוא דף אינטרנט ולעבוד באופן אידיאלי על עותק מקומי של מאגר הקוד שלכם. המדריך מכוון את העוזר להגדיר את CoRoid עבור מאגר קוד אחד או יותר. בכל שלב שדורש התערבות אנושית – כגון התחברות, מתן הרשאות, הזנת סיסמה סודית או אישור שינוי – התהליך נעצר עד שתבצעו את הפעולה.

מסרו אותו לעוזר שלכם

פתחו את העוזר שלכם במאגר הקוד שבו אתם רוצים ש־CoRoid יעבוד, ותנו לו את ההנחיה הבאה:

Set up CoRoid for this repository. Follow the runbook at
https://coroid.ai/docs/export/en-US/getting-started/assistant-setup.md
step by step. Ask me before you change anything, and never ask me to paste a
password or token into this chat.

עבור מספר מאגרים, פתחו את העוזר בתיקייה שמכילה את כולם, וציינו אותם בהנחיה. העוזר מבצע את הבדיקה ואת האימות, ומודיע לכם בדיוק מה לעשות בכל שלב שדורש את התערבותכם.

כללי יסוד לעוזר

אתם מגדירים את CoRoid, מפעל תוכנה מאוחסן מסוג AI. לאחר שהפרויקט מוגדר, כל אדם בחברה יכול לתאר משימות בשפה פשוטה, ו־CoRoid יבנה, יבדוק ויערוך אותן לפי התקן של הפרויקט ויפתח בקשת משיכה (pull request) במאגר הקוד של המשתמש. יש לפעול לפי הכללים הבאים:

  1. המשתמש פועל; העוזר מכין. אתם לעולם לא יכולים להירשם, להתחבר, לקבל תנאים, להתקין אפליקציות או להעניק הרשאות בשם המשתמש. ציינו בדיוק מה לעשות ואיפה, וחכו עד שהמשתמש יאשר שזה בוצע.
  2. הימנעו מלהכניס סיסמאות סודיות לשיחה. לעולם אל תבקשו סיסמה, טוקן גישה אישי, מפתח ספק או טוקן MCP. המשתמש מקליד סיסמאות סודיות לתוך פורטל CoRoid או לתוך הממשק שלו. אם סיסמה כזו נדבקת לצ'אט בכל זאת, יש להודיע למשתמש לבטל אותה וליצור חדשה.
  3. שאלו לפני כל שינוי: קבצי התחייבות, ענפים ובקשות משיכה במאגר הקוד של המשתמש, פרויקטים של CoRoid והזמנות.
  4. בדקו כל שלב לפני המעבר לשלב הבא. אם הבדיקה נכשלת, השתמשו בהערות שבאותו שלב, והמשיכו רק לאחר שהיא עוברת או שהמשתמש מחליט לדלג עליה.
  5. התאימו את עצמכם למוצר, לא להנחות שלכם. אם הפורטל מציג משהו שהמדריך הזה אינו מתאר, הודיעו למשתמש מה אתם רואים ופעלו לפי הפורטל. אל תמציאו הגדרות חדשות.
  6. שמרו רישום של תהליך ההגדרה של כל שלב ותוצאתו, לקראת הסוף.

כל שלב מקשר בין הדפים עם הפרטים הרלוונטיים. https://coroid.ai/llms.txt מאנדקס את כל המסמכים.

שלב 1: הסכימו על התוכנית

שאלו את המשתמש את השאלות הבאות יחד, לא אחת אחת בכל פעם:

שאלהמדוע זה חשוב
על אילו מאגרי קוד צריך CoRoid לעבוד?פרויקט אחד לכל מאגר.
GitHub או GitLab? בבעלות אדם או ארגון?קובע כיצד CoRoid מתחבר ומי מאשר את החיבור.
האם CoRoid צריך לפתוח בקשות משיכה (מסונכרן), או לשמור את העבודה בתוך CoRoid בינתיים (מקומי בלבד)?מצב מקומי בלבד לעולם לא כותב למאגר.
האם כבר קיימת ארגון של CoRoid, ועל איזה תוכנית הוא פועל?התוכנית החינמית מאפשרת פרויקט אחד ללא חברים נוספים.
מי נוסף יבצע את הביקורת על העבודה, ובאיזה תפקיד?הזמנת חברים דורשת מנוי Professional.
האם CoRoid צריך להשתמש במפתחות ספק המודלים של הארגון?אופציונלי. מודלים שמופנים דרך CoRoid אינם דורשים מפתחות כאלה.

לאחר מכן חזרו על התוכנית: השלבים הבאים, אלה הדורשים את התערבות המשתמש, והמאגרים שבתחום.

ראו תוכניות ומחירים, מגבלות ומכסות ו־ מסונכרן או מקומי בלבד.

שלב 2: בדקו שכל מאגר בונה ובודק מתוך עותק נקי

זו הפעולה המועילה ביותר שניתן לבצע. כל משימה של CoRoid מתבצעת בסביבת עבודה של לינוקס נקייה וחד‑פעמית: עותק חדש של הקוד, ללא קבצי מטמון וללא התקנות נוספות מעבר לכלי הפיתוח שבתמונה. סוכן שאינו יכול לבנות ולבדוק את הפרויקט אינו יכול לאמת את עבודתו, ומשימותיו ייכשלו באימות מסיבות שאינן קשורות לשינוי.

אם אתם יכולים לעבוד במאגר באופן מקומי, עשו זאת עבור כל אחד מהם:

  1. זהו את השפות, מנהל החבילות, והאם מדובר במונורפו.
  2. מצאו את פקודות ההתקנה, הבנייה והבדיקה ב־README, בתצורת ה־CI ובקבצי המניפסט.
  3. שאלו לפני שאתם מפעילים דברים. לאחר מכן העתיקו את המאגר לתיקייה זמנית ריקה והפעילו שם את ההתקנה, הבנייה והבדיקה ללא הגדרות נוספות. בעותק העבודה של המשתמש יש זיכרונות ו־ .env קבצים שמסתירים בעיות.
  4. רשמו כל דבר שהתהליך דרש ואין בעותק הנקי:
    • שירותים שהבדיקות מצפות להם, כמו מסד נתונים, מטמון או תור
    • שלבים לפני הבדיקות, כמו יצירת קוד, מעברי נתונים או קבצי יסוד
    • משתנים סביבתיים או קובץ .env שאינו מקובץ לקבצי המאגר
    • מאגרי חבילות פרטיים
    • סביבת ריצה שאינה נמצאת ב־ סביבת העוזר

לעולם לא תריצו פקודות שמבצעות פריסה, פרסום או נגיעה בסביבות משותפות. אם סט הבדיקות איטי או קורא לשירותים בתשלום, שאלו את המשתמש ראשית.

דווחו על בדיקת כשירות קצרה לכל מאגר: הפקודות, משך זמן הבדיקה, מה עבר בהצלחה, וכל פער עם תיקון מוצע.

פערתיקון להצעה
הבדיקות זקוקות למסד נתונים או לשירות אחר.קובץ Dockerfile או Compose שמריץ את סט הבדיקות יחד עם השירותים שלו.
נדרש .env קובץ אינו מחויב.הגדרות ברירת מחדל של הבדיקות בקוד, או קובץ תצורת בדיקה מחויב עם ערכים שאינם סודיים.
הבדיקה זקוקה לסוד אמיתי.חקו את התלות בבדיקות. לעולם לא תחויבו סוד.
התלות מגיעות מרישום פרטי.הודיעו למשתמש: CoRoid זקוק לנתוני אישורים כחלק מהגדרות הפרויקט.
הפקודות פועלות רק מתוך תת-תיקיה.רשמו את התיקייה המדויקת ואת מסנן הסביבה.

היעדר סביבת ריצה אינו חוסם: מכלית המכילה את סביבת העבודה פותרת זאת. אם אינכם יכולים לגשת למאגר באופן מקומי, אספו מהמשתמש את המידע הזמין ורשמו שהבדיקה של העתק נקי לא התקיימה.

ראו תצורת בנייה ובדיקה ו תמיכה בשפות וסביבת הסוכנים.

שלב 3: כתבו את ההנחיות שיקראו סוכני CoRoid.

לפני כל משימה, סוכני CoRoid קוראים את קבצי הזיכרון שבמאגר הקוד: AGENTS.md, CLAUDE.md או GEMINI.md בשורש, וכללי Cursor ב .cursor/rules. הפקודות שאישרתם בשלב 2 נמצאות שם.

הציעו AGENTS.md, או תוספת לקיים, שתציין:

  • פקודות ההתקנה, הבנייה והבדיקה, שנבדקו מעתק נקי, והתיקייה שבה יש להריץ אותן.
  • השלבים והשירותים שהבדיקות זקוקות להם.
  • כיצד להריץ את קבוצת הבדיקות הצרה והשימושית ביותר, כמו חבילה אחת או קובץ אחד.
  • כללים וגבולות שהקוד אינו מציג: מודולים קפואים, אזורים שאין לגעת בהם, תלות שאין להוסיף.

השאירו בחוץ את מה שהקוד כבר מציג, ושמרו על קובץ קצר. אם CLAUDE.md או .cursor/rules מכילים את אותן הוראות, שמרו אותן פעם אחת ב AGENTS.md וייבאו אותן מהקובץ האחר באמצעות @AGENTS.md שורה. אם הוא מתאר תהליך עבודה מקומי ב-Git, ראו AGENTS.md עבור כל סוכן.

הציגו למשתמש את ההבדלים. עם אישורו, בצעו את ההתחייבות בענף חדש ופתחו pull request, או השאירו זאת לו כדי שיבצע אותה. היא חייבת להגיע לענף הבסיס לפני המשימה הראשונה, מכיוון שכל משימה קוראת את קבצי הזיכרון מהעתק שלה מאותו ענף. טפלו בתיקונים משלב 2 שאושרו על ידי המשתמש באותו אופן.

ראו הגדרות הקשר של הפרויקט ו הקשר הפרויקט.

שלב 4: חשבון וארגון (המשתמש)

דלגו על שלב זה אם המשתמש כבר שייך לארגון של CoRoid כבעלים או מנהל.

בקשו מהמשתמש ל:

  1. להירשם ב https://client.coroid.ai/auth/signup עם כתובת האימייל של העבודה שלו, ולאשר את הכתובת.
  2. לקבל את תנאי השימוש
  3. ליצור את הארגון

בדקו: שהמשתמש יכול לפתוח https://client.coroid.ai/projects. האדם שמבצע הגדרה זו זקוק לתפקיד בעלים או מנהל, מכיוון שרק תפקידים אלו יכולים לחבר בקרת קוד ולהוסיף מפתחות ספק.

ראו צרו את החשבון והארגון שלכם.

שלב 5: חיבור בקרת קוד (המשתמש)

עברו עם המשתמש על דרישות הגישה לפני שהוא מתחיל. התקנה שנעצרת באמצע בגלל צורך באישור של אדם אחר היא הסיבה הנפוצה ששלב זה נמשך יום במקום דקה.

GitHub

המשתמש פותח הגדרות → חיבורים → בקרת קוד מקור (https://client.coroid.ai/settings/connections/source-control).

אפשרותהשתמשו בה כאשרמה שהמשתמש זקוק לו ב-GitHub
GitHub App (מומלץ)כמעט תמידהרשאה להתקין אפליקציות בחשבון או בארגון שבבעלותו המאגרים. בארגון זו בדרך כלל תפקיד של בעלים; חברים אחרים יכולים לבקש את ההתקנה כדי שבעלים יאשר אותה.
טוקן גישה אישיהאפליקציה זקוקה לאישור שהמשתמש אינו יכול לקבל.טוקן קלאסי עם ה repo טווח, או טוקן מדויק עם קריאה וכתיבה על תוכן ו בקשות משיכה עבור המאגרים שנבחרו.
חיבור באמצעות כתובת URL, ללא חיבורמאגר ציבורי, נוסה ב מקומי בלבדשום דבר

GitHub App: במסך ההתקנה של GitHub, המשתמש בוחר בחר רק מאגרי קוד ובוחר את האפשרויות שהוסכמו בשלב 1. האפליקציה ממשיכה לפעול גם כשהאדם שהתקין אותה עוזב, מקבלת אירועי Webhook ואחראית לפרסום בדיקות של CoRoid על בקשות משיכה. טוקן אינו יכול לפרסם בדיקות של GitHub.

טוקן גישה אישי: המשתמש יוצר אותו ב־GitHub עם תאריך תפוגה, ומדביק אותו לתוך פורטל CoRoid. עדיף להשתמש בטוקן מפורט המגביל אותו למאגרי הקוד שהוסכמו. בקשות המשיכה מיוחסות לבעל הטוקן, והחיבור ייפסק אם אותו אדם יאבד את הגישה.

GitLab

GitLab נמצא בגרסת תצוגה מקדימה פרטית ומופיע רק בחשבונות שבהם הוא מופעל. הוא מתחבר באמצעות טוקן גישה אישי עם ה api טווח. אם GitLab אינו מופיע תחת בקרת קוד מקור, יש להודיע למשתמש ליצור קשר עם CoRoid, ואין לתכנן סביבו.

הגנת ענף

CoRoid פותח בקשות משיכה רגילות, ולכן הגנת ענפים, בדיקות חובה וכללי ביקורת עדיין חלים. מומלץ להשאיר את ההגנה פעילה. אם הכללים דורשים התחייבויות חתומות או בדיקת סטטוס ש־CoRoid אינו יכול לספק, בקשות המשיכה שלו ייפתחו ויישארו לא משולבות. יש להודיע למשתמש ולא לשנות את הכללים.

בדיקה: הספק מוצג כמחובר תחת בקרת קוד מקור. ההוכחה האמיתית מגיעה בשלב 6, כשהמאגרים מופיעים ברשימת הפרויקטים.

ראו חבר את הקוד שלך, GitHub, GitLab ו הגדרות מאגר קוד וענף.

שלב 6: יצירת הפרויקטים (המשתמש)

יש ליצור פרויקט אחד לכל מאגר קוד, ולא שני פרויקטים לאותו מאגר. המשתמש פותח פרויקטים → חדש (https://client.coroid.ai/projects/new) ו, עבור כל מאגר קוד:

  1. בוחר אותו מהספק המחובר, או משתמש ב־ חיבור באמצעות כתובת URL עבור מאגר קוד ציבורי
  2. בוחר את ה מצב מאגר קוד: מסונכרן, כאשר CoRoid מעלה ענפים ופותח בקשות משיכה, או מקומי בלבד, כאשר CoRoid לעולם אינו כותב למאגר הקוד עד שמישהו יבחר התחל סינכרון
  3. בודק את ענף הבסיס
  4. יוצר את הפרויקט

אם הצוות מאחד לענף שונה מענף הבסיס, כגון develop, יש להגדיר את ענף הבסיס בהגדרות המאגר של הפרויקט. ענף בסיס שגוי שולח בקשות משיכה לענף שאיש אינו בודק.

אם מאגר הקוד חסר ברשימה, הסיבה כמעט תמיד היא אחת מהבאות:

  • לא ניתנה לאפליקציית GitHub גישה למאגר הקוד הזה
  • טווח הטוקן צר מכדי לרשום אותו
  • המאגר שייך לארגון אחר מהארגון המחובר

ראו צור את הפרויקט הראשון שלך ו הגדרות מאגר קוד וענף.

שלב 7: בדקו מה מצא CoRoid.

בקש מהמשתמש לפתוח את תצוגת הכלל של כל פרויקט ולקרוא את ה מאגר קוד פרטים וכל מה שרשום תחת סיים הגדרה:

  • מצב ו ענף: המאגר קוד נוצר, על ענף הבסיס שנקבע. אם בתצוגה הכללית נכתב שהמאגר עדיין לא נוצר, המשתמש בוחר ב־ יצירת מאגר קוד.
  • מערך: השפות, המסגרת, מנהל החבילות וכלי הבדיקה ש־CoRoid זיהה. השוו אותם עם בדיקת המוכנות שלכם. אם לאחר הסינכרון הראשון התצורה ריקה או שגויה, המשתמש יכול לסרוק אותה שוב מנקודה זו.
  • סיים הגדרה: פריטים כגון "התלויות לא הותקנו כראוי" מצביעים על אותן בעיות כמו בשלב 2. טפל בהן יחד עם המשתמש.

לאחר מכן המשתמש פותח את ה הגדרות → ידע → הקשר. קובץ הזיכרון משלב 3 חייב להופיע תחת מקורות מאגר קוד ולהיות מופעל. אם הוא מציג יצירה במקום זאת, הקובץ עדיין לא הגיע לענף המחובר.

ראו הגדרות הקשר של הפרויקט ו תצורת בנייה ובדיקה.

שלב 8: הגדרות ארגון (אופציונלי)

שאל את המשתמש אם הוא רוצה להגדיר אחת מהאפשרויות הבאות כעת. לכולן יש ערכי ברירת מחדל תקינים:

  • חברים, תחת הגדרות → חברים: האנשים שיסקרו את בקשות המשיכה, כבעלים, מנהל, חבר או מבקר. מומלץ להגדיר רק מנהלים כאנשים שצריכים לשנות מדיניות ומפתחות ספק. נדרשת רישיון Professional.
  • מפתחות ספק, תחת הגדרות → מפתחות ספק: רק כדי להשתמש בחשבונות ספקי המודלים של הארגון עצמו. המשתמש מזין את המפתח בפורטל. מומלץ להשתמש במפתח מוגבל עם הגבלת הוצאות אצל הספק.
  • הגדרות מארגון אחר: ייצאו חבילת הגדרות לשם ו ייבאו אותה תחת הגדרות → נתונים → ייצוא הגדרות. הסודות נעים כ־ תוויות כתובות, כך שכל needsRebind פריט בתצוגה המקדימה דורש תשומת לב.

ראו יצירת חשבון וארגון משלך, מפתחות ספק ו ייצוא והגירת הגדרות.

שלב 9: התחברו בעצמכם ל־CoRoid (אופציונלי).

אם הלקוח שלכם תומך בשרתי MCP מרוחקים, תוכלו לגשת ל־CoRoid דרך שרת ה־MCP שלו ב־ https://api.coroid.ai/mcp. ההגדרה אינה תלויה בכך, אך היא מאפשרת לכם לבדוק את הפרויקטים בעצמכם ולסייע למשתמש להפעיל עבודה מאוחר יותר.

  1. המשתמש פותח הגדרות → חיבורים → שרת MCP של CoRoid (https://client.coroid.ai/settings/connections/coroid-mcp). אם הוא אינו זמין לארגון שלהם, דלגו על שלב זה.
  2. הגדרת לקוח מציג את הפקודות לפי לקוח. עם OAuth, המשתמש מאשר את הגישה שלכם בדפדפן שלו. עם טוקן גישה אישי, המשתמש יוצר אותו תחת אסימוני גישה ושומר אותו במשתנה סביבה במעטפת שלו. אינכם צריכים לראות את הערך לעולם.
  3. המליצו על הרמת הגישה המינימלית שתפעל: mcp.read כדי לבדוק את ההגדרה, בתוספת mcp.work.write רק אם אתם מתכוונים ליצור משימות. הגבילו את הטוקן לפרויקטים אלו, קבעו לו תאריך תפוגה, והגדירו מדיניות אוטומציה לפני שכל לקוח מפעיל פעולות אוטומטיות.

בדיקה: קראו list_projects, ואז get_project עבור כל פרויקט משלב 6, ואשרו את מאגר הנתונים ואת הענף.

השתמשו רק ב־ api.coroid.ai עבור MCP. שם המארח של פורטל הלקוח אינו מספק זאת.

ראו CoRoid כשרת MCP..

שלב 10: נסו לנסח משימה ראשונה

סיימו בניסוח משימה ראשונה קטנה עם המשתמש באחד מהפרויקטים החדשים. משימה ראשונה טובה היא אמיתית, קטנה, קרובה למבחנים קיימים, ויש לה קו סיום ברור. הימנעו מאימות, תשלומים, העברות נתונים, ניקויים ללא סוף, וכל דבר שדורש החלטת עיצוב שאיש עדיין לא קיבל.

תארו את התוצאה, לא את היישום: מה צריך להיות נכון כשה עבודה תושלם, אילו קבצים רלוונטיים, ומה לא לגעת בו. המשתמש שולח אותה מ־ עבודה חדשה (https://client.coroid.ai/work/new), קורא את המפרט, ומאשר את התוכנית. הפעלת עבודה משתמשת בשעות סוכן, ותוכנית החינם כוללת 2 ליום UTC, כך שהמשתמש יחליט מתי היא תתבצע.

ראו הפעילו את המשימה הראשונה שלכם ו מפרטים.

שלב 11: מסרו את השליטה

מסרו למשתמש את רשימת ההגדרות:

  • כל מאגר נתונים, הפרויקט שלו, מצב מאגר הנתונים וענף הבסיס
  • כיצד בקרת המקור מחוברת, ומי בעל הקשר: מתקין האפליקציה, או בעל הטוקן ותאריך תפוגתו
  • לפי מאגר נתונים, הפערים שתוקנו, אלו שעדיין תלויים (כגון בקשת משיכה פתוחה עם AGENTS.md), ואלו שהמשתמש בחר להשאיר
  • ההגדרות האופציונליות שבוצעו ודולגו, והמשימה הראשונה שנוסחה

לאחר מכן הפנו את המשתמש ל־ סקירה ואיחוד התוצאה לגבי מה מגיע עם ה־pull request הראשון.

הבא

יצירת חשבון וארגון משלך — אותה הגדרה, שבוצעה ידנית.