codeprompts

Prompt kode

Alat Command Line (dan TUI) untuk membuat prompt LLM dari kode Anda menggunakan templat setang.

Ini adalah proyek untuk memoles karat dan didasarkan pada Code2Promppt dengan beberapa fungsi tambahan yang menurut saya berguna.

• Mengapa kode meminta?
• Antarmuka Pengguna Terminal
• Instalasi
  • Lepaskan biner
  • Membangun dari sumber
• Penggunaan
  • Argumen
• Template
• Panduan Penggunaan

---

Mengapa kode meminta?

Salin secara manual dan menempelkan cuplikan kode dan kode ke LLMS memiliki beberapa masalah:

1. Anda kehilangan format dan struktur . Untuk bahasa seperti Python yang menggunakan whitespace, pemformatan dan struktur kode penting bagi LLM untuk secara akurat dan komprehensif memahami kode untuk permintaan Anda.
2. Anda kehilangan konteks . Agar LLM memberikan tanggapan terbaik, ini membutuhkan konteks dari semua kode Anda. Ini termasuk dependensi cuplikan kode Anda, modul/objek yang ditentukan pengguna lainnya, dan variabel dan konsep ruang lingkup lainnya.
3. Anda kehilangan standardisasi cepat : Jika Anda menggunakan LLM untuk melakukan tugas berulang seperti mendokumentasikan kode, Anda harus memastikan bahwa pedoman penataan dokumentasi Anda konsisten di setiap permintaan.
4. Nomor baris! : Pada input besar, LLMs cenderung memberikan perubahan kode pada garis yang tepat, sehingga sulit untuk ditulis dengan tepat di mana harus menerapkan/meninjau perubahan yang diusulkan. Nomor baris membantu meringankan ini untuk sumber kode yang lebih baik.

Untuk mendapatkan hasil maksimal dari LLMS, diminta harus jelas, komprehensif, dan konsisten. Bagaimana kode meminta memperbaiki masalah ini:

1. Kode prompt akan memastikan struktur yang melekat pada kode Anda dipertahankan untuk membatasi kemungkinan salah tafsir atau inferrence yang diperlukan dari LLM.
2. Konteks lengkap yang diperlukan untuk memahami kode terlampir dalam format standar. Ini termasuk Pohon Direktori Proyek dan Pathing File.
3. Dengan menggunakan templat stang, petunjuknya akan komprehensif dan konsisten. Jika panduan gaya pilihan Anda dan/atau praktik pengkodean diperbarui di masa mendatang, tidak perlu ingat untuk memperbarui semua petunjuk yang diketik secara manual di masa depan. Sebaliknya, cukup perbarui template setang target sekali.

Antarmuka Pengguna Terminal

Proyek ini juga menyertakan pembungkus TUI opsional di mana Anda dapat menyediakan file konfigurasi untuk mengganti berbagai bendera dan melihat bagaimana perintah disusun sebelum menjalankannya.

Instalasi

Untuk mengunduh dan menggunakan alat baris perintah codeprompts, Anda memiliki dua opsi: Anda dapat mengunduh rilis biner atau kompilasi dari sumber. Untuk langkah -langkah yang lebih rinci, termasuk pengaturan penyelesaian tab, lihat Panduan Pengaturan.

Lepaskan biner

Untuk mengunduh biner rilis, buka rilis dan mengunduh biner untuk OS Anda.

Catatan : Untuk menggunakan biner TUI, Anda harus menambahkan biner CLI ke jalan Anda dan baik:

• Ubah nama Binary Release CLI menjadi codeprompt
• Perbarui file konfigurasi untuk perintah untuk menjalankan biner CLI

Membangun dari sumber

Untuk membangun dari sumber, Anda harus memiliki git, karat, dan kargo (akan dipasang dengan karat) terpasang.

Klon pertama repositori:

git clone [email protected]:seankim658/codeprompts.git

Dan kemudian menyusun biner rilis:

 cd codeprompts/
cargo build --release

Penggunaan

Panduan penggunaan yang lebih terperinci dapat ditemukan di sini.

Argumen

Dokumentasi yang lebih luas tentang opsi dapat ditemukan di sini. Kode tersebut meminta alat baris perintah memiliki argumen berikut:

Create standardized LLM prompts from your code

Usage: codeprompt [OPTIONS] [PATH] [COMMAND]

Commands:
  completion  Generate shell completion scripts.
  help        Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]  Path to project directory

Options:
      --include <INCLUDE>    Glob patterns to include
      --exclude <EXCLUDE>    Glob patterns to exclude
      --exclude-priority     Change pattern priority in case of conflict to prioritize the exclusion pattern
      --exclude-from-tree    Eclude files/folders from the source tree based on exclude patterns
      --gitignore            Don't respect .gitignore file
  -d, --diff-staged          Capture the git diff for staged changes only (equivalent to running `git diff --cached` or `git diff --staged`
  -u, --diff-unstaged        Capture the git diff for unstaged changes only (equivalent to running `git diff`)
      --no-tokens            Don't display approximate token count of the genrated prompt
  -c, --encoding <ENCODING>  Tokenizer to use for token count [default: cl100k]
  -o, --output <OUTPUT>      Redirect output to file
  -l, --no-line-numbers      Turn off line numbers in source code blocks
      --no-codeblock         Disable wrapping code inside markdown code blocks
      --relative-paths       Use relative paths instead of absolute paths, including parent directory
      --no-clipboard         Disable copying to clipboard
  -t, --template <TEMPLATE>  Optional path to Handlebars template
      --no-spinner           Whether to render the spinner
      --json                 Whether to print the output as JSON. Defaults to False
      --issue <ISSUE>        Fetch a specific Github issue for the repository
      --verbose              Run in verbose mode to investigate glob pattern matching
  -h, --help                 Print help (see more with '--help')
  -V, --version              Print version

Template

Template menggunakan bahasa templating sederhana yang disebut setang.

Template yang telah ditentukan sebelumnya dapat diunduh dari rilis proyek. Unduh templates.zip .

Saat ini, templat yang telah ditentukan sebelumnya adalah:

Nama Template	Keterangan
default_template.hbs	Ini adalah templat default sederhana yang akan menyusun jalur proyek Anda, pohon sumber, dan blok kode.
documentation_template.hbs	Templat dokumentasi membuat prompt untuk mendokumentasikan kode. Pedoman dokumentasi konsisten dengan Pedoman Lab Hive dan persyaratan dokumentasi.
git_commit.hbs	Template untuk membuat pesan komit git yang ringkas dan akurat. Dapat digunakan dengan opsi diff-staged dan diff-unstaged .
git_issues.hbs	Template untuk mengimplementasikan perubahan berdasarkan masalah GitHub.
code_optimization.hbs	Templat untuk mengoptimalkan kode dalam kompleksitas waktu dan ruang.