codex-agent-repository-kit/agent-quickstart.md

Agent Quickstart

Use this file when you want Codex to apply the repository kit with minimal instructions.

New Repository Prompt

Apply the Codex Agent Repository Kit from templates/codex-project.
Use new-repository.md as the workflow.
Create the smallest useful baseline for this repository.
Detect the stack and replace placeholders with real project values.
Keep commands truthful: do not add commands that cannot run.
Keep the README generator only if it adds value.
Do not create a release.
Run the cheapest available verification before finishing.

Existing Repository Prompt

Apply the Codex Agent Repository Kit from templates/codex-project.
Use existing-project.md as the workflow.
Preserve existing code, README knowledge, CI behavior, and project style.
Add missing Codex agent context, security review, release checklist, and optional README generator files.
Keep commands truthful: do not add commands that cannot run.
Do not create a release.
Run the cheapest available verification before finishing.

Agent Decision Tree

Is this a fresh repo?
  yes -> use new-repository.md
  no  -> use existing-project.md

Does the project already have README structure?
  yes -> preserve it; only add blueprint files if useful
  no  -> add blueprint.md and blueprint.json

Does the project produce artifacts?
  yes -> add downloads/artifacts section and release checklist
  no  -> keep downloads section minimal or remove it

Does the project have CI?
  yes -> patch existing workflow
  no  -> add .gitea/workflows/build.yml only when commands are known

Are commands unknown?
  yes -> document PENDING in .codex/project.md
  no  -> wire commands into AGENTS.md and CI

Is this a private Gitea repo with Actions?
  yes -> if GITEA_TOKEN is set locally, use it for read-only API checks of repository and workflow-run status
  no  -> use public web/API checks when available

Did you push a commit that should trigger a workflow?
  yes -> check the workflow run; if it fails, inspect logs, fix in scope, push again, and re-check
  no  -> finish with local verification status

Minimal File Set

For tiny projects:

AGENTS.md
.codex/project.md
README.md
SECURITY.md
CHANGELOG.md

For releasable projects:

AGENTS.md
.codex/project.md
README.md
SECURITY.md
CHANGELOG.md
docs/release-checklist.md
docs/security-review.md
.gitea/workflows/build.yml

For README-generator projects:

blueprint.md
blueprint.json
README.md