
Okwenziwa yi-Abide
I-Abide iphoqelela imiyalelo ethile yephrojekthi ama-linter ajwayelekile angakwazi ukuyihlola ngokuthembekile. Le miyalelo ingahlala kumafayela afana ne-AGENTS.md noma CLAUDE.md, futhi ihlanganise imithetho efana nokuthi sebenzisa i-Yup esikhundleni sokuqinisekisa ngesandla, ungakhi i-helper enomsebenzisi oyedwa kuphela, noma ungalokothi uveze iphutha elingacutshungulwanga kumsebenzisi.
Ngemva kokuhlela ngakunye noma lapho i-turn isiqediwe, i-Abide ithumela umthetho ofanele kanye nomehluko wekhodi ku-imodeli yesinqumo ye-Jev ye-TypeSafe. I-Jev ibuyisa amathuba okungenzeka esikhundleni sombhalo okhululekile. Uma lawo mathuba ekhombisa ukwephulwa komthetho, i-Abide itshela i-coding agent ukuthi yimuphi umthetho owephuliwe bese iyicela ukuthi ilungise ikhodi kuleyo turn efanayo.

I-Jev ibona umthetho nomehluko wekhodi, hhayi ingxoxo ye-agent. Lokhu kwenza i-Abide ikwazi ukusebenzisa ukuhlola okufanayo ngokungaguquki phakathi neseshini ende yokubhala ikhodi. Ngokwebenchmark yokuphinda edalwe eshicilelwe yirepository, ukuhlola kuthatha cishe ama-millisecond angu-300 ku-Jev, kanti i-hook ephelele ithatha cishe isekhondi elilodwa uma kuhlanganiswa nokuqalisa kwe-Node.
Izici ezibalulekile
- Ukuhlola okuzenzakalelayo kokuhlela: Imithetho ingasebenza ngokushesha ngemva kokuhlelwa kwekhodi ngakunye.
- Ukuhlola kwezinga le-turn: Imithetho edinga umehluko ophelele womsebenzi ingasebenza kanye ekupheleni kwe-turn.
- Ukuhlanganiswa nama-agent: I-Abide isekela i-Claude Code, i-Codex, ne-OpenCode.
- I-rubric ephethwe yi-repository: Imithetho ehlanganisiwe igcinwa kufayela elifundekayo nelilungele ukwenza i-commit, i-
.abide/rubric.json. - Imithetho enobubanzi: Umthetho ungasebenzisa obubanzi be-glob ukuze imibuzo ehlukene isebenze kuma-API route, ama-stylesheet, noma amanye amaqembu amafayela.
- Ukuhlolwa kwekhodi ekhona: I-Abide ingahlulela amafayela sengathi asanda kubhalwa.
- Ukulinganisa nokulungisa: Ingahlola imithetho ngokumelene nomlando wakamuva we-Git, ikhubaze imithetho engasebenzi, futhi isize ukubhala kabusha imithetho engalokothi isebenze.
- Ama-hook avuleka uma kwehluleka: Izimpawu zokungena ezingekho, ukwehluleka kwenethiwekhi, noma amaphutha e-hook akuvimbi ukuqhubeka kweseshini yokubhala ikhodi.
- Ayikho ipholisi eyakhelwe ngaphakathi: I-Abide iphoqelela imithetho ethathwe kumafayela akho emiyalelo, esikhundleni sokubeka isethi yemithetho echazwe kusengaphambili.
Okudingekayo
Udinga i-repository enemiyalelo ye-coding agent yakho kanye ne-agent okungenani eyodwa esekelwayo: i-Claude Code, i-Codex, noma i-OpenCode. Udinga futhi ukhiye we-API we-TypeSafe otholakala ku-typesafe.ai. Kungenjalo, i-Abide ingasebenzisa ukhiye okhona we-Vercel AI Gateway ngokusebenzisa i-environment variable ethi AI_GATEWAY_API_KEY.
Faka futhi ulungise i-Abide
Isinyathelo 1: Gcina ukhiye wakho we-API
Qalisa umyalo wokungena bese unamathisela ukhiye wakho we-TypeSafe uma ucelwa:
npx @coldtea/abide loginI-Abide igcina ukhiye ku-~/.abide/.env ngokufinyeleleka komnikazi kuphela. Kungenjalo ungafaka imininingwane yokungena ku-.env.local noma ku-.env empandeni ye-repository. Ukuseshwa kwemininingwane yokungena kuqala ku-environment, kulandele amafayela e-repository bese kuba yi-~/.abide/.env.
Uma usebenzisa i-Vercel AI Gateway, setha i-AI_GATEWAY_API_KEY esikhundleni sokhiye we-TypeSafe. Imininingwane yokungena ayamukelwa ngama-command-line flag futhi ayirekhodwa.
Isinyathelo 2: Faka ama-hook e-agent
Usuka ku-repository yakho, qalisa i-Abide:
npx @coldtea/abide initUma unganikezi igama le-agent, i-init ifaka kuzo zonke ama-agent asekelwayo ewatholayo. Ungaphinde uqondise ukuhlanganiswa okukodwa ngokusobala:
npx @coldtea/abide init claude
npx @coldtea/abide init codex
npx @coldtea/abide init opencode- Claude Code: Ukuhlanganiswa kwengezwa ku-
~/.claude/settings.json. - Codex: Ukuhlanganiswa kwengezwa ku-
~/.codex/hooks.json. - OpenCode: I-plugin ifakwa ku-
~/.config/opencode/plugins/abide.js.
Faka i---project lapho ufuna ukufakwa ezingeni le-repository okungatholwa ozakwenu kanye ne-checkout:
npx @coldtea/abide init claude --projectI-Codex idinga esinye isinyathelo sokugunyaza. Qalisa i-Codex, faka u-
/hooks, bese wamukela okufakiwe okune kwama-hook e-Abide. I-Codex icela lokhu kugunyazwa kanye nge-hook entsha ngayinye.
Isinyathelo 3: Hlanganisa imithetho ye-repository
Qalisa i-coding agent yakho ngendlela evamile. Ekuqaleni kweseshini yokuqala, i-Abide ihlola ukuthi amafayela emiyalelo ashintshile yini. I-agent bese ihlanganisa imiyalelo esebenzayo ibe yi-.abide/rubric.json futhi ibike lokho ekutholile.
Ungaphinde uhlanganise ngaphambi kokuqala iseshini entsha:
abide compileYenza i-commit ye-.abide/rubric.json uma ufuna i-rubric ephoqelelekayo ye-repository ibonakale futhi ibuyekezwe yithimba. Isinqumo ngasinye sikhomba umthetho okuleli fayela futhi sicaphune umyalo wokuqala esathathwa kuwo.
Ukusetshenziswa okuyisisekelo
Vumela i-Abide ihlole ngokuzenzakalelayo ukuhlela kwe-agent
Uma isiqalisiwe, qala i-claude, i-codex, noma i-opencode ngendlela evamile. Akudingeki isevisi yangemuva ehlukile. Ake sithi umyalo uthi ama-API endpoint kumele asebenzise i-Yup futhi akumele aqinisekise okokufaka ngesandla. Uma i-agent ibhala i-guard eyenziwa ngesandla, i-Abide ingabuyisa umlayezo ofana nalo:
Abide: Lokhu kuhlelwa kubonakala kwephula umthetho ovela emiyalweni yale ndawo yokugcina ikhodi.
- Umthetho othi "api-validation-uses-yup" ovela ku-~/.codex/AGENTS.md emgqeni wama-65:
"Lapho ubhala iziphetho ze-API, UNGABHALI ukuqinisekiswa kokokufaka ngesandla.
Sebenzisa i-Yup (enemilayezo yokuqinisekisa ecacile) + ukubuyisa kusenesikhathi kusiphathi se-API".
(0.86)
Lungisa i-apps/web/src/pages/api/logout.ts manje, bese uqhubeka nomsebenzi.I-ejenti ithola isicelo sokulungisa futhi ingalungisa ukwephulwa ngaphambi kokuqhubeka. Ku-OpenCode, ukwephulwa kokuhlela kufakwa emiphumeleni yethuluzi. Ukwephulwa kwezinga lokujika kukhiqiza umlayezo owodwa wokulandelela ngemva kokujika.
Hlola izinguquko ezingaka-commitwa ngesandla
Sebenzisa check ukuhlola izinguquko zamanje ezingaka-commitwa ngendlela efanayo neyasetshenziswa ama-hook:
abide checkUngase futhi unikeze izindlela lapho ufuna ukunciphisa ububanzi bokuhlola:
abide check apps/web/src/pages/api/Hlola ikhodi ekhona
Umyalo othi audit uhlola amafayela akhona sengathi asanda kwakhiwa. Lokhu kuyasiza lapho wamukela i-Abide endaweni yokugcina ikhodi esivele ikhona:
abide audit src/Umphumela uhlanganisa isifinyezo ngomthetho kanye nohlu oluhlelwe ngefayela. I-README ibika ukuthi ukuhlola izindlela ze-API ezingama-33 kuhlelo lokusebenza lwangempela lwe-Next.js kuthathe cishe imizuzwana eyi-12 futhi kwabiza cishe isenti elilodwa, nakuba imiphumela yangempela incike endaweni yokugcina ikhodi nemithetho.
Buyekeza umsebenzi wemithetho
Qalisa umyalo wombiko ukuze ubone imithetho yakho, ukuthi yimiphi esebenzile, nokuthi yimiphi engakaze isebenze:
abide reportUkuze uthole umphumela ofundeka yimishini, engeza --json. Umphumela we-JSON uyatholakala futhi ku-check, audit, bench, naku-calibrate.
Qonda isikhathi semithetho nezinqumo
Umthetho ngamunye ohlanganisiwe usebenza kwesinye sezigaba ezimbili:
- Isigaba sokuhlela: Sisebenza ngemva kokuhlela ngakunye futhi sihlola leyo ngxenye eshintshiwe.
- Isigaba sokujika: Sisebenza kanye ekupheleni kokujika futhi sihlola umehluko ophelele ngokumelene nesithombe-sikhathi esathathwa ekuqaleni kokujika.
Ukuhlola kwezinga lokujika kubalulekile emibuzweni engenakuphendulwa ngokuhlela kokuqala kuphela, njengokuthi ingabe i-ejenti ingeze ukusebenza umsebenzisi angakucelanga. Ekupheleni kokujika, i-Abide iphinde isebenzise imithetho yesigaba sokuhlela ezinguqukweni ezidalwe ngemiyalo ye-shell.
Izinqumo zihlukaniswe zaba ngamabhande wamathuba:
- 0.8 noma ngaphezulu: I-ejenti iyalwa ukuba ilungise ukwephulwa.
- 0.5 kuya ngaphansi kuka-0.8: Kuboniswa inothi, kodwa i-ejenti ayiyalwa ukuba ilungise.
- Ngaphansi kuka-0.5: Akukho okuboniswayo.
Ukugeleza komsebenzi okuthuthukile
Linganisa imithetho ngomlando we-Git
Umthetho obhalwe kabi ungathola amaphuzu aphakathi ezinguqukweni eziningi ezingahlobene futhi ungakhiqizi imiphumela ewusizo. Umyalo wokulinganisa uhlola wonke umthetho ngokumelene nezingxenye zangempela zakamuva ezivela emlandweni we-Git wendawo yokugcina ikhodi:
abide calibrateI-Abide isebenzisa izingxenye zakamuva ezingamashumi amabili kule nqubo futhi ingacisha imithetho engasebenzi kahle. Buyekeza umphumela ngaphambi kokuthembela ku-rubric esanda kuhlanganiswa eqenjini lonke.
Lungisa imithetho engakaze isebenze
Ngemva kokuthola imithetho engasebenzi kahle, sebenzisa tune ukuze i-ejenti iyibhale kabusha:
abide tuneNgenxa yokuthi okufakiwe ngakunye kwe-rubric kucaphuna umyalo wakho wokuqala, isinqumo esingabazekayo singalandelwa emuva kuye ekubhalweni okusikhiqizile. Ukuthuthukisa umyalo oyisisekelo ngokuvamile kwenza ukuhlola okuhambisanayo kucace kakhudlwana.
Dlala futhi izikhathi zangaphambilini zama-ejenti
Sebenzisa replay ukwahlulela izikhathi zangaphambilini ezivela kwelinye lama-ejenti asekelwayo:
abide replay claude
abide replay codex
abide replay opencodeLokhu kungakusiza uhlole i-rubric emsebenzini osuvele wenziwe esikhundleni sokulinda ukwephulwa okuzayo.
Linganisa ukubambezeleka kwasendaweni nezindleko
Qalisa umyalo wokulinganisa ukusebenza nezindleko emshinini wakho:
abide benchIndawo yokugcina ikhodi ibika ukuthi ukuhlola imithetho yayo eyi-13 kusebenzisa cishe amathokheni okufaka angu-1,000 kuya ku-1,600, kubiza cishe $0.00004 kuya ku-$0.00007 ekuhloleni ngakunye, futhi kuthatha cishe ama-millisecond angu-300 ku-Jev. Lezi zibalo zikalwe ngokuqondile ngokumelene ne-TypeSafe futhi zingahluka, ngakho-ke ukulinganisa kwasendaweni kuyisiqondiso esingcono sokusetha kwakho.
Sebenzisa izikophu ukuze ugcine imibuzo ibalulekile
Imithetho eku-.abide/rubric.json ingafaka izikophu ezisekelwe ku-glob. Sebenzisa lezi zikophu lapho umyalo usebenza kumafayela athile kuphela. Isibonelo, imithetho yokuqinisekisa ingaba ngeyezindlela ze-API, kanti imithetho yesitayela kufanele ikhawulelwe kumafayela esitayela. Izikophu ezincane zinciphisa izinqumo ezingahlobene futhi zenze kube lula ukuqonda izinqumo.
Ubumfihlo nokuziphatha lapho kwehluleka
Imigqa eshintshiwe ithunyelwa ku-TypeSafe kusetshenziswa ukhiye wakho, kucelwa ukugcinwa kwedatha okunguziro kukho konke ukushaya. I-README ithi le datha ayithunyelwa kuseva ephethwe yi-Abide.
Ama-hook e-Abide aklanyelwe ukuthi angaphazamisi isikhathi se-ejenti. Izindlela zama-hook ziphuma ngempumelelo, zisebenzisa umnqamulajuqu oqinile, futhi ziphrinta kuphela okulindelwe umsingathi. Uma kungekho khiye noma inethiwekhi ingatholakali, ukuhlela kuyaqhubeka ngaphandle kokuhlolwa. Ukuhlolwa okuphuthelwe kubhalwa ku-.abide/events.jsonl, futhi abide report ikufaka ezibalweni zayo.
Khipha i-Abide
Susa i-Abide kuwo wonke ama-ejenti efakwe kuwo:
abide uninstallUkuze ususe ukuhlanganiswa okukodwa kuphela, qamba i-ejenti:
abide uninstall codexEngeza --project lapho ususa ukufakwa kwezinga lephrojekthi. Ukukhipha kususa kuphela okufakiwe okungokwe-Abide. Kushiya amafayela e-rubric kanye ne-~/.abide/.env endaweni yawo kuze kube uyawasusa ngesandla.
Isiphetho
I-Abide iguqula imiyalelo yenqolobane ebhalwe ngolimi lwemvelo ibe ukuhlola okusebenza kuyo yonke iseshini yokubhala ikhodi ngosizo lwe-AI. Faka ama-hook afanele, hlanganisa futhi ubuyekeze i-.abide/rubric.json, bese usebenzisa ukuhlola okuzenzakalelayo, ukuhlolwa okubanzi, imibiko, ukulinganisa, nokulungisa ukuze ugcine imithetho isebenza kahle. Umphumela uba ungqimba olulula lokuphoqelela izimiso amalintha endabuko angenakuziveza.
