Technical Tutorials

في مشهد البرمجيات الحديث، تظل واجهة سطر الأوامر (CLI) أداة قوية للمطورين ومهندسي DevOps والمستخدمين المتقدمين. سواء كنت تبني أداة نشر، أو مدير تكوين، أو أداة للمطورين، فإن واجهة CLI مصممة جيدًا يمكن أن تعزز الإنتاجية بشكل كبير. وعلى الرغم من شهرة Go ببساطتها وأدائها، فإن كتابة واجهة CLI من الصفر يمكن أن تصبح مملة بسرعة بسبب تعقيدات تحليل الحجج، وإنشاء المساعدة، ومعالجة الأخطاء.

هنا يأتي دور Cobra. إنها مكتبة المعيار الفعلي لبناء تطبيقات CLI في Go. تستخدمها عمالقة الصناعة مثل Kubernetes وHugo وHelm، وتوفر Cobra واجهة بسيطة وقوية لإنشاء برامج سطر أوامر مرنة وسريعة وسهلة الاستخدام. في هذا المنشور، سنستكشف كيفية الاستفادة من Cobra لبناء أدوات CLI ذات مستوى احترافي.

لماذا تختار Cobra؟

قبل الغوص في الكود، من الضروري فهم سبب تحول Cobra إلى الخيار المفضل لتطوير CLI في Go. على عكس حزم flag الخام التي تتطلب توصيلًا يدويًا للحجج والأوامر الفرعية، تقدم Cobra ما يلي:

إنشاء المساعدة تلقائيًا: تقوم Cobra تلقائيًا بإنشاء أعلام --help والتوثيق لأوامرك.
دعم الأوامر الفرعية: تدعم الأوامر الهرمية (مثل kubectl get pods) بسهولة.
هيكل متسق: تفرض نمطًا متسقًا لتنظيم الأعلام والأوامر.
تكامل مع Viper: تتكامل Cobra بسلاسة مع Viper، مما يجعل إدارة التكوين أمرًا سهلاً.

إعداد مشروعك

للبدء، تحتاج إلى تهيئة وحدة Go الخاصة بك وتثبيت مكتبة Cobra. افتح طرفية الأوامر (Terminal) وقم بتشغيل الأوامر التالية:


mkdir my-cli-tool
cd my-cli-tool
go mod init github.com/username/my-cli-tool
go get github.com/spf13/cobra

مع تثبيت التبعيات، يمكننا البدء في هيكلة تطبيقنا. تعمل Cobra على أساس تسلسل هرمي يتكون من الأمر الجذر والأوامر الفرعية. الأمر الجذر هو نقطة الدخول لتطبيقك، بينما تمثل الأوامر الفرعية إجراءات محددة يمكن للمستخدم اتخاذها.

إنشاء الأمر الجذر

الأمر الجذر هو نقطة البداية لواجهة CLI الخاصة بك. عادةً لا يقوم بتنفيذ أي إجراء بحد ذاته، بل يعمل كحاوية للأوامر الفرعية. في Cobra، يتم تمثيل الأوامر بواسطة بنية *cobra.Command. دعنا نعرف أمرًا جذريًا بسيطًا:


package main

import (
    "fmt"
    "log"
    "github.com/spf13/cobra"
)

func main() {
    // تعريف الأمر الجذر
    var rootCmd = &cobra.Command{
        Use:   "mycli",
        Short: "My CLI is a sample tool",
        Long:  `My CLI is a demonstration tool built with Cobra to showcase CLI creation in Go.`,
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("Welcome to My CLI!")
        },
    }

    // تنفيذ الأمر الجذر
    if err := rootCmd.Execute(); err != nil {
        log.Fatal(err)
    }
}

في هذا الجزء من الكود، نعرف Use (اسم الأمر)، وShort (وصف موجز لمخرجات المساعدة)، وLong (توثيق مفصل). تحتوي الدالة Run على المنطق الذي يتم تنفيذه عند استدعاء الأمر.

إضافة الأوامر الفرعية والأعلام

عادةً ما تحتوي أدوات CLI في العالم الحقيقي على إجراءات متعددة. دعنا نضيف أمرًا فرعيًا يسمى greet يقبل علماً (flag) للاسم:


// إضافة أمر فرعي
var greetCmd = &cobra.Command{
    Use:   "greet [name]",
    Short: "Greet someone",
    Run: func(cmd *cobra.Command, args []string) {
        name, _ := cmd.Flags().GetString("name")
        fmt.Printf("Hello, %s!\n", name)
    },
}

// تعريف علّم نصي لأمر الترحيب
greetCmd.Flags().StringP("name", "n", "World", "Name of the person to greet")

// إضافة الأمر الفرعي إلى الأمر الجذر
rootCmd.AddCommand(greetCmd)

من خلال إرفاق greetCmd بـ rootCmd باستخدام AddCommand، تتولى Cobra تلقائيًا توجيه الطلبات. تتيح لنا طريقة Flags().GetString استرجاع القيمة التي مررها المستخدم، مع وجود قيمة افتراضية في حال عدم تقديم أي قيمة.

الخاتمة

تقلل Cobra بشكل كبير من كمية الكود المتكرر (boilerplate) المطلوب لبناء تطبيقات CLI في Go. ومن خلال توفير إطار عمل قوي للتعامل مع الأعلام والأوامر وتوثيق المساعدة، تتيح للمطورين التركيز على المنطق الأساسي لأدواتهم بدلاً من تحليل مدخلات المستخدم. سواء كنت تبني أداة صغيرة أو أداة مؤسسية معقدة، توفر Cobra الهيكل والمرونة اللازمة لإنشاء واجهات سطر أوامر احترافية وسهلة الاستخدام.

ابدأ في بناء أداة سطر الأوامر التالية الخاصة بك باستخدام Cobra اليوم، وانضم إلى صفوف المطورين الذين يخلقون تجارب سطر أوامر قوية وفعالة وأنيقة.