📘 תיעוד 50
תיעוד הגדרות
קובץ זה מגיע יחד עם ה-CLI ומחולץ אל ~/.grok/docs/user-guide/26-config-reference.md בעת ההפעלה. זוהי רשימת השדות המלאה עבור config.toml, managed_config.toml ו-requirements.toml. להנחיות מושגיות, ראו 05-configuration.md.
#כיצד להגדיר
שלושה קבצים מגדירים את Grok Build, והם נכתבים על ידי אנשים שונים.
| קובץ | מי כותב אותו | היכן הוא נמצא | השתמש בו כדי |
|---|
config.toml | המפתח | ~/.grok/config.toml, וכן .grok/config.toml בתוך פרויקט | להגדיר ערכי ברירת מחדל אישיים. כל דבר כאן ניתן לשינוי על ידי האדם שמשתמש במכונה. |
managed_config.toml | אתם, דרך המסוף או כלי פריסה | /etc/grok/managed_config.toml | לספק נקודת התחלה לצי מכונות. הקובץ של המפתח עצמו דורס אותו. |
requirements.toml | אתם, חתום | /etc/grok/requirements.toml, או ניהול מכשירים של macOS | לקבוע ערכים שמפתח אינו יכול לשנות. מפתחות המסומנים ב-pin להלן תקפים מול כל קובץ אחר, מול הסביבה ומול שורת הפקודה. |
בחרו ב-managed_config.toml עבור ערכי ברירת מחדל שאתם רוצים שאנשים יוכלו להתאים, וב-requirements.toml עבור אלה שאינכם רוצים שיתאימו.
Grok Build קורא גם את השכבות הבאות, כאשר שורות מאוחרות יותר מנצחות למעט במקרים שבהם נעילת requirements מסוג pin או עמודת Managed מציינות אחרת.
- ערכי ברירת מחדל מהודרים.
/etc/grok/managed_config.toml, לאחר מכן $GROK_HOME/managed_config.toml (ערכי ברירת מחדל לצי מכונות, מסונכרנים דרך המסוף).
$GROK_HOME/config.toml (ההגדרות שלכם, הפקודה /settings כותבת לכאן). ברירת המחדל של $GROK_HOME היא ~/.grok.
- קובץ
.grok/config.toml של הפרויקט: רק [mcp_servers], [plugins], [permission] ו-[mcp] max_output_bytes.
GROK_CONFIG (קוד JSON מוטבע) או GROK_CONFIG_PATH (קובץ JSON או TOML). מפתחות המאושרים ברשימת היתרים בלבד.
$GROK_HOME/requirements.toml, לאחר מכן /etc/grok/requirements.toml, לאחר מכן macOS MDM של ai.x.grok. שכבת מנהל מערכת. מפתחות המסומנים ב-pin בטבלה אינם ניתנים לדריסה, מפתחות המסומנים ב-yes תקפים גם הם בקובץ זה.
- משתני סביבה של
GROK_*.
- דגלי CLI כגון
--model, --sandbox, --yolo.
הריצו grok inspect או grok inspect --json כדי לראות אילו קבצים וערכים ניצחו.
#config.toml
הגדרה ברמת המשתמש נמצאת ב-$GROK_HOME/config.toml (ברירת מחדל ~/.grok/config.toml, וב-Windows הנתיב %USERPROFILE%\.grok\config.toml). דריסות ברמת הפרויקט נמצאות ב-.grok/config.toml ותורמות רק את [mcp_servers], [plugins], [permission] ו-[mcp] max_output_bytes.
העמודה Requirements מציינת האם ניתן להגדיר את אותו מפתח ב-requirements.toml: הערך pin אינו ניתן לדריסה (כולל משתני סביבה ו-CLI כאשר המפענח מכבד את הנעילה), הערך yes מתקבל בקובץ זה, והסימון - מציין שאינו נקרא מ-requirements.toml. העמודה Managed מציינת האם ערך צי המכונות ב-managed_config.toml נשאר בתוקף (fleet) או שקובץ המשתמש מנצח (user).
#agent
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
agent.definition | string (path) | yes | user | נתיב לקובץ markdown של הגדרת סוכן עם YAML frontmatter. |
agent.name | string | yes | user | שם מובנה או מזוהה של הגדרת סוכן. כמו כן GROK_AGENT ו---agent-profile. |
agent.system_prompt_label | string | yes | user | זהות system prompt גלובלית, דריסה לכל מודל מנצחת. |
#announcements
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
announcements | array of tables | - | user | מטעני הודעות מרוחקות הנצרכים בעת הטעינה. אינה טבלה שנכתבת על ידי משתמש. |
#auth
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
auth | table | yes | user | כינוי של [grok_com_config], כל מפתח grok_com_config.* פועל גם כ-auth.*. |
auth.auth_provider_command | string | yes | user | קובץ בינארי חיצוני לאימות, פלט ה-stdout הוא הטוקן. כמו כן GROK_AUTH_PROVIDER_COMMAND, תקף גם כ-grok_com_config.auth_provider_command. |
auth.auth_provider_label | string | yes | user | תווית כפתור התחברות עבור ספק אימות חיצוני. כמו כן GROK_AUTH_PROVIDER_LABEL, תקף גם כ-grok_com_config.auth_provider_label. |
auth.auth_token_ttl | number | yes | user | משך חיי הטוקן בשניות עבור ספקים שמחזירים טוקן פשוט. כמו כן GROK_AUTH_TOKEN_TTL, תקף גם כ-grok_com_config.auth_token_ttl. |
auth.disable_api_key_auth | boolean | pin | user | סירוב לאימות באמצעות מפתח API כך שרק ה-IdP של הפריסה יכול להתחבר. כמו כן GROK_DISABLE_API_KEY_AUTH, תקף גם כ-grok_com_config.disable_api_key_auth. |
auth.force_login_team_uuid | string / string[] | pin | user | דרישת התחברות ל-UUID זה של צוות, או לכל אחד מתוך מערך, מערך ריק נכשל במצב סגור. כמו כן GROK_FORCE_LOGIN_TEAM_ID, תקף גם כ-grok_com_config.force_login_team_uuid. |
auth.grok_ws_origin | string | yes | user | מקור ה-Websocket עבור grok.com. כמו כן GROK_WS_ORIGIN, תקף גם כ-grok_com_config.grok_ws_origin. |
auth.grok_ws_url | string | yes | user | כתובת URL של Relay websocket. כמו כן GROK_WS_URL, תקף גם כ-grok_com_config.grok_ws_url. |
auth.oauth2 | table | yes | user | ספק OAuth2 המשמש כאשר OIDC ארגוני אינו מוגדר, תקף גם כ-grok_com_config.oauth2. |
auth.oauth2.client_id | string | yes | user | מזהה לקוח של OAuth2. כמו כן GROK_OAUTH2_CLIENT_ID, תקף גם כ-grok_com_config.oauth2.client_id. |
auth.oauth2.issuer | string | yes | user | כתובת URL של מנפיק OAuth2. כמו כן GROK_OAUTH2_ISSUER, תקף גם כ-grok_com_config.oauth2.issuer. |
auth.oauth2.principal_id | string | yes | user | מזהה principal נדרש כאשר principal_type מוגדר. כמו כן GROK_OAUTH2_PRINCIPAL_ID, תקף גם כ-grok_com_config.oauth2.principal_id. |
auth.oauth2.principal_type | string | yes | user | סוג principal של הטוקן, כגון Team. כמו כן GROK_OAUTH2_PRINCIPAL_TYPE, תקף גם כ-grok_com_config.oauth2.principal_type. |
auth.oauth2.referrer | string | yes | user | מפנה עבור ייחוס שימוש ב-OAuth. כמו כן GROK_OAUTH2_REFERRER, תקף גם כ-grok_com_config.oauth2.referrer. |
auth.oauth2.scopes | string[] | yes | user | הרשאות של OAuth2. כמו כן GROK_OAUTH2_SCOPES, תקף גם כ-grok_com_config.oauth2.scopes. |
auth.oidc | table | yes | user | הגדרות ספק זהות OIDC של הלקוח, תקף גם כ-grok_com_config.oidc. |
auth.oidc.audience | string | yes | user | קהל יעד אופציונלי של OIDC. כמו כן GROK_OIDC_AUDIENCE, תקף גם כ-grok_com_config.oidc.audience. |
auth.oidc.client_id | string | yes | user | מזהה לקוח של OIDC. כמו כן GROK_OIDC_CLIENT_ID, תקף גם כ-grok_com_config.oidc.client_id. |
auth.oidc.issuer | string | yes | user | כתובת URL של מנפיק OIDC. כמו כן GROK_OIDC_ISSUER, תקף גם כ-grok_com_config.oidc.issuer. |
auth.oidc.scopes | string[] | yes | user | הרשאות של OIDC. כמו כן GROK_OIDC_SCOPES, תקף גם כ-grok_com_config.oidc.scopes. |
auth.preferred_method | api_key / oidc | yes | user | נעילת אימות אוטומטי לשיטה אחת ללא מעבר לנתיב חלופי, תקף גם כ-grok_com_config.preferred_method. |
auth.token_header | string | yes | user | שם הכותרת שנושאת את טוקן האימות של ה-CLI, ברירת מחדל xai-grok-cli, תקף גם כ-grok_com_config.token_header. |
#auth_provider
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
auth_provider.<name> | table | yes | user | כלי עזר בעל שם לפרטי זיהוי המשמש את [model.<id>] auth_provider. |
#auto_mode
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
auto_mode.enabled | boolean | yes | user | הפעלת מצב הרשאות Auto. |
#campaigns
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
campaigns | array of tables | yes | user | טלאי קמפיין בעלי שם המוחלים מתחת ל-requirements. הפריסה מפרסמת אותם. |
#cli
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
cli.auto_update | boolean | pin | user | בדיקת עדכוני CLI בעת ההפעלה. כמו כן GROK_DISABLE_AUTOUPDATER כדי לבטל. |
cli.channel | stable / alpha | pin | user | העדפת ערוץ שחרור. |
cli.grove_worktree | boolean or grove / grove-fuse / grove-nfs / nfs / copy / true / false / 1 / 0 / on / off | yes | user | בחירת Grove לעומת copy עבור הפעלה או -w. ברירת מחדל copy. נבדל מ-cli.worktree_type של מצב יצירה. כמו כן GROK_WORKTREE_TYPE. סדר שכבות: request, לאחר מכן env, לאחר מכן local, לאחר מכן remote-true, ולאחר מכן ביטול בסוף: remote שבו grove_worktree = false גורם ל-copy (remote_kill), הגדרות remote חסרות גורמות ל-copy (remote_unavailable). אינו מאפשר grok clone. |
cli.installer | string | - | user | איזה מתקין הגדיר לאחרונה CLI זה, משמש לבחירת נתיב העדכון. |
cli.maximum_version | string | pin | user | גרסת ה-CLI הגבוהה ביותר שעדיין רצה ללא חסימה קשיחה. כמו כן GROK_MAXIMUM_VERSION. |
cli.minimum_version | string | pin | user | גרסת ה-CLI הנמוכה ביותר שעדיין רצה ללא חסימה קשיחה. כמו כן GROK_MINIMUM_VERSION. |
cli.npm_registry | string | yes | user | מאגר npm המשמש את מעדכן הגרסאות האוטומטי. |
cli.nfs_worktree | אותו הדבר כמו cli.grove_worktree | yes | user | כינוי קריאה של cli.grove_worktree. |
cli.required_maximum_version | string | pin | user | גרסת מקסימום קשיחה של ה-CLI. כמו כן GROK_REQUIRED_MAXIMUM_VERSION. |
cli.required_minimum_version | string | pin | user | גרסת מינימום קשיחה של ה-CLI. כמו כן GROK_REQUIRED_MINIMUM_VERSION. |
cli.session_picker_grouped | boolean | yes | user | קיבוץ הפעלות לפי מאגר קוד בבורר וברשימות ה-CLI. |
cli.session_registry | boolean | yes | user | השתתפות במרשם הפעלות חוצה תהליכים. |
cli.show_tips | boolean | pin | user | טיפים בעת ההפעלה. |
cli.use_leader | boolean | pin | user | שימוש בתהליך מוביל עבור טעינה מחדש של הגדרות ומעקב MCP. |
cli.worktree_type | string | yes | user | מצב יצירה כאשר מוגדר ל-linked, standalone או git. האיותים grove, grove-fuse, grove-nfs, nfs ו-copy מזינים גם את שער ה-Grove של session או -w (בדומה ל-cli.grove_worktree), הם אינם ערכים של מצב יצירה. |
#compat
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
compat.claude.agents | boolean | yes | user | סריקת CLAUDE.md. כמו כן GROK_CLAUDE_AGENTS_ENABLED. |
compat.claude.hooks | boolean | yes | user | סריקת hooks של Claude. כמו כן GROK_CLAUDE_HOOKS_ENABLED. |
compat.claude.mcps | boolean | yes | user | סריקת הגדרות MCP של Claude. כמו כן GROK_CLAUDE_MCPS_ENABLED. |
compat.claude.rules | boolean | yes | user | סריקת כללי Claude. כמו כן GROK_CLAUDE_RULES_ENABLED. |
compat.claude.skills | boolean | yes | user | סריקת מיומנויות Claude. כמו כן GROK_CLAUDE_SKILLS_ENABLED. |
compat.codex.hooks | boolean | yes | user | סריקת hooks של Codex כאשר הם קיימים. |
compat.codex.skills | boolean | yes | user | סריקת ספריות מיומנויות של Codex כאשר הן קיימות. |
compat.cursor.agents | boolean | yes | user | סריקת הגדרות סוכן ממקורות תאימות של Cursor. כמו כן GROK_CURSOR_AGENTS_ENABLED. |
compat.cursor.hooks | boolean | yes | user | סריקת hooks של Cursor. כמו כן GROK_CURSOR_HOOKS_ENABLED. |
compat.cursor.mcps | boolean | yes | user | סריקת mcp.json של Cursor. כמו כן GROK_CURSOR_MCPS_ENABLED. |
compat.cursor.rules | boolean | yes | user | סריקת .cursor/rules/. כמו כן GROK_CURSOR_RULES_ENABLED. |
compat.cursor.skills | boolean | yes | user | סריקת ספריות מיומנויות של Cursor. כמו כן GROK_CURSOR_SKILLS_ENABLED. |
#dashboard
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
dashboard.enabled | boolean | yes | user | הצגת לוח המחוונים של הסוכן. |
dashboard.grouping | state / directory | yes | user | כיצד מתקבצות שורות לוח המחוונים. |
#default_auto_mode
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
default_auto_mode | boolean | yes | user | התחלת הפעלות במצב הרשאות auto כאשר לא הוגדרה דריסה עבור ההפעלה. |
#diagnostics
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
diagnostics.crash_handler | boolean | yes | user | כתיבת דוח קריסה תחת $GROK_HOME/crash/. כמו כן GROK_CRASH_HANDLER. |
#disable_web_search
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
disable_web_search | boolean | yes | user | הסרת הכלי web_search עבור תהליך זה. כמו כן --disable-web-search. |
#disabled_mcp_servers
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
disabled_mcp_servers | string[] | yes | user | שמות שרתי MCP שיש לדלג עליהם מבלי למחוק את בלוקי ה-[mcp_servers] שלהם. |
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
disabled_mcp_tools | map<string, string[]> | yes | user | רשימות דחייה של כלי MCP לכל שרת, עם מפתח לפי שם השרת. |
#doom_loop_recovery
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
doom_loop_recovery.enabled | boolean | yes | user | דגימה מחדש של לולאות קריאות כלים בעלות ביטחון גבוה, הגדירו false כדי להשבית. |
#endpoints
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
endpoints.cli_chat_proxy_base_url | string | pin | user | כתובת URL בסיסית של ה-API לשירות הפעלות. |
endpoints.deployment_key | string | pin | user | מפתח ניהול עבור פריסות ארגוניות. כמו כן GROK_DEPLOYMENT_KEY. |
endpoints.feedback_base_url | string | yes | user | לאן נשלחים משובים. כמו כן GROK_FEEDBACK_BASE_URL. |
endpoints.managed_config_url | string | yes | user | דריסת נקודת הקצה של הגדרות מנוהלות. כמו כן GROK_MANAGED_CONFIG_URL. |
endpoints.models_base_url | string | pin | user | כתובת URL בסיסית מותאמת אישית להסקה. כמו כן GROK_MODELS_BASE_URL. |
endpoints.models_list_url | string | pin | user | דריסת כתובת ה-URL של רשימת המודלים. כמו כן GROK_MODELS_LIST_URL. כינוי models_endpoint. |
endpoints.trace_upload_bucket | string | yes | user | דלי gs:// או s3:// ישיר עבור עקבות, עוקף את הפרוקסי. כמו כן GROK_TRACE_UPLOAD_BUCKET. |
endpoints.trace_upload_credentials | string | yes | user | קוד JSON מוטבע של חשבון שירות GCS או פרטי גישה של AWS עבור אותו דלי, גובר על trace_upload_credentials_file ואינו כולל משתנה סביבה. |
endpoints.trace_upload_credentials_file | string (path) | yes | user | נתיב לקובץ JSON של חשבון שירות GCS או קובץ פרטי גישה של AWS עבור אותו דלי. כמו כן GROK_TRACE_UPLOAD_CREDENTIALS_FILE. |
endpoints.trace_upload_endpoint_url | string | yes | user | נקודת קצה מותאמת אישית תואמת S3 עבור העלאות לדלי s3://. כמו כן GROK_TRACE_UPLOAD_ENDPOINT_URL. |
endpoints.trace_upload_region | string | yes | user | אזור AWS עבור העלאות לדלי s3://, ברירת מחדל us-east-1. כמו כן GROK_TRACE_UPLOAD_REGION. |
endpoints.trace_upload_url | string | pin | user | יעד הפרוקסי עבור עקבות כאשר לא הוגדר דלי ישיר. כמו כן GROK_TRACE_UPLOAD_URL. |
endpoints.xai_api_base_url | string | pin | user | בסיס ה-API הציבורי של xAI. כמו כן GROK_XAI_API_BASE_URL. |
#features
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
features.active_agent_messages | boolean | pin | user | הפעלה או השבתה של active_agent_messages. ברירת מחדל false. כמו כן GROK_ACTIVE_AGENT_MESSAGES. |
features.ask_user_question | boolean | pin | user | הפעלה או השבתה של ask_user_question. ברירת מחדל true. כמו כן GROK_ASK_USER_QUESTION. |
features.auto_wake | boolean | pin | user | הפעלה או השבתה של auto_wake. ברירת מחדל true. כמו כן GROK_AUTO_WAKE. |
features.backend_tools | boolean | pin | user | הפעלה או השבתה של backend_tools. ברירת מחדל true. כמו כן GROK_BACKEND_SEARCH. |
features.campaigns | boolean | yes | user | הפעלת טלאי קמפיין מרוחקים. ההגדרה GROK_CAMPAIGNS=0 עדיין משביתה גם כאשר הגדרות requirements קובעות true. |
features.cancel_rewind | boolean | pin | user | הפעלה או השבתה של cancel_rewind. ברירת מחדל true. כמו כן GROK_CANCEL_REWIND. |
features.codebase_indexing | boolean / string[] | pin | user | יצירת אינדקס גרף של בסיס הקוד, ערך true יוצר אינדקס למאגרי git, או שניתן להעביר תבניות glob להכללה או החרגה. |
features.compaction_detail | none / minimal / balanced / verbose | yes | user | רמת פירוט מילה במילה עבור דחיסת segments. כמו כן GROK_COMPACTION_DETAIL. |
features.compaction_mode | summary / transcript / segments | yes | user | אסטרטגיית דחיסה. כמו כן GROK_COMPACTION_MODE. |
features.compaction_tool_choice | string | yes | user | רמז לבחירת כלי המשמש במהלך דחיסה. |
features.compaction_verbatim_input | boolean | pin | user | הפעלה או השבתה של compaction_verbatim_input. ברירת מחדל true. כמו כן GROK_COMPACTION_VERBATIM_INPUT. |
features.dock | boolean | pin | user | הפעלה או השבתה של dock. ברירת מחדל false. כמו כן GROK_DOCK. |
features.feedback | boolean | pin | user | הפעלה או השבתה של feedback. ברירת מחדל true. כמו כן GROK_FEEDBACK_ENABLED. |
features.feedback_trace_card | boolean | pin | user | הצגת שאלת הסכמה להעלאת עקבות לאחר /feedback. ברירת מחדל false. כמו כן GROK_FEEDBACK_TRACE_CARD. |
features.image_edit_model_override | string | yes | user | מזהה מודל Imagine עבור image_edit. |
features.image_gen | boolean | pin | user | הפעלת image_gen או /imagine. |
features.image_gen_model_override | string | yes | user | מזהה מודל Imagine עבור image_gen. ערך ריק משאיר את ברירת המחדל שהוגדרה מרחוק. |
features.lsp_tools | boolean | pin | user | הפעלה או השבתה של lsp_tools. ברירת מחדל false. כמו כן GROK_LSP_TOOLS. |
features.managed_config | boolean | yes | user | אחזור managed_config.toml ו-requirements.toml מהפריסה. |
features.mcp_auto_restart | boolean | yes | user | הפעלה מחדש אוטומטית של שרתי stdio MCP לאחר כשל בתעבורה. כמו כן GROK_MCP_AUTO_RESTART. |
features.mcp_liveness_watchers | boolean | yes | user | תשאול ערוצי תעבורת MCP ודחיפת עדכוני server_status. משמש כמתג השבתת חירום כאשר הערך false. |
features.mcp_push_server_status | boolean | yes | user | ה-pager נרשם לדחיפת server_status של MCP. משתנה סביבת התהליך GROK_MCP_PUSH_SERVER_STATUS מנצח בעת ההפעלה. |
features.mcp_recursive_config_watch | boolean | yes | user | מעקב אחר <cwd>/ ו-<cwd>/.grok/ עבור שינויי הגדרות MCP בפרויקט. השם מטעה, המעקב אינו רקורסיבי. |
features.non_git_warning | boolean | yes | user | הצגת אזהרה חוסמת כאשר Grok מתחיל מחוץ למאגר Git. |
features.remember_mode | boolean | - | - | זכירת מצב ההרשאות האחרון בין הפעלות. נקרא אך ורק מ-config.toml של המשתמש. |
features.remote_fetch | boolean | pin | fleet | נעילת אחזור מרחוק של קטלוג מודלים ונכסים. ערך מנוהל מנצח את קובץ המשתמש כאשר שניהם מוגדרים. |
features.repo_status_in_system_prompt | boolean | pin | user | הפעלה או השבתה של repo_status_in_system_prompt. ברירת מחדל true. כמו כן GROK_REPO_STATUS_IN_SYSTEM_PROMPT. |
features.session_recap | boolean | pin | user | הפעלה או השבתה של session_recap. ברירת מחדל true. כמו כן GROK_SESSION_RECAP. |
features.session_search | boolean | pin | user | הפעלה או השבתה של session_search. ברירת מחדל true. כמו כן GROK_SESSION_SEARCH. |
features.subagent_worktree_snapshot | boolean | pin | user | הפעלה או השבתה של subagent_worktree_snapshot. ברירת מחדל false. כמו כן GROK_SUBAGENT_WORKTREE_SNAPSHOT. |
features.support_permission | boolean | yes | user | מתן אפשרות לסוכן לבקש הרשאה להרצת כלים. |
features.telemetry | boolean / session_metrics / off | pin | user | מצב טלמטריה של המוצר. ברירת המחדל בארגונים היא off. |
features.terminal_theme | boolean | pin | user | חשיפת ערכת הנושא terminal המותאמת לטרמינל במהלך השקתה. ברירת מחדל false. כמו כן GROK_TERMINAL_THEME. |
features.title_refresh | boolean | pin | user | רענון כותרת אוטומטי בתחילת ההפעלה. נעלו זאת ב-requirements כדי לנצח את GROK_TITLE_REFRESH. |
features.turn_summary | boolean | pin | user | הפעלה או השבתה של turn_summary. ברירת מחדל true. כמו כן GROK_TURN_SUMMARY. |
features.two_pass_compaction | boolean | pin | user | הפעלה או השבתה של two_pass_compaction. ברירת מחדל true. כמו כן GROK_TWO_PASS_COMPACTION. |
features.video_gen | boolean | pin | user | הפעלת כלי וידאו או /imagine-video. |
features.voice_mode | boolean | pin | user | הפעלה או השבתה של voice_mode. ברירת מחדל true. כמו כן GROK_VOICE_MODE. |
features.web_fetch | boolean | pin | user | הפעלה או השבתה של web_fetch. ברירת מחדל false. כמו כן GROK_WEB_FETCH. |
features.write_file | boolean | pin | user | הפעלה או השבתה של write_file. ברירת מחדל true. כמו כן GROK_WRITE_FILE. |
features.zdr_access_enabled | boolean | pin | user | פרסום כלים שאינם תואמים ל-ZDR כאשר הצוות מוגדר עם Zero Data Retention. כמו כן GROK_ZDR_ACCESS_ENABLED. |
#feedback
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
feedback.user.command | string | yes | user | פקודת מעטפת המדפיסה שם ואימייל ב-JSON עבור הגשות משוב. |
feedback.user.email | string[] | yes | user | מקורות עבור אימייל מחבר המשוב (git_email או ערך מילולי). |
feedback.user.name | string[] | yes | user | מקורות עבור שם מחבר המשוב (os_user או ערך מילולי). |
#goal
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
goal.enabled | boolean | yes | user | הפעלת /goal. |
#grok_com_config
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
grok_com_config | table | yes | user | הגדרות websocket ו-OAuth/OIDC של Grok.com. הטבלה [auth] היא כינוי. |
grok_com_config.auth_provider_command | string | yes | user | קובץ בינארי חיצוני לאימות, פלט ה-stdout הוא הטוקן. כמו כן GROK_AUTH_PROVIDER_COMMAND. |
grok_com_config.auth_provider_label | string | yes | user | תווית כפתור התחברות עבור ספק אימות חיצוני. כמו כן GROK_AUTH_PROVIDER_LABEL. |
grok_com_config.auth_token_ttl | number | yes | user | משך חיי הטוקן בשניות עבור ספקים שמחזירים טוקן פשוט. כמו כן GROK_AUTH_TOKEN_TTL. |
grok_com_config.disable_api_key_auth | boolean | pin | user | סירוב לאימות באמצעות מפתח API כך שרק ה-IdP של הפריסה יכול להתחבר. כמו כן GROK_DISABLE_API_KEY_AUTH. |
grok_com_config.force_login_team_uuid | string / string[] | pin | user | דרישת התחברות ל-UUID זה של צוות, או לכל אחד מתוך מערך, מערך ריק נכשל במצב סגור. כמו כן GROK_FORCE_LOGIN_TEAM_ID. |
grok_com_config.grok_ws_origin | string | yes | user | מקור ה-Websocket עבור grok.com. כמו כן GROK_WS_ORIGIN. |
grok_com_config.grok_ws_url | string | yes | user | כתובת URL של Relay websocket. כמו כן GROK_WS_URL. |
grok_com_config.oauth2 | table | yes | user | ספק OAuth2 המשמש כאשר OIDC ארגוני אינו מוגדר. |
grok_com_config.oauth2.client_id | string | yes | user | מזהה לקוח של OAuth2. כמו כן GROK_OAUTH2_CLIENT_ID. |
grok_com_config.oauth2.issuer | string | yes | user | כתובת URL של מנפיק OAuth2. כמו כן GROK_OAUTH2_ISSUER. |
grok_com_config.oauth2.principal_id | string | yes | user | מזהה principal נדרש כאשר principal_type מוגדר. כמו כן GROK_OAUTH2_PRINCIPAL_ID. |
grok_com_config.oauth2.principal_type | string | yes | user | סוג principal של הטוקן, כגון Team. כמו כן GROK_OAUTH2_PRINCIPAL_TYPE. |
grok_com_config.oauth2.referrer | string | yes | user | מפנה עבור ייחוס שימוש ב-OAuth. כמו כן GROK_OAUTH2_REFERRER. |
grok_com_config.oauth2.scopes | string[] | yes | user | הרשאות של OAuth2. כמו כן GROK_OAUTH2_SCOPES. |
grok_com_config.oidc | table | yes | user | הגדרות ספק זהות OIDC של הלקוח. |
grok_com_config.oidc.audience | string | yes | user | קהל יעד אופציונלי של OIDC. כמו כן GROK_OIDC_AUDIENCE. |
grok_com_config.oidc.client_id | string | yes | user | מזהה לקוח של OIDC. כמו כן GROK_OIDC_CLIENT_ID. |
grok_com_config.oidc.issuer | string | yes | user | כתובת URL של מנפיק OIDC. כמו כן GROK_OIDC_ISSUER. |
grok_com_config.oidc.scopes | string[] | yes | user | הרשאות של OIDC. כמו כן GROK_OIDC_SCOPES. |
grok_com_config.preferred_method | api_key / oidc | yes | user | נעילת אימות אוטומטי לשיטה אחת ללא מעבר לנתיב חלופי. |
grok_com_config.token_header | string | yes | user | שם הכותרת שנושאת את טוקן האימות של ה-CLI, ברירת מחדל xai-grok-cli. |
#harness
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
harness.wait_for_uploads | boolean | yes | user | המתנה להעלאת עקבות בסיום תור לפני החזרת תגובת ההנחיה. כבוי כברירת מחדל, ריצות headless חד-פעמיות מנקזות במקום זאת העלאות ממתינות של סיום תור בעת היציאה במסגרת תקציב מינימום מחייב (כ-150 שניות: חלון הניתוח ועוד ניסיון העלאה אחד) שערך upload_flush_timeout_secs, כאשר הוא גדול יותר, מרחיב אותו. |
harness.disable_workspace_teleport | boolean | pin | user | מתג השבתה עבור תצלומי מצב של סביבת העבודה בכל תור. |
#hints
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
hints.fork_worktree_mode | ask / always / never | yes | user | האם /fork מציע worktree. |
hints.new_session_worktree_mode | ask / always / never | yes | user | האם /new מציע worktree. |
#hooks
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
hooks.<event> | array of tables | yes | user | קבוצות התאמה עבור אירוע מחזור חיים כגון PreToolUse או Stop. ראו Hooks. |
hooks.<event>[].hooks[].command | string | yes | user | פקודה להרצה עבור hook זה. משתנה $VAR אינו מורחב בעת הטעינה. |
hooks.<event>[].hooks[].type | command | yes | user | סוג מטפל ה-hook. נתמכים command hooks. |
hooks.<event>[].matcher | string | yes | user | מתאים שם כלי עבור קבוצת hooks זו. |
#managed_mcps
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
managed_mcps.enabled | boolean | pin | user | אחזור הגדרות MCP מנוהלות בעת ההפעלה. כמו כן GROK_MANAGED_MCPS_ENABLED. |
managed_mcps.gateway_tools_enabled | boolean | yes | user | חשיפת כלי gateway של MCP מנוהלים. כמו כן GROK_MANAGED_MCP_GATEWAY_TOOLS_ENABLED. |
#marketplace
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
marketplace.sources | array of tables | yes | user | מאגרי marketplace של תוספים עבור [[marketplace.sources]]. |
marketplace.require_sha | boolean | yes | user | החמרה בלבד: התקנות ועדכונים של תוספים מרוחקים חייבים לנעול sha מלא של commit. כמו כן GROK_MARKETPLACE_REQUIRE_SHA. לא מפתח זה ולא משתנה הסביבה יכולים לכבות את ההגבלה הזו בחזרה. |
#mcp
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
mcp.max_output_bytes | number | yes | user | הגבלת גודל פלט כלי MCP בבתים. קובצי פרויקט רשאים להגדיר זאת. |
#mcp_servers
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
mcp_servers.<name>.args | string[] | yes | user | מאפיין args של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.bearer_token_env_var | string | yes | user | מאפיין bearer_token_env_var של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.command | string | yes | user | מאפיין command של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.cwd | string | yes | user | מאפיין cwd של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.enabled | boolean | yes | user | מאפיין enabled של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.env | table | yes | user | מאפיין env של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.expose_image_base64 | boolean | yes | user | מאפיין expose_image_base64 של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.headers | table | yes | user | מאפיין headers של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.oauth | table | yes | user | מאפיין oauth של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.oauth_client_id | string | yes | user | מאפיין oauth_client_id של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.oauth_client_secret_env_var | string | yes | user | מאפיין oauth_client_secret_env_var של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.oauth_scopes | string[] | yes | user | מאפיין oauth_scopes של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.setup | table | yes | user | מאפיין setup של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.startup_timeout_sec | number | yes | user | מאפיין startup_timeout_sec של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.tool_timeout_sec | number | yes | user | מאפיין tool_timeout_sec של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.tool_timeouts | table | yes | user | מאפיין tool_timeouts של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.type | string | yes | user | מאפיין type של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
mcp_servers.<name>.url | string | yes | user | מאפיין url של [mcp_servers.<name>] בשרת stdio או HTTP MCP. |
#memory
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
memory.enabled | boolean | pin | user | מתג ראשי של זיכרון בין הפעלות. כמו כן GROK_MEMORY. |
memory.mode | "legacy", "v2" | - | user | בחירת מימוש הזיכרון המתמיד עבור הפעלות חדשות. ברירת מחדל: "legacy". הערך "v2" הוא ניסיוני, נתיבי החיפוש, ה-flush ו-Dream הישנים שלו מושבתים. |
#model
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
model.<id> | table | yes | user | דריסה לכל מודל או הגדרת BYOK. עדיף env_key על פני api_key מוטבע. |
model.<id>.agent_type | string | yes | user | סוג הגדרת סוכן המשויך למודל זה. |
model.<id>.api_backend | chat_completions / responses / messages | yes | user | פרוטוקול תקשורת עבור מודל זה. |
model.<id>.api_base_url | string | yes | user | בסיס API חלופי המשמש עם פענוח XAI_API_KEY. |
model.<id>.api_key | string | yes | user | מפתח API מוטבע. עדיף env_key. אינו סוד שיש לשים במאגר משותף. |
model.<id>.auth_provider | string | yes | user | שם של כלי עזר [auth_provider.<name>] שמנפיק את טוקן ה-bearer של מודל זה. |
model.<id>.auto_compact_threshold_percent | integer | yes | user | סף דחיסה אוטומטית לכל מודל (0 עד 100). |
model.<id>.base_url | string | yes | user | כתובת URL בסיסית של נקודת הקצה של הספק. |
model.<id>.compaction_at_tokens | number / table | yes | user | סף טוקנים המפעיל דחיסה עבור מודל זה. |
model.<id>.compactions_remaining | string / table | yes | user | כיצד נשלח הקשר שנותר מהדחיסה. כינוי send_compactions_remaining. |
model.<id>.context_window | number | yes | user | טוקנים של חלון הקשר, קובע את תזמון הדחיסה האוטומטית. |
model.<id>.description | string | yes | user | תיאור אופציונלי המוצג בבורר. |
model.<id>.env_http_headers | map<string,string> | yes | user | כותרות HTTP המאוכלסות ממשתני סביבה כאשר הם מוגדרים. |
model.<id>.env_key | string / string[] | yes | user | שמות משתני סביבה המחזיקים במפתח ה-API של הספק. |
model.<id>.extra_headers | map<string,string> | yes | user | כותרות לכל בקשה עבור מודל זה. |
model.<id>.hidden | boolean | yes | user | הסתרת מודל זה מהבורר. עדיין ניתן לשימוש באמצעות -m. |
model.<id>.inference_idle_timeout_secs | number | yes | user | פסק זמן לחוסר פעילות עבור הזרמת הסקה במודל זה. |
model.<id>.max_completion_tokens | number | yes | user | כמות מקסימלית של טוקנים להשלמה לכל מודל. |
model.<id>.max_retries | number | yes | user | מספר ניסיונות חוזרים להסקה עבור מודל זה. |
model.<id>.model | string | yes | user | מזהה מודל הנשלח ל-API. |
model.<id>.model_family | string | yes | user | מזהה משפחה המשמש לדחיסה ולקיבוץ יכולות. |
model.<id>.model_provider | string | yes | user | מזהה ספק בעל שם מסוג [model_providers.<name>] עבור מודל זה. |
model.<id>.mtls_cert_dir | string | yes | user | ספרייה המכילה את זהות ה-mTLS של נקודת הקצה של המודל כ-client.crt ו-client.key, או tls.crt ו-tls.key, ההגדרה נדחית אלא אם לאותו מודל יש base_url יחיד של HTTPS וללא api_base_url, ובקשות אינן עוקבות אחר הפניות מחדש. |
model.<id>.name | string | yes | user | תווית המוצגת בבורר המודלים. |
model.<id>.query_params | map<string,string> | yes | user | פרמטרי שאילתה נוספים בבקשות של מודל זה. |
model.<id>.rate_limit_retry_threshold | number | yes | user | תקרת סך כל הניסיונות עבור בקשות שהוגבלו בקצב, מוגבלת על ידי max_retries שפוענח, כאשר היא מוגדרת, היא משביתה את לולאת ההמתנה הנפרדת לשגיאת 429 של סוכן-משנה. |
model.<id>.reasoning_effort | string | yes | user | מאמץ חשיבה לכל מודל (הוצא משימוש, עדיף reasoning_efforts). |
model.<id>.reasoning_efforts | array of tables | yes | user | ערכי מאמץ חשיבה מורשים עבור מודל זה. |
model.<id>.show_model_fingerprint | boolean | yes | user | הצגת טביעת האצבע של מודל הספק בממשק המשתמש כאשר היא קיימת. |
model.<id>.stream_tool_calls | boolean | yes | user | מבנה בקשת הזרמת קריאות לכלים לכל מודל. |
model.<id>.subagent_rate_limit_max_attempts | number | yes | user | מספר ניסיונות מקסימלי בלולאת המתנה לשגיאת 429 של סוכן-משנה כאשר rate_limit_retry_threshold אינו מוגדר, ברירת מחדל 8, מקסימום 32, והערך 0 משבית את לולאת ההמתנה. |
model.<id>.supported_in_api | boolean | yes | user | האם רשומת קטלוג זו מוצעת כמודל API ציבורי. |
model.<id>.supports_backend_search | boolean | yes | user | האם נקודת הקצה תומכת בכלי חיפוש בצד השרת המאוחסנים ב-Grok. |
model.<id>.supports_reasoning_effort | boolean | yes | user | הוצא משימוש, עדיף reasoning_efforts. |
model.<id>.system_prompt_label | string | yes | user | תווית זיהוי של system prompt לכל מודל. |
model.<id>.temperature | number | yes | user | טמפרטורת דגימה לכל מודל. |
model.<id>.top_p | number | yes | user | ערך top_p לכל מודל. |
model.<id>.use_concise | boolean | yes | user | שימוש בחבילת תיאור כלים תמציתית עבור מודל זה. |
#model_providers
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
model_providers.<name> | table | yes | user | הגדרת ספק מודל מותאם אישית בעל שם. |
#models
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
models.agent_type | string | yes | user | ערך agent_type כברירת מחדל עבור מודלים ללא דריסה לכל מודל. |
models.allowed_models | string[] | pin | user | רשימת היתרים עבור בורר המודלים, ברירת המחדל ו--m. רשימה ריקה פירושה שאין הגבלה. |
models.default | string | pin | user | מודל המשמש להפעלות חדשות. כמו כן GROK_DEFAULT_MODEL, --model, -m. |
models.default_reasoning_effort | string | yes | user | מאמץ חשיבה כברירת מחדל עבור מודל ברירת המחדל כאשר המודל תומך בכך. |
models.disabled_models | string[] | yes | user | הסרת מזהי מודלים אלה מהקטלוג. מנצח את hidden_models. |
models.extra_headers | map<string,string> | yes | user | כותרות בקשה המוחלות על כל מודל, מפתחות לכל מודל מנצחים. |
models.hidden_models | string[] | yes | user | הסתרת מזהי מודלים אלה מהבורר, -m עדיין יכול לבחור בהם. |
models.image_description | string | yes | user | מודל ראייה המשמש לתמלול תמונות שסופקו על ידי המשתמש. |
models.inference_idle_timeout_secs | number | yes | user | פסק זמן גלובלי לחוסר פעילות עבור הזרמת הסקה כאשר מודל משאיר זאת לא מוגדר. |
models.max_completion_tokens | number | yes | user | ברירת מחדל גלובלית למקסימום טוקנים להשלמה כאשר מודל משאיר זאת לא מוגדר. |
models.max_retries | number | yes | user | ברירת מחדל גלובלית לניסיונות הסקה חוזרים כאשר מודל משאיר זאת לא מוגדר. |
models.prompt_suggestion | string | yes | user | נעילת מודל עבור טקסט רפאים של ההנחיה הבאה. אם לא מוגדר, עובר להגדרה מרחוק ולאחר מכן למודל ההפעלה. |
models.rate_limit_retry_threshold | number | yes | user | תקרת סך כל הניסיונות הגלובלית לבקשות שהוגבלו בקצב כאשר מודל משאיר זאת לא מוגדר, מוגבלת על ידי max_retries שפוענח, כאשר היא מוגדרת, היא משביתה את לולאת ההמתנה הנפרדת לשגיאת 429 של סוכן-משנה. |
models.session_summary | string | yes | user | מודל המשמש לכותרות ולסיכומי הפעלות. |
models.stream_tool_calls | boolean | yes | user | מבנה בקשת הזרמת קריאות לכלים ברמה גלובלית, נקודות קצה מסוימות של BYOK זקוקות ל-false. |
models.subagent_rate_limit_max_attempts | number | yes | user | ברירת מחדל גלובלית למספר ניסיונות בלולאת המתנה לשגיאת 429 של סוכן-משנה כאשר rate_limit_retry_threshold אינו מוגדר, ברירת מחדל 8, מקסימום 32, והערך 0 משבית את לולאת ההמתנה. |
models.temperature | number | yes | user | ברירת מחדל גלובלית לטמפרטורת דגימה כאשר מודל משאיר זאת לא מוגדר. |
models.top_p | number | yes | user | ברירת מחדל גלובלית ל-top_p כאשר מודל משאיר זאת לא מוגדר. |
models.web_search | string | pin | user | מודל המשמש את כלי הלקוח web_search. כמו כן GROK_WEB_SEARCH_MODEL. |
#path_not_found_hints
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
path_not_found_hints | boolean | yes | user | העשרת שגיאות של נתיב לא נמצא בתזכורות לגבי CWD והצעות לשמות דומים. |
#paths
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
paths.extra_rule_dirs | string[] | yes | user | ספריות כללים נוספות (כל אחת מכילה *.md). |
paths.extra_skill_dirs | string[] | yes | user | ספריות מיומנויות נוספות (כל אחת מכילה <skill>/SKILL.md). |
#permission
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
permission.allow | string[] | yes | user | כללי אישור קומפקטיים כגון Bash(git *). כלל Deny מנצח ask שמנצח allow. קובצי פרויקט רשאים להגדיר זאת. |
permission.ask | string[] | yes | user | כללי בקשת אישור קומפקטיים. קובצי פרויקט רשאים להגדיר זאת. |
permission.deny | string[] | yes | user | כללי דחייה קומפקטיים. קובצי פרויקט רשאים להגדיר זאת. |
permission.rules | array of tables | yes | user | כללי אובייקט מפורטים של פעולה/כלי/תבנית. קובצי פרויקט רשאים להגדיר זאת. |
#plugins
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
plugins.disabled | string[] | yes | user | מזהי תוספים שיש לזהות אך לא לטעון. קובצי פרויקט רשאים להגדיר זאת. |
plugins.enabled | string[] | yes | user | מזהי תוספים להפעלה, נדרש עבור תוספי פרויקט שברירת המחדל שלהם היא כבוי. |
plugins.paths | string[] | yes | user | ספריות תוספים נוספות. קובצי פרויקט רשאים להגדיר זאת כאשר התיקייה מהימנה. |
#privacy
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
privacy.privacy_banner_acked | string | - | - | חותמת זמן RFC 3339 UTC שבה נסגר באנר הפרטיות המקומי. ה-pager קורא אך ורק מ-config.toml של המשתמש. |
#relay
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
relay.enabled | boolean | yes | user | הפעלת סנכרון relay של הפעלות. |
#sandbox
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
sandbox.auto_allow_bash | boolean | pin | user | דילוג על הנחיות אישור הרשאות bash כאשר פרופיל ארגז חול פעיל. כמו כן GROK_SANDBOX_AUTO_ALLOW_BASH. |
sandbox.profile | off / workspace / read-only / strict / string | pin | user | פרופיל ארגז חול למערכת הקבצים. כמו כן --sandbox ו-GROK_SANDBOX. |
#session
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
session.auto_compact_threshold_percent | integer | yes | user | דחיסה אוטומטית כאשר השימוש בהקשר מגיע לאחוז זה (0 עד 100). |
session.load_envrc | boolean | yes | user | הזרקת משתני .envrc לתוך bash. |
#shell_environment_policy
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
shell_environment_policy.exclude | string[] | yes | user | שמות משתני סביבה שיש להסיר מ-bash. ברשימת היתרים לשכבות. |
shell_environment_policy.ignore_default_excludes | boolean | yes | user | דילוג על רשימת הדחייה המובנית של משתני סביבה. ברשימת היתרים לשכבות. |
shell_environment_policy.include_only | string[] | yes | user | אם מוגדר, bash יירש רק את שמות משתני הסביבה הללו. ברשימת היתרים לשכבות. |
shell_environment_policy.inherit | string | yes | user | אילו שמות משתני סביבה של ההורה bash יירש. ברשימת היתרים לשכבות, אינו יכול להזריק ערכים. |
shell_environment_policy.set | map<string,string> | yes | user | הזרקת ערכי משתני סביבה לתוך bash. אינו ברשימת היתרים לשכבות. |
#skills
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
skills.disabled | string[] | yes | user | שמות מיומנויות שיש לזהות אך לא להפעיל. |
skills.paths | string[] | yes | user | ספריות מיומנויות נוספות. |
#storage
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
storage | table | yes | user | מדיניות ניקוי אחסון הפעלות מקומי. |
#subagents
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
subagents.enabled | boolean | pin | user | מתג ראשי של כלי סוכני-משנה / משימות. כמו כן GROK_SUBAGENTS. |
subagents.limit_behavior | queue / fail | yes | user | מה לעשות כאשר מגיעים לתקרת סוכני-המשנה המקבילים. |
subagents.max_concurrent | integer | yes | user | מספר מקסימלי של סוכני-משנה מקבילים. |
subagents.max_depth | integer | yes | user | עומק קינון מקסימלי של סוכני-משנה (מוגבל ל-1 ומעלה). |
subagents.models.<name> | string | yes | user | דריסת מזהה מודל לכל סוכן-משנה. |
subagents.toggle.<name> | boolean | yes | user | הפעלה או השבתה של סוג סוכן-משנה בודד. סוכנים שהושמטו פועלים כברירת מחדל. |
#telemetry
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
telemetry.otel_enabled | boolean | pin | user | מתג ראשי ל-OTEL חיצוני. כמו כן GROK_EXTERNAL_OTEL. |
telemetry.otel_metrics_exporter | otlp / console / none | pin | user | יצואן מדדים של OTEL חיצוני. כמו כן OTEL_METRICS_EXPORTER. |
telemetry.otel_logs_exporter | otlp / console / none | pin | user | יצואן יומנים של OTEL חיצוני. כמו כן OTEL_LOGS_EXPORTER. |
telemetry.otel_endpoint | string | pin | user | נקודת קצה בסיסית של OTLP חיצוני. כמו כן OTEL_EXPORTER_OTLP_ENDPOINT. נעילת pin מסירה משתני סביבה של מפתח והגדרות אחיות מקובצי משתמש/ניהול שאינן ברשימה, למעט אלו שברשימה. |
telemetry.otel_logs_endpoint | string | pin | user | נקודת קצה OTLP לאות יומנים (במדויק). כמו כן OTEL_EXPORTER_OTLP_LOGS_ENDPOINT. |
telemetry.otel_metrics_endpoint | string | pin | user | נקודת קצה OTLP לאות מדדים (במדויק). כמו כן OTEL_EXPORTER_OTLP_METRICS_ENDPOINT. |
telemetry.otel_protocol | http/protobuf / grpc | pin | user | תעבורת OTLP חיצונית. כמו כן OTEL_EXPORTER_OTLP_PROTOCOL. נעילת pin מסירה משתני סביבה של פרוטוקול לכל אות והגדרות אחיות מקובץ שאינן ברשימה, למעט אלו שברשימה. |
telemetry.otel_logs_protocol | http/protobuf / grpc | pin | user | פרוטוקול OTLP לאות יומנים. כמו כן OTEL_EXPORTER_OTLP_LOGS_PROTOCOL. |
telemetry.otel_metrics_protocol | http/protobuf / grpc | pin | user | פרוטוקול OTLP לאות מדדים. כמו כן OTEL_EXPORTER_OTLP_METRICS_PROTOCOL. |
telemetry.otel_timeout | number | pin | user | פסק זמן לייצוא במילישניות. כמו כן OTEL_EXPORTER_OTLP_TIMEOUT. |
telemetry.otel_metric_export_interval | number | pin | user | מרווח ייצוא מדדים במילישניות. כמו כן OTEL_METRIC_EXPORT_INTERVAL. |
telemetry.otel_certificate | string | pin | user | נתיב PEM של תעודות CA נוספות עבור ה-collector. כמו כן OTEL_EXPORTER_OTLP_CERTIFICATE. נעילת CA מסוג pin אינה מסירה נקודות קצה. |
telemetry.otel_logs_certificate | string | pin | user | נתיב PEM של CA לאות יומנים. כמו כן OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE. |
telemetry.otel_metrics_certificate | string | pin | user | נתיב PEM של CA לאות מדדים. כמו כן OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE. |
telemetry.otel_client_certificate | string | pin | user | נתיב PEM של תעודת לקוח mTLS. כמו כן OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE. נעילת pin מסירה עותקי פרטי גישה, נקודות קצה של מפתח והגדרות אחיות מקובץ שאינן ברשימה. |
telemetry.otel_client_key | string | pin | user | נתיב PEM של מפתח לקוח mTLS. טוקנים לעולם אינם נמצאים בקובץ זה. כמו כן OTEL_EXPORTER_OTLP_CLIENT_KEY. |
telemetry.otel_logs_client_certificate | string | pin | user | נתיב PEM של תעודת לקוח mTLS לאות יומנים. כמו כן OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE. |
telemetry.otel_logs_client_key | string | pin | user | נתיב PEM של מפתח לקוח mTLS לאות יומנים. כמו כן OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY. |
telemetry.otel_metrics_client_certificate | string | pin | user | נתיב PEM של תעודת לקוח mTLS לאות מדדים. כמו כן OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE. |
telemetry.otel_metrics_client_key | string | pin | user | נתיב PEM של מפתח לקוח mTLS לאות מדדים. כמו כן OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY. |
telemetry.otel_metrics_include_session_id | boolean | pin | user | הצמדת session.id למדדים. כמו כן OTEL_METRICS_INCLUDE_SESSION_ID. |
telemetry.otel_log_user_prompts | boolean | pin | user | שער תוכן עבור טקסט הנחיה ב-grok_code.user_prompt. כמו כן OTEL_LOG_USER_PROMPTS. נעילת שער תוכן כלשהו מבלי לרשום הגדרה אחות מעבירה כברירת מחדל את ההגדרה האחות שהושמטה למצב כבוי. |
telemetry.otel_log_tool_details | boolean | pin | user | שער מטא-נתונים לתצוגה מקדימה של ארגומנטים לכלים, נתיבים ושמות במדויק. מומלץ להפעיל עבור שילוב עם SIEM. כמו כן OTEL_LOG_TOOL_DETAILS. אינו כולל גופים מלאים. |
telemetry.otel_log_assistant_responses | boolean | pin | user | שער תוכן עבור טקסט ב-grok_code.assistant_response. אם אינו מוגדר, עוקב אחר otel_log_user_prompts אלא אם כן שער אח ננעל ב-requirements. משתנה סביבה בלבד OTEL_LOG_USER_PROMPTS=1 חייב להגדיר זאת ל-0 (או לנעול אותו ל-false) עבור זרם הנחיות בלבד. כמו כן OTEL_LOG_ASSISTANT_RESPONSES. |
telemetry.otel_log_tool_content | boolean | pin | user | שער גוף עבור tool_input, tool_output, full_command ו-error_message. בלתי תלוי בפרטים, ברירת מחדל כבוי. שער CONTENT בלבד מאבד שמות ונתיבים מדויקים של MCP. כמו כן OTEL_LOG_TOOL_CONTENT. |
telemetry.trace_upload | boolean | pin | user | העלאת עקבות הפעלה. נעילת requirements מנצחת הגדרת משתמש. |
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
tools.disable_zdr_incompatible_tools | boolean | yes | user | הגבלת כלים הזקוקים לפלט באירוח xAI תחת ZDR. כמו כן GROK_DISABLE_ZDR_INCOMPATIBLE_TOOLS. |
tools.media_gen.max_parallel_image_gen_calls | integer | yes | user | הגבלת קריאות מקבילות של image_gen/image_edit בשלב מודל יחיד. כמו כן GROK_MAX_PARALLEL_IMAGE_GEN_CALLS. |
tools.media_gen.max_parallel_video_gen_calls | integer | yes | user | הגבלת קריאות מקבילות של video_gen בשלב מודל יחיד. כמו כן GROK_MAX_PARALLEL_VIDEO_GEN_CALLS. |
tools.respect_gitignore | boolean | pin | user | כאשר true, כלי חיפוש וקריאה מדלגים על קבצים שב-gitignore. כמו כן GROK_RESPECT_GITIGNORE. |
tools.zdr_video_output_s3 | table | yes | user | דלי S3 של הצוות עבור פלט וידאו ב-ZDR. ראו ZDR Video Storage. |
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
toolset.ask_user_question.timeout_secs | number | yes | user | פסק זמן עבור הכלי ask_user_question. |
toolset.bash.auto_background_on_timeout | boolean | yes | user | העברת הפקודה לרקע כאשר פסק הזמן של החזית מופעל. |
toolset.bash.login_shell_capture | boolean | yes | user | לכידת סביבת מעטפת הכניסה של המשתמש עבור bash. ברשימת היתרים לשכבות. |
toolset.bash.max_timeout_secs | number | yes | user | תקרה על פסקי זמן בחזית המבוקשים על ידי המודל. |
toolset.bash.output_byte_limit | number | yes | user | כמות מקסימלית של פלט bash שנלכד בבתים. |
toolset.bash.timeout_secs | number | yes | user | פסק זמן לפקודת bash בחזית בשניות. |
toolset.file_toolset | standard / hashline | yes | user | סכמת כלי עריכת קבצים. |
toolset.web_fetch.allowed_domains | string[] | yes | user | דריסת רשימת הדומיינים המורשים עבור web_fetch. |
toolset.web_fetch.proxy_endpoint | string | yes | user | כתובת URL של פרוקסי יציאה עבור web_fetch. כמו כן GROK_WEB_FETCH_PROXY. |
toolset.web_search.allowed_domains | string[] | yes | user | רשימת דומיינים מורשים עבור web_search של הלקוח. ברשימת היתרים לשכבות. |
toolset.web_search.excluded_domains | string[] | yes | user | רשימת דומיינים חסומים עבור web_search של הלקוח. ברשימת היתרים לשכבות. |
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
ui.approval_mode | string | yes | user | הוצא משימוש, השתמשו ב-ui.permission_mode. |
ui.auto_dark_theme | string | yes | user | ערכת נושא כאשר theme = auto ומערכת ההפעלה כהה. |
ui.auto_light_theme | string | yes | user | ערכת נושא כאשר theme = auto ומערכת ההפעלה בהירה. |
ui.cancel_subagents_on_turn_cancel | ask / always_stop / always_continue | yes | user | מה לעשות עם סוכני-משנה פעילים בעת ביטול תור של הורה. |
ui.collapsed_edit_blocks | boolean | yes | user | הצגת עריכות כסיכומי שורה אחת של N/-M+. כמו כן GROK_COLLAPSED_EDIT_BLOCKS. |
ui.combine_queued_prompts | boolean | yes | user | מיזוג הנחיות המשך פשוטות עוקבות לתור יחיד. |
ui.compact_mode | boolean | yes | user | ריווח צפוף יותר של הודעות. כמו כן /compact-mode. |
ui.confirm_before_rewind | boolean | yes | user | בקשת אישור לפני החזרת היסטוריית השיחה לאחור. |
ui.contextual_hints.image_input | boolean | yes | user | טיפ להדבקת תמונה מלוח הגזירים כאשר המודל מקבל תמונות. |
ui.contextual_hints.plan_mode | boolean | yes | user | הצעת מצב תכנון (Shift+Tab) עבור הנחיות בסגנון תכנון. |
ui.contextual_hints.send_now | boolean | yes | user | לאחר הכנסת הנחיית המשך לתור באמצע תור, הקשה על Enter על הנחיה ריקה שולחת מיד. |
ui.contextual_hints.small_screen | boolean | yes | user | הצעת /compact-mode במסופים נמוכים. |
ui.contextual_hints.ssh_wrap | boolean | yes | user | המלצה על grok wrap כאשר ב-SSH חסר יעד לוח גזירים. |
ui.contextual_hints.undo | boolean | yes | user | טיפ ש-Ctrl+Z משחזר טיוטת הנחיה שנמחקה. |
ui.contextual_hints.word_select | boolean | yes | user | לאחר לחיצה כפולה עם בחירת קיפול/ניווט, הפניה אל Word select בהגדרות. |
ui.cursor_blink | boolean | yes | user | כפיית סמן בלוק מהבהב (true) או קבוע (false). אם אינו מוגדר, יורש מהטרמינל. |
ui.default_selected_permission | string | yes | user | שורת אישור שנבחרה מראש בהנחיה הראשונה של הפעלה. כמו כן GROK_DEFAULT_SELECTED_PERMISSION. |
ui.display_refresh.auto_cadence_enabled | boolean | yes | user | התאמת קצב הזרמה/גלילה לקצב רענון התצוגה. כמו כן GROK_DISPLAY_REFRESH_AUTO_CADENCE. |
ui.follow_up_behavior | queue / steer | yes | user | ניתוב הנחיית המשך באמצע תור. |
ui.fork_secondary_model | string | yes | user | מודל עבור הסוכן המשני בעת ביצוע fork. ברירת המחדל היא מודל ברירת המחדל הראשי. |
ui.group_tool_verbs | boolean | yes | user | קיפול שורות כלי קריאה/חיפוש/רישום רצופות. כמו כן GROK_GROUP_TOOL_VERBS. |
ui.hunk_tracker_mode | agent_only / all_dirty / off | yes | user | מעקב אחר מקטעי שינויים בקבצים. כמו כן GROK_HUNK_TRACKER ו---hunk-tracker-mode. |
ui.invert_scroll | boolean | yes | user | היפוך כיוון הגלילה האנכית. כמו כן GROK_INVERT_SCROLL. |
ui.keep_text_selection | flash / hold / word_select | yes | user | בחירה בתוך היישום: הבהוב קצר, השהיה, או בחירת מילה בלחיצה כפולה. |
ui.max_thoughts_width | number | yes | user | רוחב עמודה עבור חלונית המחשבות (40 עד 500). |
ui.mouse_reporting_toggle | boolean | yes | user | הקשה על Ctrl+R בהיסטוריית הגלילה מחליפה מצב לכידת עכבר בטרמינל. כמו כן GROK_MOUSE_REPORTING_TOGGLE. |
ui.page_flip_on_send | boolean | yes | user | הצמדת ההנחיה שנשלחה לחלק העליון של שטח התצוגה. |
ui.permission_mode | default / ask / auto / always-approve | yes | user | התנהגות ברירת מחדל לאישור כלים. נעילות ארגוניות משתמשות ב-requirements.toml. |
ui.prompt_suggestions | boolean | yes | user | טקסט רפאים להנחיה הבאה לאחר כל תור. כמו כן GROK_PROMPT_SUGGESTIONS, מתג השבתה מרוחק יכול להשבית זאת בכל הצי. |
prompt_suggestions.max_output_tokens | number | yes | user | טוקנים של פלט גלוי עבור קריאת ההצעה, מוגבל ל-16 עד 256, ברירת מחדל 64, עם רזרבה נפרדת לחשיבה. ניתן לדריסה מרחוק. |
prompt_suggestions.temperature | number | yes | user | טמפרטורת דגימה עבור קריאת ההצעה (ברירת מחדל 0.2). ניתן לדריסה מרחוק. |
prompt_suggestions.reasoning_effort | none / minimal / low / medium / high | yes | user | מאמץ חשיבה עבור קריאת ההצעה, ברירת המחדל ו-none משביתים חשיבה, בעוד שערכים אחרים משתמשים במאמץ מודל נתמך. ניתן לדריסה מרחוק. |
ui.remember_tool_approvals | boolean | yes | user | הצגת אפשרויות Always allow לכל כלי. כמו כן GROK_REMEMBER_TOOL_APPROVALS. |
ui.render_mermaid | auto / on / off | yes | user | כיצד מרונדרות גדרות mermaid: שורה פתוחה שניתן ללחוץ עליה או קוד מקור גולמי. |
ui.screen_mode | fullscreen / minimal | yes | user | מצב רינדור ברירת מחדל עבור grok רגיל. נדרשת הפעלה מחדש. |
ui.scroll_lines | integer | yes | user | שורות לכל פעימת גלילה (1 עד 10). כמו כן GROK_SCROLL_LINES. |
ui.scroll_mode | auto / wheel / trackpad | yes | user | סיווג קלט גלילה. כמו כן GROK_SCROLL_MODE. |
ui.scroll_speed | integer | yes | user | מכפיל מהירות גלילת עכבר/משטח מגע (1 עד 100). כמו כן GROK_SCROLL_SPEED. |
ui.show_thinking_blocks | boolean | yes | user | הצגת בלוקי חשיבה במהלך הזרמה. כמו כן GROK_SHOW_THINKING_BLOCKS. |
ui.show_timeline | boolean | yes | user | מסילת סימונים לכל תור במקום פס הגלילה. |
ui.show_timestamps | boolean | yes | user | שעת שעון לצד הודעות. כמו כן /timestamps. |
ui.simple_mode | boolean | yes | user | עריכת הנחיה בסגנון Readline כאשר true, מקשי הנחיה ניסיוניים בסגנון vim כאשר false. |
ui.status_line.command | string | yes | user | סקריפט עבור שורת מצב מסוג command. קמפיינים מסירים נתיב זה, שכבת requirements עדיין ממזגת אותו. |
ui.status_line.type | disabled / command | yes | user | שורת מצב אופציונלית מעל שורת קיצורי הדרך. כבוי כברירת מחדל. ראו מדריך למשתמש של שורת המצב. |
ui.theme | string | yes | user | שם ערכת הנושא, או auto/system להתאמה למערכת ההפעלה. כמו כן /theme ו-GROK_THEME. |
ui.ui_theme | string | yes | user | כינוי מדור קודם עבור ui.theme. |
ui.vim_mode | boolean | yes | user | מקשי Vim בהיסטוריית הגלילה, לא בהנחיה. כמו כן /vim-mode. |
ui.voice_capture_mode | hold / toggle | yes | user | לכידת קול בהחזקה כדי לדבר או בלחיצה להחלפת מצב. |
ui.voice_keybind_enabled | boolean | yes | user | הפעלת קיצור המקשים Ctrl+Space / F8 להכתבה קולית. הפקודה /voice עדיין עובדת כאשר הערך הוא false. |
ui.voice_stt_language | string | yes | user | קוד שפת דיבור לטקסט או auto. דורס את [voice].language עבור ההפעלה. |
ui.yolo | boolean | pin | user | אישור תמידי של קריאות כלים. קובץ requirements יכול לנעול ל-false ולחסום את --yolo. |
#version_overrides
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
version_overrides | array of tables | yes | user | טלאי הגדרות לכל גרסת CLI המוחלים לפני המיזוג. ראו [[version_overrides]]. |
#voice
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
voice.api_base | string | yes | user | שורש HTTPS API עבור דיבור לטקסט. אם אינו מוגדר, יורש מ-[endpoints].xai_api_base_url. |
voice.language | string | yes | user | קוד קטלוג של שפת STT מועדפת או auto. |
voice.sample_rate | number | yes | user | קצב דגימת לכידת STT בהרץ (Hz). |
#workflows
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
workflows.enabled | boolean | yes | user | הפעלת תהליכי עבודה (workflows). |
#worktree
| מפתח | סוג / ערכים | Requirements | Managed | פרטים |
|---|
worktree.auto_gc | table | yes | user | מדיניות איסוף אשפה אוטומטי של עץ עבודה. |
#managed_config.toml
הקובץ managed_config.toml מקבל כל מפתח בטבלאות שלעיל. הוא קובע ערכי ברירת מחדל לצי מכונות, כך שקובץ config.toml של המפתח עצמו דורס אותו. השתמשו בו עבור ערכים שאתם רוצים שאנשים יוכלו להתאים, וב-requirements.toml עבור ערכים שאינכם רוצים שיתאימו.
יוצא מן הכלל אחד לכלל זה:
| מפתח | התנהגות |
|---|
features.remote_fetch | הערך המנוהל מנצח את הערך של המפתח. |
Grok Build קורא תחילה את /etc/grok/managed_config.toml, ולאחר מכן את $GROK_HOME/managed_config.toml, אשר המסוף שומר מסונכרן. ערכים בקובץ השני מחליפים ערכים בקובץ הראשון.
עמודת Managed בטבלאות שלעיל היא התשובה לכל מפתח: fleet מציין שערך צי המכונות עומד בעינו, user מציין שקובץ המשתמש מנצח, ו-- מציין שמתעלמים מקובץ זה.
#requirements.toml
הקובץ requirements.toml הוא קובץ הנאכף על ידי מנהל מערכת. מיקומים: $GROK_HOME/requirements.toml (מטמון חתום), לאחר מכן /etc/grok/requirements.toml, ולאחר מכן macOS MDM של ai.x.grok. עמודת Requirements בטבלאות של config.toml מפרטת כל מפתח של config.toml שקובץ זה מקבל (pin או yes). מפתחות שהושמטו נשארים ללא הגבלות.
מפתחות אלה קיימים רק ב-requirements.toml:
| מפתח | סוג / ערכים | ברירת מחדל | פרטים |
|---|
fail_closed | boolean | false | סירוב להתחיל כאשר לא ניתן להחיל קובצי requirements או version_overrides חתומים, ברירת מחדל false. |
features.image_edit | boolean | - | נעילת זמינות image_edit. ב-requirements בלבד, רשומה בקובץ משתמש אינה מזוהה והשמטה משאירה את ברירת המחדל שהוגדרה מרחוק. |
ui.disable_bypass_permissions_mode | boolean | - | נעילת always-approve למצב כבוי. הנעילה נאכפת אך ורק משכבת requirements, ערך true בקובצי משתמש או קבצים מנוהלים זוכה להתעלמות. |
#מה קורה כאשר הגדרה נדחית
| מצב | מה ש-Grok Build עושה |
|---|
| מפתח מגדיר מפתח שננעל על ידיכם (pinned) | הערך הנעול חל. הפקודה grok inspect מפרטת את קובץ ה-requirements שתרם לכך. |
מפתח מגדיר מפתח שסופק על ידיכם ב-managed_config.toml | הערך שלהם חל, למעט features.remote_fetch. נעלו את המפתח במקום זאת אם הוא חייב לעמוד בעינו. |
הקובץ requirements.toml חסר או שהחתימה שלו אינה מאומתת | הנעילות אינן חלות, ו-Grok Build מתחיל בלעדיהן. הגדירו fail_closed = true כדי לסרב להתחיל במקום זאת. |
| מפתח נעול מציין ערך שגרסה זו אינה מזהה | מתעלמים מהמפתח ושאר הקובץ עדיין חל. |
#בדיקה מה בפועל בתוקף
הריצו grok inspect במכונה של המפתח. הפקודה מפרטת כל קובץ הגדרות שתרם, כולל שכבות requirements ושכבות מנוהלות, כך שמדיניות שאינה מוחלת נראית בפקודה אחת.