xenogit

เพื่อน CLI ของคุณสำหรับข้อความคอมมิต Git ทันที

การแนะนำ

Xenogit เป็นตัวช่วยบรรทัดคำสั่งที่เป็นประโยชน์ของคุณซึ่งใช้ OpenAI GPT เพื่อสร้างข้อความคอมมิตที่เป็นไปตามข้อกำหนด Conventional Commit อย่างรวดเร็ว หยุดใช้เวลาเขียนคอมมิตและเริ่มจัดการพื้นที่เก็บข้อมูล Git ของคุณได้อย่างง่ายดาย!

️เริ่มต้นใช้งาน

กำลังติดตั้ง

มีสองวิธีในการติดตั้ง Xenogit:

1. การใช้ Composer: รันคำสั่งต่อไปนี้เพื่อติดตั้ง Xenogit ทั่วโลก:

composer global require dotninth/xenogit

2. การดาวน์โหลดจาก GitHub: ไปที่หน้าเผยแพร่บน GitHub และดาวน์โหลดไบนารีที่เหมาะสม

การใช้งาน

หลังจากติดตั้ง Xenogit คุณสามารถมีตัวเลือกทั้งหมดได้เพียงแค่เปิดโปรแกรม:

$ xenogit

  Xenogit  v1.3.2

  USAGE:  < command > [options] [arguments]

  commit         Automatically generate commit messages

  config:api-key Configure the API key in the .env file

คีย์ API

Xenogit ต้องการคีย์ API จาก OpenAI เพื่อให้ทำงานได้อย่างถูกต้อง มีสองตัวเลือกในการระบุคีย์ API:

1. ใช้คำสั่ง xenogit config:api-key <your-api-key>

2. การใช้ตัวแปรสภาพแวดล้อม: สร้างตัวแปรสภาพแวดล้อมชื่อ API_KEY ซึ่งมีคีย์ OpenAI API ของคุณ

3. สร้างไฟล์ชื่อ .env ในไดเร็กทอรีที่มีไบนารี Xenogit อยู่ ไฟล์นี้จะใช้เพื่อจัดเก็บตัวแปรสภาพแวดล้อมของคุณ ไปที่ไฟล์ .env ให้เพิ่มบรรทัดต่อไปนี้ โดยแทนที่ <YOUR_API_KEY> ด้วยคีย์ OpenAI API จริงของคุณ:

API_KEY= < YOUR_API_KEY > 

การชำระเงิน

การใช้ Xenogit จะทำให้คุณเสียค่าใช้จ่ายสำหรับแต่ละคำขอที่คุณทำกับ OpenAI API Xenogit ใช้รุ่น ChatGPT อย่างเป็นทางการ ( gpt-3.5-turbo-16k ) ซึ่งมีราคาน้อยกว่า GPT-4 ประมาณ 15 เท่า ตรวจสอบให้แน่ใจว่าคุณมีเงินหรือเครดิตเพียงพอในบัญชี OpenAI ของคุณเพื่อชำระค่าใช้งาน Xenogit

หากต้องการทราบข้อมูลเพิ่มเติมเกี่ยวกับราคาสำหรับการใช้บริการของ OpenAI โปรดตรวจสอบหน้าราคาที่หน้าราคา OpenAI

มีส่วนช่วย

คุณสามารถมีส่วนร่วมใน Xenogit ได้! เพื่อการทำงานร่วมกันที่ราบรื่น โปรดปฏิบัติตามแนวทางเหล่านี้เมื่อมีส่วนร่วมในโครงการ:

1. แยกพื้นที่เก็บข้อมูลและโคลนไปยังเครื่องภายในของคุณ
2. สร้างสาขาใหม่สำหรับการสนับสนุนของคุณ: git checkout -b my-contribution
3. ทำการเปลี่ยนแปลง โดยตรวจสอบให้แน่ใจว่าโค้ดเป็นไปตามรูปแบบการเขียนโค้ดและแบบแผนของโปรเจ็กต์
4. ทดสอบการเปลี่ยนแปลงของคุณอย่างละเอียด
5. ยอมรับการเปลี่ยนแปลงของคุณด้วยข้อความยืนยันที่อธิบาย ตามข้อกำหนด Conventional Commit
6. พุชสาขาของคุณไปยังที่เก็บแยกของคุณ: `git push origin my-contribution'
7. เปิดคำขอดึงกับสาขา "หลัก" ของที่เก็บ Xenogit
8. ระบุคำอธิบายที่ชัดเจนและละเอียดเกี่ยวกับการเปลี่ยนแปลงของคุณในคำขอดึงข้อมูล พร้อมด้วยข้อมูลหรือบริบทที่เกี่ยวข้อง

โปรดทราบว่าการบริจาคให้กับ Xenogit แสดงว่าคุณตกลงที่จะเผยแพร่การบริจาคของคุณภายใต้ใบอนุญาต MIT

ใบอนุญาต

Xenogit ได้รับการเผยแพร่ภายใต้ใบอนุญาต MIT คุณสามารถแก้ไขและแจกจ่ายได้ตามความต้องการของคุณ