AI Tools & Scripts
On-Call Runbook Builder: A Service Runbook from Your Repo Files
For developers, freelancers and agencies who run a service or hand one over: point your agent at the repo and get an on-call runbook where every command names its effect and the file and line it came from. دليل المناوبة لخدمتك من ملفات مستودعها، بالإنجليزي أو بالعربي.
What you get: 1 file · 42.18 KB · ZIP
See purchase optionsProduct description
English
For developers, freelancers and agencies who run a service, or hand one over to a client or a new teammate.
Point your agent at the service's repository. You get back an on-call runbook written from its own files: what runs, how to see its state, how to restart it, where the logs are, how a deploy and a rollback happen, and what to check first when it breaks.
What you get each run
runbook.md: ten fixed sections, from "Service at a glance" to "Ask the team". Every command sits in a step that says what it affects, what you should see, and what to do if it fails.runbook.html: the same runbook as one printable page, with read-only steps, restarts and production changes marked apart.facts.json: what the scan found in your files, each fact with its file and line.
Evidence for every command
Each command names the file and line it came from, or says it is a standard command of a tool your files show in use. A bundled scan (service_scan.py, Python standard library) reads Docker Compose files, Dockerfiles, package.json scripts, Makefiles, Procfiles, env example files and GitHub Actions workflows. It only reads: it runs nothing, makes no network calls and never copies the value of an environment variable.
Nothing invented
Hosts, dashboards, alerts, contacts and backups are rarely in a repository. The runbook does not guess them: they become questions under "Ask the team", and the runbook is updated when you answer.
How quality is kept
runbook_check.py lints the runbook: all sections present, every command in a step with its effect, expected result and next move, every cited file and line real, every make target, npm script and Compose service found by the scan, and no command that removes volumes, drops data or rewrites history. The agent fixes and runs it again until no FIX is left. It checks structure and evidence, not whether a step is right for your production: walk through the runbook with the team once before relying on it.
Arabic
The runbook can be written in Arabic with a right-to-left page; commands, file names and variable names stay as they are.
In the download: SKILL.md, the format reference, the three scripts, and a complete example so you can see the output before you buy: a small service repository (Compose, Dockerfile, Makefile, deploy workflow) and the English and Arabic runbooks made from it.
بالعربي
للمبرمجين والمستقلين والوكالات التي تشغّل خدمة، أو تسلّمها لعميل أو لزميل جديد.
وجّه وكيلك إلى مستودع الخدمة. تستلم دليل مناوبة مكتوبًا من ملفاتها نفسها: ما الذي يعمل، وكيف تعرف حالته، وكيف تعيد تشغيله، وأين السجلات، وكيف يتم النشر والتراجع، وما أول ما تفحصه عند العطل.
ماذا تستلم في كل مرة
- ملف
runbook.md: عشرة أقسام ثابتة، من «نظرة سريعة على الخدمة» إلى «اسأل الفريق». كل أمر داخل خطوة تذكر أثره، وما المتوقع أن تراه، وماذا تفعل إن لم ينجح. - صفحة
runbook.html: الدليل نفسه كصفحة واحدة قابلة للطباعة، مع تمييز خطوات القراءة فقط عن إعادة التشغيل وعن تغيير الإنتاج. - ملف
facts.json: ما وجده الفحص في ملفاتك، وكل معلومة مع ملفها وسطرها.
دليل لكل أمر
كل أمر يذكر الملف والسطر الذي جاء منه، أو يذكر أنه أمر قياسي لأداة تستعملها ملفاتك. أداة الفحص المرفقة service_scan.py (بايثون فقط) تقرأ ملفات Docker Compose وDockerfile وسكربتات package.json وMakefile وProcfile وأمثلة ملفات env وGitHub Actions. تقرأ فقط: لا تشغّل شيئًا، ولا تتصل بالشبكة، ولا تنسخ قيمة أي متغير.
لا شيء مخترع
أسماء الخوادم ولوحات المراقبة والتنبيهات وجهات الاتصال والنسخ الاحتياطية قلّما تكون في المستودع. الدليل لا يخمّنها: تصير أسئلة في قسم «اسأل الفريق»، ويُحدَّث الدليل عندما تجيب.
كيف نحافظ على الجودة
أداة runbook_check.py تدقق الدليل: الأقسام كلها موجودة، وكل أمر داخل خطوة فيها الأثر والمتوقع والخطوة التالية، وكل ملف وسطر مذكور موجود فعلًا، وكل هدف make وسكربت npm وخدمة Compose وجدها الفحص، ولا يوجد أمر يحذف وحدات تخزين أو بيانات أو يعيد كتابة التاريخ. يصلح الوكيل ويعيد الفحص حتى لا يبقى أي FIX. الأداة تفحص البنية والدليل، لا صحة الخطوة لبيئة إنتاجك: راجعوا الدليل مع الفريق مرة قبل الاعتماد عليه.
العربية
يمكن كتابة الدليل بالعربي مع صفحة من اليمين إلى اليسار، وتبقى الأوامر وأسماء الملفات والمتغيرات كما هي.
داخل الملف: ملف SKILL.md، ومرجع الصيغة، والسكربتات الثلاثة، ومثال كامل لترى النتيجة قبل الشراء: مستودع خدمة صغير (Compose وDockerfile وMakefile ومسار نشر) والدليلان الإنجليزي والعربي المصنوعان منه.
Questions / أسئلة
Does it run commands or connect to my servers? / هل يشغّل أوامر أو يتصل بخوادمي؟
No. The scripts only read files in the repository. They run nothing and make no network calls. لا، السكربتات تقرأ ملفات المستودع فقط.
Which files does it read? / أي ملفات يقرأ؟
Docker Compose files, Dockerfiles, package.json scripts, Makefiles, Procfiles, env example files (names only) and GitHub Actions workflows. Kubernetes manifests, Helm charts, systemd units and Terraform are listed as found, and the agent reads them by hand if they matter. ملفات Compose وDockerfile وpackage.json وMakefile وProcfile وأمثلة env وGitHub Actions.
Can I trust the runbook as it is? / هل أعتمد على الدليل كما هو؟
Treat it as a first draft. Every command cites its file and line so you can check it fast, and the open questions are listed. Walk through it with the team once before relying on it. اعتبره مسودة أولى؛ كل أمر معه مصدره، وراجعه مع الفريق مرة قبل الاعتماد عليه.
What about things the repo does not say? / وما لا يذكره المستودع؟
Hosts, dashboards, alerts, contacts and backups are never invented. They become questions under "Ask the team", and the runbook is updated when you answer them. لا يُخترع شيء؛ تصير أسئلة للفريق.
Does it include destructive commands? / هل فيه أوامر خطرة؟
No. Commands that remove volumes, drop data or rewrite history are refused by the checker. Steps that restart something or change production say so in their first line. لا، وأداة الفحص ترفضها.
Can it write the runbook in Arabic? / هل يكتب الدليل بالعربي؟
Yes, as an added option: Arabic text with a right-to-left page, while commands and file names stay as they are. نعم، والأوامر وأسماء الملفات تبقى كما هي.
What you get
1 file · 42.18 KB
- oncall-runbook-builder-1.0.0.zipZIP · 42.18 KB
AI Tools & Scripts
On-Call Runbook Builder: A Service Runbook from Your Repo Files
For developers, freelancers and agencies who run a service or hand one over: point your agent at the repo and get an on-call runbook where every command names its effect and the file and line it came from. دليل المناوبة لخدمتك من ملفات مستودعها، بالإنجليزي أو بالعربي.
Getly opened the uploaded files and found nothing that would stop them opening. It is not a virus scan or a quality rating.
Tags
Frequently asked questions
Do I get access instantly?
Yes. This is a digital product - you can download it right after checkout, straight from your library.
Can I use it for commercial projects?
Yes. Commercial use is allowed: use it in your own business and in things you sell. You may not resell or redistribute the file itself.
What's your refund policy?
You can request a refund within 30 days. If something isn't right, request it from your order and the Getly team reviews it.
What file formats and sizes will I get?
You'll download 1 file - ZIP - 42.18 KB in total.
Do I get free updates?
Yes - when the seller ships a new version, you can re-download the latest files from your library at no extra cost. Check the changelog for recent updates.
Price
$5.00



