مرجع الـ CLI
ابحث عن أي أمر ghaym: الـ arguments والـ flags ورموز الخروج، والـ JSON الذي يطبعه.
كل الصفحات
لـ ghaym 0.0.21. لترى النسخة التي لديك أو تحدثها، انظر ثبت الـ CLI وسجل الدخول.
| المجموعة | الغرض |
|---|---|
ghaym config | اقرأ إعدادات الـ CLI واكتبها |
ghaym cloud workspaces | إدارة مساحات العمل |
ghaym cloud projects | إدارة المشاريع |
ghaym cloud environments | إدارة البيئات |
ghaym cloud services | إدارة الخدمات |
ghaym cloud deployments | تفاصيل عمليات النشر |
ghaym cloud changes | التغييرات المجهزة على بيئة، وتنشر معا |
ghaym cloud topology | كل نسخة من كل خدمة |
ghaym cloud rollouts | النشر نسخة بعد نسخة |
ghaym cloud residency | أين تعمل كل خدمة وقاعدة بيانات ومخزن، واتفاقية المعالجة لكل دولة |
ghaym cloud regions | المناطق والأحجام التي تبيعها |
ghaym cloud engines | ما يمكن أن تشغله قاعدة البيانات أو الكاش |
ghaym cloud vars | إدارة متغيرات البيئة |
ghaym cloud domains | إدارة النطاقات المخصصة |
ghaym cloud access | من يستطيع الوصول إلى خدمة ويب، في كل بيئة |
ghaym cloud buckets | إدارة المخازن |
ghaym cloud billing | تفاصيل الفوترة |
ghaym cloud audit | تفاصيل سجل التدقيق |
ghaym cloud approvals | إدارة الموافقات |
ghaym cloud sessions | تفاصيل جلسات الـ agents |
ghaym cloud git | الربط مع GitHub App |
ghaym help | مواضيع مساعدة إضافية |
عبر الـ CLI، تحصل على كل الأوامر والـ flags بنداء واحد:
تيرمينال
ghaym help all --jsonسجل دخول هذا الجهاز، في المتصفح أو بمفتاح API يمرر عبر pipe.
الصيغة
ghaym loginسجل خروج هذا الجهاز وألغ دخوله من المتصفح.
الصيغة
ghaym logoutاعرض الهوية التي وراء بيانات الدخول الحالية.
الصيغة
ghaym whoamiاكتشف الـ framework واكتب ملف ghaym.yaml.
الصيغة
ghaym cloud init [flags]| الـ flag | الوظيفة |
|---|---|
--name <name> | اسم المشروع، واسم المجلد إن لم يحدد |
--port <port> | الـ port الذي تستمع عليه الخدمة |
--framework <framework> | غير الـ framework الذي اكتشفه |
--repo <owner/name> | الـ repo على GitHub الذي ينشر منه المشروع |
--replicas <n> | عدد نسخ خدمة الويب التي تعمل |
--size <slug> | الـ slug لحجم الـ instance، وهو micro إذا لم تحدده |
--force | اكتب فوق ghaym.yaml إذا كان موجودا |
أنشئ ما يصفه ghaym.yaml، ثم اشرح كيف تنشر.
الصيغة
ghaym cloud deploy [flags]| الـ flag | الوظيفة |
|---|---|
--repo <owner/name> | الـ repo على GitHub الذي تنشر منه |
--size <slug> | الـ slug لحجم الـ instance، ويتقدم على size في ghaym.yaml |
--site <slug> | الموقع الذي تنشر فيه، ويتقدم على site في ghaym.yaml |
--env <env> | البيئة التي تنشر فيها، بالاسم أو الـ id. إذا لم تحددها، فبيئة الإنتاج |
افتح tunnel من port على هذا الجهاز إلى قاعدة بيانات.
الصيغة
ghaym cloud connect [database] [flags]| الـ argument | مطلوب |
|---|---|
[database] | لا |
| الـ flag | الوظيفة |
|---|---|
--project <project> | المشروع الذي فيه قاعدة البيانات، إذا كان اسمها في أكثر من مشروع |
--env <env> | البيئة، بالاسم أو الـ id. إذا لم تحددها، فبيئة الإنتاج |
--reader | اتصل بنسخة للقراءة فقط |
--port <port> | الـ port المحلي. إذا لم تحدده، فالـ port الخاص بالمحرك أو أول port متاح بعده |
--wake | أيقظ القاعدة أولا إذا كانت نائمة، وانتظر حتى ترد |
اعرض الاستهلاك المحسوب وكلفته لهذا الشهر.
الصيغة
ghaym cloud usage| الـ flag | الوظيفة |
|---|---|
-V, --version | اطبع رقم النسخة |
--json | اطبع مستند JSON ثابت على stdout |
--dry-run | اعرض ما سيحدث دون أن تغير شيئا |
--intent <text> | لماذا تشغل الأمر. يحفظ في سجل التدقيق |
--idempotency-key <key> | استعمل المفتاح نفسه حتى ينطبق التعديل الذي تعيده مرة واحدة |
--workspace <id> | مساحة العمل التي تعمل فيها. تتقدم على GHAYM_WORKSPACE وملف الإعدادات |
| المتغير | الوظيفة |
|---|---|
GHAYM_TOKEN | مفتاح API يبدأ بـ ghk_. يتقدم دائما على بيانات الدخول المحفوظة. |
GHAYM_API_URL، GHAYM_AUTH_URL | عناوين الخدمات الأساسية. |
GHAYM_SESSION | uuidv7 تعيد استعماله بين النداءات حتى تجمعها في جلسة agent واحدة. وضبطه يجعل صاحب النداء agent. |
GHAYM_INTENT | نص حر يحفظ في سجل التدقيق. |
GHAYM_AGENT | يستبدل الـ harness المكتشف، بصيغة name/version. |
GHAYM_WORKSPACE | id مساحة العمل. --workspace يتقدم عليه، وهو يتقدم على ملف الإعدادات. وإذا كان معرفا وفارغا، فلا يسمي أي مساحة. |
| الرمز | الاسم | المعنى | من HTTP |
|---|---|---|---|
0 | ok | نجح الأمر. | – |
1 | generic | فشل غير مصنف (شبكة، خادم، bug). | أي status آخر، أو لا يوجد رد |
2 | usage | الأمر مكتوب خطأ: flag غير معروف، أو argument ناقص، أو احتاج إلى سؤال والجلسة غير تفاعلية. | – |
3 | auth | لم تسجل الدخول، أو انتهت صلاحية الـ token، أو ليست لديك صلاحية. | 401, 403 |
4 | not-found | المورد الذي ذكرته غير موجود. | 404 |
5 | conflict | القيم غير صحيحة، أو الطلب يتعارض مع الوضع الحالي. | 400, 409, 422 |
6 | needs-approval | العملية تحتاج إلى موافقة: أنشئت موافقة وهي معلقة. تابعها بـ ghaym cloud approvals wait <id>. | 202 مع approval-required |
7 | quota | موقوف بسبب حصة أو ميزانية أو وضع الفوترة. | 402, 429 |
مع --json، يطبع الأمر مستند JSON واحدا على stdout.
| الحقل | المحتوى |
|---|---|
ok | true إذا نجح الأمر، و false إذا فشل. |
data | النتيجة عندما ينجح. تحتوي معظم القوائم على items و pagination (limit و offset و total). |
data مع --dry-run | dryRun، ثم إحدى خطتين. ghaym cloud services create و ghaym cloud domains add و ghaym cloud sessions rollback تسأل الـ API، فيرد بخطته مع التكلفة: operation و summary و resources و estimatedMonthlyJod و warnings. وأي تعديل غيرها لا يرسل شيئا: simulated و reason، والـ request الذي كان سيرسله، والـ Authorization مخفي. ولا يتغير شيء. |
exitCode | رمز الخروج، عندما يفشل. |
error | مستند الخطأ من الـ API كما هو. الـ type فيه هو اسم صفحته في أخطاء الـ API. ويضيف الـ CLI suggestions إذا لم يطابق المرجع أي شيء. |
- لا يطرح سؤالا إلا في تيرمينال. في الـ CI، أو دون تيرمينال، أو تحت Claude Code، يتوقف برمز
2ويخبرك بأي flag تمرره. - كل أمر يغير شيئا يقبل
--dry-run، ومعه لا يغير شيئا. - كل تعديل يرسل
Idempotency-Keyينشئه بنفسه، و--idempotency-keyيضع مفتاحا من عندك. - العملية التي تحتاج إلى موافقة تخرج برمز
6ومعها id الموافقة. انتظرها بـghaym cloud approvals wait. - الـ
<project>أو الـ<service>يقبل الـ id أو الـ slug. والـ slug لا يتكرر في الحساب. - المرجع الذي لا يطابق شيئا يخرج برمز
4، ويذكر أقرب slugs، وأيضا تحتerror.suggestionsمع--json. - الـ
--envيقبل اسما أو id. وإذا لم تحدده، يعمل الأمر الخاص بالخدمة على بيئة الإنتاج. والأمر الذي يقبل id البيئة يحتاج إلى--projectإذا أعطيته اسما. - الـ scale والإعدادات والمتغيرات والوصول وربط المخازن تنتظر. ولا يتغير شيء حتى
ghaym cloud changes apply، أو--applyفي الأمر نفسه. vars setوvars unsetيجهزان المتغير على خدمة واحدة مع--service. وبدونه يكون المتغير مشتركا ويصل إلى كل خدمة في البيئة.- حد الخطة يخرج برمز
7ومعهplanKeyوlimitوlimitValue. وghaym cloud billing plansيعرض حدود كل خطة. ghaym cloud connectيبقي الـ tunnel مفتوحا حتى Ctrl-C، ويعيد الاتصال على الـ port نفسه. مع--jsonيطبع سطرا عندما يجهز الـ tunnel، وسطرا آخر إذا أغلقه الخادم. القاعدة النائمة تخرج برمز5، و--wakeيوقظها أولا.