GitHub Copilot

Vendor: GitHub / Microsoft Nama instalasi: github-copilot Status: GA Konfigurasi native: <project>/.github/copilot-instructions.md

InstalasiCopy Anchor Link

apothem install --harness github-copilot --project /path/to/project

Adapter menurunkan berkas instruksi proyek dari profil bersama Anda dan dari permukaan aturan dan tata kelola Apothem bersama, menulis helper Apothem sebagai profil helper Copilot di dalam proyek (lihat Profil helper), dan mendaftarkan dua hook (lihat Hook).

Adapter juga menulis skill Apothem, beserta aturan dan templat yang dikutipnya, ke direktori home pengguna Anda, sebelum menyentuh proyek (lihat Berkas di luar proyek).

Berkas yang ditulis:

• <project>/.github/copilot-instructions.md, berkas instruksi.
• <project>/.github/agents/<name>.agent.md untuk setiap helper Apothem, di dalam proyek.
• <project>/.github/hooks/apothem.json, berkas hook, di dalam proyek. Berkas hook milik Anda di folder itu tidak disentuh.
• <project>/.apothem/support/github-copilot/hooks/, skrip hook, di dalam proyek.
• ~/.agents/skills/<name>/SKILL.md untuk setiap skill dan command Apothem, di direktori home pengguna Anda.
• ~/.config/apothem/rules/ dan ~/.config/apothem/templates/, di direktori home pengguna Anda.

Berkas di luar proyekCopy Anchor Link

Instalasi juga menulis skill Apothem ke direktori home pengguna Anda, sebelum mengubah apa pun di dalam proyek:

Folder-folder ini dipakai bersama. Folder ini tidak privat bagi proyek:

• Setiap proyek tempat Anda memasang github-copilot, dan setiap instalasi Apothem lain yang menyebut folder tersebut, memakai salinan yang sama dan menulis berkas yang sama, sehingga urutan pemasangan Anda tidak berpengaruh. Beberapa alat lain juga membaca ~/.agents/skills/; registri harness mencantumkannya.
• --project memilih berkas instruksi yang ditulis dan proyek tempat instalasi itu berada. Opsi ini tidak mengubah ke mana skill ditulis.
• Instalasi tidak menambahkan berkas skill atau aturan ke repositori Anda. Proyek mendapatkan berkas instruksi, berkas profil helper di .github/agents/, berkas hook .github/hooks/apothem.json, ditambah folder .apothem/ yang dibuat oleh setiap instalasi proyek, yang juga menampung skrip hook.
• Folder home ditulis lebih dulu. Jika itu gagal, misalnya karena sebuah folder di jalur tersebut adalah tautan yang keluar dari direktori home Anda (tautan yang tetap berada di dalamnya diikuti) atau tidak dapat ditulisi, instalasi berhenti dengan galat sebelum apa pun di dalam proyek berubah.
• Folder skill dengan nama skill Apothem yang tidak ditulis oleh Apothem dibiarkan, dan instalasi mencetak peringatan yang menyebutkan namanya. Ganti nama atau pindahkan folder itu, lalu jalankan apothem update. apothem verify gagal selama nama itu masih terpakai.
• Total ukuran berkas-berkas tersebut beberapa megabita.

Instalasi mencetak catatan yang menyebutkan folder yang ditulisnya di luar --project, dan --dry-run mencantumkannya.

Profil helperCopy Anchor Link

Copilot membaca profil helper dari <project>/.github/agents/<name>.agent.md, menurut referensi GitHub untuk profil-profil ini. Instalasi menulis satu berkas per helper Apothem ke folder tersebut. Instalasi ini hanya untuk proyek dan tidak menulis folder ~/.copilot/agents/.

Setiap berkas mempertahankan instruksi helper tanpa perubahan dan membawa kunci frontmatter berikut:

Kunci tools Copilot adalah daftar izin berisi alias, dan Copilot tidak memiliki kunci yang menolak alat. Jadi alat yang diizinkan dan alat yang ditolak bagi helper digabungkan ke dalam satu daftar itu:

Copilot memiliki satu alias lagi, yaitu alias yang memungkinkan helper memulai helper lain; tidak ada helper Apothem yang diizinkan melakukan itu, sehingga alias itu tidak pernah ditulis. Sebuah alias tidak dicantumkan ketika helper menolak alat apa pun yang dicakupnya, karena alias itu akan membiarkan helper memakai alat tersebut. Alat tanpa alias (misalnya Monitor) tidak dicantumkan. Alat dengan pola, seperti Bash(git status), tidak memiliki bentuk alias: sebagai alat yang diizinkan, alat itu tidak dicantumkan, dan sebagai alat yang ditolak, alat itu menolak seluruh alat. Helper yang tidak dapat menyunting berkas mempertahankan batas itu: helper itu tidak pernah mendapatkan edit. Jika setiap alat dalam daftar sebuah helper tidak dicantumkan, berkas itu menyatakan tools: [], yang tidak memberi helper alat apa pun, alih-alih menghilangkan kunci itu, yang akan memberinya setiap alat.

Instalasi tidak menulis kunci model, sehingga helper memakai model default, dan tidak menulis kunci lain yang didokumentasikan Copilot (target, disable-model-invocation, user-invocable, mcp-servers, metadata), batas giliran, maupun kunci version, updated dan portability milik Apothem.

Hal yang perlu diketahui:

• .github/agents/ adalah bagian dari repositori Anda. Rekan tim dan layanan pengodean cloud Copilot membaca berkas yang sama, jadi commit berkas itu bersama proyek atau cantumkan .github/agents/ di .gitignore; Apothem tidak memilihkannya untuk Anda.
• Layanan pengodean cloud tidak menghormati alias web dan todo. Alias web mencakup pencarian web sekaligus pengambilan halaman, sehingga citation-auditor, fact-checker dan research-scout dapat membaca dan mencari berkas di sana tetapi tidak dapat mencari di web maupun mengambil halaman.
• Copilot CLI juga membaca .claude/agents/ milik repositori, tetapi tidak ~/.claude/agents/, sehingga instalasi Claude Code tidak menjangkau Copilot.
• Berkas milik Anda yang dinamai seperti helper Apothem (<name>.agent.md) disimpan di bawah ~/.apothem/backups/ lalu diganti. Pencopotan tidak mengembalikannya. Berkas dengan nama lain tidak pernah disentuh. Dokumentasi Copilot tidak menyebutkan apa yang terjadi ketika folder memuat <name>.md sekaligus <name>.agent.md.
• Apothem belum memastikan apakah Copilot mengutamakan .github/agents/ atau .claude/agents/ untuk satu nama, atau bagaimana layanan pengodean cloud dan VS Code memperlakukan kunci frontmatter yang tidak dicantumkannya.

HookCopy Anchor Link

Copilot menjalankan hook dari berkas JSON di <project>/.github/hooks/, menurut referensi hook Copilot. Instalasi menulis satu berkas di sana, apothem.json (versi 1), dengan dua hook:

Keduanya menambahkan konteks bagi model. Tidak satu pun memblokir pemanggilan alat atau sesi.

Apothem tidak mendaftarkan penjaga preToolUse di Copilot. Untuk preToolUse Copilot hanya membaca bidang izin dan input alat yang ditulis ulang, tidak pernah additionalContext (bidang yang dipakai penjaga Apothem untuk berbicara). Penjaga yang didaftarkan di sana akan memakan satu permulaan proses pada setiap pemanggilan alat tanpa menyampaikan apa pun, sehingga penjaga tulis, sunting dan shell, pemeriksaan AskUserQuestion dan protokol akhir sesi tetap berada di alat yang menyampaikannya. Hook memakai nama peristiwa camelCase Copilot, karena referensi mencantumkan bidang keluaran untuk nama-nama itu; apakah Copilot membaca additionalContext dari peristiwa PascalCase tidak didokumentasikan.

Ke mana berkas ditulis

Setiap hook memiliki perintah bash dan perintah powershell. Keduanya menjalankan dispatcher yang sama; perintah powershell memiliki operator panggilan (&) di depannya, yang diperlukan PowerShell sebelum jalur program yang dikutip. Perintah bash terlihat seperti ini, dengan interpreter dan jalur proyek Anda menggantikan kedua jalur tersebut:

"/path/to/python" "/path/to/project/.apothem/support/github-copilot/hooks/dispatch.py" --contract copilot sessionStart

--contract copilot membuat dispatcher membaca input camelCase Copilot dan mencetak {"additionalContext": ...}, yang merupakan apa yang dibaca Copilot untuk kedua peristiwa ini.

Commit dengan hati-hati, dan agen cloud. .github/hooks/ adalah bagian dari repositori Anda, dan layanan pengodean cloud Copilot membacanya. Perintah-perintah itu memuat interpreter yang ditemukan Apothem saat dijalankan dan jalur absolut proyek, dan skripnya berada di .apothem/, yang diabaikan oleh cuplikan .gitignore proyek. Di mesin lain mana pun, dan di layanan cloud (yang hanya menjalankan perintah bash), perintah itu tidak menemukan apa pun untuk dijalankan. Copilot mencatat kegagalan itu dan eksekusi tetap berjalan, karena hook sessionStart atau postToolUse yang gagal tidak memblokir. Tambahkan .github/hooks/apothem.json ke .gitignore, atau commit berkas itu hanya untuk tim yang memakai tata letak yang sama. Instalasi tidak menyunting .gitignore dan mencetak hal ini sebagai catatan.

Hook milik Anda. Berkas hook milik Anda di .github/hooks/ tidak pernah dibaca atau diubah. Hook yang Anda tambahkan ke apothem.json itu sendiri tetap ada: pembaruan dan pencopotan hanya mengganti atau menghapus entri yang perintahnya menjalankan dispatcher Apothem (.apothem/support/github-copilot/hooks/dispatch.py dengan --contract copilot, di jalur proyek mana pun perintah itu ditulis). Hook milik Anda yang hanya berbagi nama, atau yang menjalankan python -m apothem.conformity.gate, tidak pernah dianggap milik Apothem. Berkas yang bukan JSON valid disimpan di bawah ~/.apothem/backups/ dan diganti.

Jalur yang akan salah dibaca shell. Jalur proyek atau interpreter yang mengandung $, backtick, tanda kutip ganda, atau backslash ditolak sebelum apa pun ditulis: di dalam perintah yang dikutip, jalur itu akan menjalankan berkas lain, atau merusak JSON tempat perintah itu ditulis. Galat menyebutkan jalur tersebut; pindahkan atau ganti nama proyek dan jalankan instalasi lagi. Spasi atau apostrof dalam jalur tidak masalah.

Mematikan hook. Tetapkan APOTHEM_HOOKS_DISABLE=1 di lingkungan tempat Copilot berjalan untuk membungkam hook Apothem, atau tetapkan "disableAllHooks": true di apothem.json, yang melewati satu berkas itu.

Kontrak hook Local VS Code yang lebih lama (peristiwa dengan bidang command, windows, linux dan osx) adalah format berbeda yang tidak ditargetkan oleh berkas versi 1.

Pemetaan profil ke konfigurasi nativeCopy Anchor Link

Adapter membaca profil bersama Apothem dan merender berkas instruksi Copilot yang berlaku untuk seluruh repositori pada setiap eksekusi apothem install atau apothem update. Profil bersama adalah sumber kebenaran; suntingan lokal-proyek pada berkas yang dihasilkan dicadangkan sebelum sinkronisasi berikutnya mengganti konten yang dikelola Apothem.

Di dalam blok Apothem, bagian yang dirender dari profil Anda (operator, preferensi, aturan kustom, perilaku yang dipilih untuk diaktifkan, nama server MCP) muncul lebih dulu, mendahului teks tata kelola bersama. GitHub mencatat bahwa berkas instruksi yang lebih pendek lebih mungkin diproses secara utuh oleh tinjauan kode (Menyesuaikan tinjauan kode), sehingga bagian yang khusus untuk Anda berada di awal berkas.

Catatan kompatibilitasCopy Anchor Link

GitHub Copilot tidak mengekspos jalur instruksi global-pengguna berbasis berkas untuk dikelola oleh adapter ini. Apothem menargetkan berkas instruksi berlingkup proyek yang terdokumentasi dan membiarkan pengaturan pengguna tingkat IDE tetap menjadi milik operator. Adapter menulis satu berkas hook, .github/hooks/apothem.json, dan tidak ada berkas lain di .github/hooks/.

Di dalam repositori Apothem, .github/copilot-instructions.md adalah satu suara di antara permukaan instruksi asisten milik repositori tersebut. Dalam checkout repositori tersebut, pemeriksaan koherensi multi-permukaan pada gerbang konformitas membandingkan klaim bersama dalam AGENTS.md, CLAUDE.md, dan .github/copilot-instructions.md. Pemeriksaan ini melaporkan klaim bersama yang tidak disebutkan oleh salah satu dari ketiga berkas itu, dan berkas yang bertentangan dengan klaim yang dibuat AGENTS.md. Pemeriksaan ini tidak membaca berkas instruksi yang ditulis Apothem ke dalam proyek Anda. Gerbang ini bersifat advisori secara default: gerbang melaporkan temuan dan keluar dengan kode 0.

GitHub Copilot mencantumkan ~/.agents/skills/ di antara lokasi skill pribadinya, sehingga skill yang ditulis instalasi ada di mesin Anda untuk dimuat Copilot. Permukaan yang berjalan di GitHub, yaitu layanan pengodean cloud dan tinjauan kode, berjalan di tempat lain dan tidak melihat folder home Anda, itulah sebabnya berkas instruksi membawa disiplin-disiplin itu sendiri. Apothem belum memastikan bagaimana Copilot memperlakukan kunci header SKILL.md yang tidak dicantumkannya; skill membawa user-invocable, disable-model-invocation, allowed-tools, argument-hint, dan sebuah peta metadata.

VerifikasiCopy Anchor Link

apothem verify --harness github-copilot --project /path/to/project

Perintah verify memastikan bahwa:

1. Konfigurasi native ada di jalur yang diharapkan.
2. Setiap target terkelola ada, termasuk folder .github/agents/; berkas terkelola tidak kosong, dan konfigurasi JSON atau YAML dapat diurai. Tambahkan --profile PATH untuk juga memastikan bahwa berkas yang terpasang cocok dengan profil tersebut. Untuk .github/agents/, yang diperiksa adalah keberadaan folder tersebut, bukan keberadaan setiap berkas helper di dalamnya; perintah apothem diff --harness github-copilot --project /path/to/project mencantumkan berkas helper yang hilang atau usang. Berkas hook .github/hooks/apothem.json harus ada, tidak kosong, dapat diurai sebagai JSON, dan memuat entri yang menjalankan dispatcher Apothem, dan skrip hook harus berada di .apothem/support/github-copilot/hooks/. Pemeriksaan tidak menjalankan hook.
3. Setiap folder skill Apothem ada di tempatnya dengan sebuah SKILL.md, instalasi mana pun yang menulisnya, dan tidak ada folder skill dengan nama Apothem yang milik sesuatu yang tidak ditulis Apothem. Pemeriksaan yang gagal menyebutkan folder yang hilang atau asing.
4. Rutin verifikasi khusus adapter melaporkan keberhasilan.

PembaruanCopy Anchor Link

apothem update --harness github-copilot --project /path/to/project

Menurunkan ulang berkas instruksi proyek dari status profil bersama saat ini.

Pembaruan juga menulis ulang setiap folder skill yang berkasnya berbeda dari berkas saat ini. Jika Anda memasang dengan rilis sebelumnya yang tidak menulis skill, pembaruan menambahkannya. Pembaruan menulis ulang berkas profil helper yang berbeda dari berkas saat ini, dan menambahkan yang hilang. Pembaruan juga menyegarkan skrip hook dan hook Apothem di .github/hooks/apothem.json, dengan mempertahankan hook milik Anda di berkas itu.

PencopotanCopy Anchor Link

apothem uninstall --harness github-copilot --project /path/to/project

Menghapus blok Apothem dari <project>/.github/copilot-instructions.md dan mempertahankan teks apa pun di luarnya. Berkas dihapus hanya ketika tidak ada lagi yang tersisa di dalamnya. Sebelum perubahan, salinan bertanda waktu dari berkas disimpan di bawah ~/.apothem/backups/. YAML profil bersama dan mesin Apothem tidak terpengaruh.

Pencopotan juga menghapus berkas profil helper yang ditulisnya di <project>/.github/agents/ dan mempertahankan berkas lain di sana; folder itu dihapus ketika menjadi kosong. Pencopotan menghapus hook Apothem dari <project>/.github/hooks/apothem.json, mengenalinya dari jalur dispatcher dalam perintahnya, sehingga berfungsi tanpa catatan instalasi, dan mempertahankan hook milik Anda di berkas itu. Berkas itu dihapus ketika tidak ada lagi isi lain di dalamnya, dan berkas hook Anda yang lain tidak disentuh. Jika berkas itu memiliki komentar yang tidak dapat dibaca pencopotan, pencopotan membiarkan berkas itu apa adanya dan melaporkan hook sebagai dilewati, beserta alasannya; hapus entri Apothem secara manual. Skrip hook di <project>/.apothem/support/github-copilot/hooks/ juga dihapus. Pencopotan menghapus folder skill yang ditulisnya di ~/.agents/skills/ serta aturan dan templat di ~/.config/apothem/, tetapi hanya ketika tidak ada lagi instalasi Apothem lain yang memakainya. Proyek lain, atau alat lain yang berbagi folder itu, mungkin masih memakainya. Dalam kasus itu pencopotan mempertahankan folder tersebut, mencetak instalasi mana yang memakainya, dan pencopotan terakhir menghapusnya. Berkas yang Anda tambahkan ke folder tersebut tetap ada, dan folder yang menjadi kosong dihapus. Setiap folder dicadangkan di bawah ~/.apothem/backups/ sebelum dihapus.

Gerbang konformitasCopy Anchor Link

python -m apothem.conformity.gate --all .

Eksekusi --all mencakup validator mandiri. Eksekusi tersebut tidak menjalankan pemeriksaan koherensi multi-permukaan yang dijelaskan di bawah Catatan kompatibilitas. Untuk menjalankan pemeriksaan itu dengan nama di dalam checkout:

python -m apothem.conformity.gate --check multi-surface-coherence-grep AGENTS.md

Pemecahan masalahCopy Anchor Link

Tombol konfigurasiCopy Anchor Link

Lihat jugaCopy Anchor Link

• Semua harness — katalog lengkap alat yang didukung
• Panduan instalasi — pasang Apothem ke dalam harness ini
• Referensi apothem harnesses — tampilkan daftar dan periksa adapter dari CLI