مرجع الـ 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

ghaym login

سجل دخول هذا الجهاز، في المتصفح أو بمفتاح API يمرر عبر pipe.

الصيغة
ghaym login

ghaym logout

سجل خروج هذا الجهاز وألغ دخوله من المتصفح.

الصيغة
ghaym logout

ghaym whoami

اعرض الهوية التي وراء بيانات الدخول الحالية.

الصيغة
ghaym whoami

ghaym cloud init

اكتشف الـ 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 cloud deploy

أنشئ ما يصفه 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. إذا لم تحددها، فبيئة الإنتاج

ghaym cloud connect

افتح 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

اعرض الاستهلاك المحسوب وكلفته لهذا الشهر.

الصيغة
ghaym cloud usage

الـ flags العامة

الـ 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_SESSIONuuidv7 تعيد استعماله بين النداءات حتى تجمعها في جلسة agent واحدة. وضبطه يجعل صاحب النداء agent.
GHAYM_INTENTنص حر يحفظ في سجل التدقيق.
GHAYM_AGENTيستبدل الـ harness المكتشف، بصيغة name/version.
GHAYM_WORKSPACEid مساحة العمل. --workspace يتقدم عليه، وهو يتقدم على ملف الإعدادات. وإذا كان معرفا وفارغا، فلا يسمي أي مساحة.

رموز الخروج

الرمزالاسمالمعنىمن HTTP
0okنجح الأمر.–
1genericفشل غير مصنف (شبكة، خادم، bug).أي status آخر، أو لا يوجد رد
2usageالأمر مكتوب خطأ: flag غير معروف، أو argument ناقص، أو احتاج إلى سؤال والجلسة غير تفاعلية.–
3authلم تسجل الدخول، أو انتهت صلاحية الـ token، أو ليست لديك صلاحية.401, 403
4not-foundالمورد الذي ذكرته غير موجود.404
5conflictالقيم غير صحيحة، أو الطلب يتعارض مع الوضع الحالي.400, 409, 422
6needs-approvalالعملية تحتاج إلى موافقة: أنشئت موافقة وهي معلقة. تابعها بـ ghaym cloud approvals wait <id>.202 مع approval-required
7quotaموقوف بسبب حصة أو ميزانية أو وضع الفوترة.402, 429

مخرجات JSON

مع --json، يطبع الأمر مستند JSON واحدا على stdout.

الحقلالمحتوى
oktrue إذا نجح الأمر، و false إذا فشل.
dataالنتيجة عندما ينجح. تحتوي معظم القوائم على items و pagination (limit و offset و total).
data مع --dry-rundryRun، ثم إحدى خطتين. 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 يوقظها أولا.