Skip to content

arty-kk/codex-workflow

Repository files navigation

Русская версия

Codex Workflow Skills

A portable workflow layer for using Codex on real software projects.

This repository is not an application framework. It provides:

  • AGENTS.md — repository execution rules for Codex.
  • .agents/skills/ — reusable workflow skills for planning, implementation, frontend/design, validation, and platform work.
  • Use Cases.md — copy-paste commands for invoking the skills effectively.
  • scripts/validate.sh — local validation for skill metadata, bundled scripts, and repository hygiene.

Why use it

Use this package when you want Codex to work with repeatable execution standards instead of ad-hoc prompts:

  • build or repair project context before coding;
  • turn vague tasks into executable task contracts;
  • implement with bounded scope and repository evidence;
  • transform public/internal frontend surfaces with UI/UX skills;
  • choose and apply site design references as root DESIGN.md;
  • validate patches, builds, migrations, transactions, locks, and release readiness;
  • add practical platform workflows such as CI/CD, Nginx, Prometheus/Grafana, worker queues, OpenAI SDK setup, and external API integrations.

Repository layout

AGENTS.md
README.md
Use Cases.md
CONTRIBUTING.md
CHANGELOG.md
LICENSE
.github/
  workflows/
    validate.yml
scripts/
  validate.sh
.agents/
  skills/
    project-context/
    task-synthesis/
    implementation-workflow/
    frontend-product-design/
    site-references/
    ui-ux-pro-max/
    product-marketing-copy/
    validation-hardening/
    platform-ops/

Install into a project

Copy the workflow files into the root of the target repository:

cp -R AGENTS.md "Use Cases.md" .agents /path/to/your-project/

If the target project already has AGENTS.md, merge the rules instead of overwriting them.

Do not copy this repository README.md over a target project README. A target project README should describe that specific product and architecture. Use the project-context skill to create or repair it.

Start using it

Open Use Cases.md and copy the command that matches the task.

Examples:

Используй skill `project-context` для выполнения задачи: создать или обновить README.md как project context document. Код не меняй.
Используй skill `task-synthesis` для выполнения задачи: создать task_contract.md для <задача>. Код пока не меняй.
Используй skill `frontend-product-design` и `ui-ux-pro-max` для выполнения задачи: привести public frontend к production-quality уровню без изменения backend/domain logic.
Используй skill `site-references` для выполнения задачи: подобрать 3 site references для frontend направления проекта и рекомендовать один лучший. Код не меняй.

Skills

Skill Use it for
project-context README generation, repository map, project context repair, workflow routing.
task-synthesis Task contracts, clarification, high-impact issue discovery, evolution plans.
implementation-workflow Executing approved task contracts and safe behavior-preserving refactoring.
frontend-product-design Frontend audit, design contracts, visual assets, page/public/dashboard/internal UI transformation, visual QA.
site-references Local website reference selection and application as root DESIGN.md; use for “pick site references” and “make it like Apple/Vercel/Stripe/etc.” workflows.
ui-ux-pro-max Executable UI/UX and visual design workflows with data, scripts, references, and optional asset generation/sourcing.
product-marketing-copy Product positioning, landing/pricing/auth/onboarding copy, CTA clarity, microcopy without unsupported claims.
validation-hardening Patch checking, build/test gate, transaction/lock/idempotency review, database migration safety.
platform-ops Minimal CI/CD, release readiness, dependencies, security, API integrations, Nginx, OpenAI SDK, Prometheus/Grafana, worker queues.

Site references workflow

Use site-references when you want Codex to choose a visual reference before frontend work. The skill can shortlist references, apply one as root DESIGN.md, and then hand off implementation to frontend-product-design + ui-ux-pro-max.

Используй skill `site-references` для выполнения задачи: подобрать 3-5 site references под frontend-направление проекта, рекомендовать один лучший и объяснить выбор. Код не меняй.
Используй skill `site-references`, `frontend-product-design` и `ui-ux-pro-max` для выполнения задачи: применить reference apple и привести public frontend к этому visual direction без копирования бренда, логотипов, точного контента или fake claims.

Optional runtime keys

Some ui-ux-pro-max asset workflows can use external services. Never commit keys or .env files.

Use environment variables only:

OPENAI_API_KEY
PEXELS_API_KEY

If keys or network access are unavailable, the skills must produce deterministic specs, prompts, SVG/code, search queries, CSS treatments, or implementation guidance instead of faking generation.

Validate the package

Run:

bash scripts/validate.sh

The validator checks:

  • each skill has SKILL.md;
  • each skill frontmatter has only name and description;
  • folder names match skill names;
  • Use Cases.md references existing skills;
  • Python scripts compile;
  • .cjs scripts pass node --check when Node is available;
  • common junk, secrets, caches, old prompt folders, and generated artifacts are absent.

The GitHub Actions workflow runs the same validation on pushes and pull requests.

Contributing

See CONTRIBUTING.md.

Keep changes practical: improve execution quality, reduce ambiguity, or add a broadly reusable workflow skill. Avoid decorative docs, duplicate rules, or one-off project assumptions.

License

MIT. See LICENSE.

About

A portable workflow layer for using Codex cloud on any projects.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors