Lähe põhisisu juurde
Eesti— Vali keel
Menüü

Seadista oma keskkond ja AGENTS.md

Õppetund 3 / 20 Värskendatud 3. november 2026 Arendajatele
Sellel lehel
  1. Valmista oma projekt Codexi jaoks ette
  2. 1. samm: Sinu Codexi juurdepääs
  3. 2. samm: Paigalda redaktori laiendus
  4. 3. samm: Paigalda CLI
  5. Fail AGENTS.md – sinu projekti juhend
  6. Parimad tavad AGENTS.md jaoks
  7. Peamised punktid

Uuendatud 3. novembril 2026 põhinedes Codexi dokumentatsioonil (Codex CLI, Autentimine, Codexi IDE laiendus, Kohandatud juhised koos AGENTS.md-ga): paketti @openai/codex-cli ja käsku codex auth login ei eksisteeri (kasuta npm install -g @openai/codex ja codex login); laienduse identifikaator on openai.chatgpt; aadress codex.openai.com ning plaanid „Team“, „Enterprise“ või „API“ on asendatud praeguste juurdepääsuvõimalustega; ja AGENTS.md lugemisjärjestus on selgitatud (projekti juurkaust → praegune kataloog). Allikad: Codex CLI · Autentimine · AGENTS.md · Hinnakiri.

Valmista oma projekt Codexi jaoks ette

Enne esimest ülesannet peavad paigas olema kaks asja: sinu Codexi juurdepääs – sinu konto ja GitHubi ühendus – ning sinu projekt ise, mida kirjeldab agentile juhiseid andev fail AGENTS.md. Esimene osa võtab umbes 15 minutit ja on ühekordne seadistus. Teine osa määrab kõige kvaliteedi, mida Codexist saad, eristades meeskondi, kes on Codexiga rahul, nendest, kes leiavad selle pettumust valmistavat.

1. samm: Sinu Codexi juurdepääs

Saad Codexit kasutada kas ChatGPT kontoga või API võtmega. Tasuta ja Go plaanid võimaldavad sõltuvalt praegusest kasutuselevõtust juurdepääsu GPT-6 Lunale töölauarakenduses. Alates Plus plaanist on Codex saadaval veebis, CLI-s, redaktori laienduses ja iOS-is, koos pilveintegratsioonidega nagu automatiseeritud koodi ülevaatus. API võti sobib automatiseerimiseks jagatud keskkondades nagu CI, kasutades CLI-d, SDK-d või laiendust – kuigi mõned funktsioonid ei pruugi olla kättesaadavad. Üksikasjad ja kasutuspiirangud leiad Codexi hinnakirja lehelt.

Pilves oma hoidlate kallal töötamiseks ühenda GitHub, kui lood oma esimese Codex Cloudi keskkonna (2. õppetund). Õiguste andmisel hoia need minimaalsena: piira juurdepääsu ainult nende hoidlatega, mida tegelikult vajad.

2. samm: Paigalda redaktori laiendus

VS Code’is ja selle derivaatides (Cursor, Windsurf) paigalda turuplaadilt Codexi laiendus – selle identifikaator on openai.chatgpt:

code --install-extension openai.chatgpt

Seejärel ava Codex selle ikooni kaudu või käsupaleti abil valikuga Codex: Open Codex Sidebar ja logi sisse. Xcode’il ja JetBrainsi IDE-del on oma integratsioonid: JetBrainsis ava AI Chat ja vali Codex.

3. samm: Paigalda CLI

# Paigaldamine (macOS ja Linux), või npm install -g @openai/codex
curl -fsSL https://chatgpt.com/codex/install.sh | sh

# Kontrolli paigaldust
codex --version

# Logi sisse (brauseris), või kontrolli ühenduse olekut
codex login
codex login status

codex login avab sisselogimisvoogu sinu brauseris. API võtme kasutamisel edasta see standardsisendi kaudu (printenv OPENAI_API_KEY | codex login --with-api-key). Codex vahendab mandaate kas lihttekstifailis ~/.codex/auth.json või süsteemi võtmehoidlas, sõltuvalt seadistusest cli_auth_credentials_store (file, keyring, auto või ephemeral). Kui kasutatakse faili, kohtle seda nagu parooli: see sisaldab juurdepääsutokeneid, seega ära kunagi salvesta seda hoidlasse. CLI ja laiendus jagavad seda vahemälu.

Fail AGENTS.md – sinu projekti juhend

AGENTS.md on Codexi tõhusaks kasutamiseks keskne element. See on lihtne Markdown-fail, mis asetatakse hoidla juurkausta ja kogub kokku sinu projektile omased juhised, konventsioonid ja käsud. Kui Codex hoidla kloonib, loeb ta seda faili esimesena: mõtle sellele kui automaatsele sisseelamisele agendi jaoks, täpselt nii, nagu selgitaksid seda suuliselt uuele meeskonnaliikmele.

Mõju on kohene. Ilma AGENTS.md-ta, kui palud luua ühiktesti projektile, mis kasutab Vitesti, on suur tõenäosus, et Codex annab sulle Jesti, sest see on ökosüsteemis levinuim valik. Ainult üks rida konventsioone piisab, et saada Vitest kohe õigesti, säästes sind sama paranduse sajast kordamisest. Siin on baasfaili struktuur SaaS-i arvehalduse projekti jaoks.

# AGENTS.md

## Projekti kontekst
SaaS-i arvehalduse rakendus.
Stack: Next.js 15, TypeScript, Prisma, PostgreSQL.

## Koodi konventsioonid
- Kasuta Reacti funktsionaalseid komponente (ilma klassideta)
- Nimeta failid kebab-case'is
- TypeScripti tüübid eraldatud .types.ts failides
- Testid Vitestiga, .test.ts failid koodi kõrval

## Kasulikud käsud
- `npm run dev` — arendusserver
- `npm run test` — testide käivitamine
- `npm run lint` — lintimise kontroll
- `npm run build` — tootmisversiooni build

## Projekti struktuur
    src/
      app/          → Next.js lehed (App Router)
      components/   → Taaskasutatavad Reacti komponendid
      lib/          → Ärilogika ja utiliidid
      prisma/       → Andmebaasi skeem ja migratsioonid

## ranged reeglid
- ÄRA KUNAGI muuda Prisma skeemi ilma migratsioonita
- ÄRA KUNAGI salvesta .env faile hoidlasse
- Kasuta mutatsioonide jaoks alati Server Actions'e

Kuidas Codex leiab AGENTS.md faile

Üksainus juurfail muutub kiiresti liiga üldiseks. Codex võimaldab sul virnastada juhiseid täpses järjekorras, mida pead teadma:

  1. Globaalne tase: Sinu Codexi kaustas (~/.codex, välja arvatud kui CODEX_HOME seda üle kirjutab) loeb Codex faili AGENTS.override.md, kui see eksisteerib, vastasel juhul AGENTS.md.
  2. Projekti tase: Alates projekti juurkaustast (tavaliselt Git-i juur) laskub Codex praegusesse kataloogi ja loeb igas läbitud kaustas faili AGENTS.override.md või selle puudumisel AGENTS.md.
  3. Liitmine: Failid liidetakse juurest kuni praeguse kataloogini; need, mis asuvad praegusele kataloogile kõige lähemal, tulevad viimasena ja seega tühistavad üldisemaid juhiseid.
my-project/
  AGENTS.md              → Projekti juhised
  src/
    api/
      AGENTS.md          → „API marsruudid kasutavad valideerimiseks Zodi“

Praktiline tagajärg: src/api/AGENTS.md loetakse ainult siis, kui Codex töötab kaustast src/api või selle alamkataloogist, mitte kui see käivitatakse juurkaustast. Tühjad failid jäetakse tähelepanuta ja liitmine peatub vaikimisi 32 KiB juures (project_doc_max_bytes). Kui sinu hoidla kasutab juba mõnda muud nime, nagu TEAM_GUIDE.md, lisa see väärtusena project_doc_fallback_filenames jaoks failis ~/.codex/config.toml.

Et kontrollida, mida Codex tegelikult laadis, küsi lihtsalt: codex --ask-for-approval never "Summarize the current instructions.". Codex taastab juhiste ahela iga käivitamise korral: kui kahtled, taaskäivita see õiges kataloogis.

Parimad tavad AGENTS.md jaoks

Juhtivaks põhimõtteks on selgesõnalisus. „Kasuta Vitesti, mitte Jesti“ on parem kui „Kasuta meie testiraamistikku“, mis eeldab teadmisi, mida agentil pole. Lisa alati käsud: ilma nendeta ei tea Codex, kuidas käivitada sinu teste, linterit või buildi, ja ta edastab koodi, mida ta ei saanud kontrollida. Dokumenteeri struktuur kataloogipuuna, mis takistab tal pimesi uurimast ja faile valesse kohta loomast.

Lõpetuseks loetle keelud. Reeglid, mis on sõnastatud kui „MITTE KUNAGI“, on failis kõige kuluefektiivsemad, sest need blokeerivad kallid vead, mida on raske parandada: .env faili hoidlasse salvestamine, skeemi muutmine ilma migratsioonita. Kõige raskem distsipliin on hoida faili ajakohasena. AGENTS.md, mis kirjeldab eelmise aasta projekti, suunab Codexit aktiivselt mahajäetud konventsioonide poole – see on palju halvem kui faili üldse mitte omamine, kuna viga muutub siis süstemaatiliseks.

Peamised punktid

  • Esmane seadistus nõuab OpenAI kontot ja GitHubi ühendust
  • IDE laiendus ja CLI paigaldatakse mõne minutiga
  • AGENTS.md on Codexi tõhusaks kasutamiseks kõige olulisem fail
  • See sisaldab sinu projektile omaseid konventsioone, käske ja reegleid
  • Alamkataloogides olevad AGENTS.md failid võimaldavad kontekstipõhiseid juhiseid