# freestylefly/CodexGuide

CodexGuide：面向全球初学者、创作者、开发者与团队的 Codex 实践指南

Repository: https://github.com/freestylefly/CodexGuide
Canonical: https://ross.abutalabs.com/products/codexguide
Homepage: https://codexguide.ai
Language: TypeScript
License: MIT
License Family: permissive
Last push: 2026-08-20T06:38:19+00:00

## Health v2 (maintenance only)
Score: 58/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 98, release rhythm 35, longevity 8
- inputs: {"age_days": 124, "days_push": 13, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, young
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3302, forks 313 (observed 2026-08-28T04:07:55.666907+00:00)

## What it is
CodexGuide is an open-source, community-maintained practical guide (in Chinese and English) for OpenAI Codex, covering the desktop app, CLI, Cloud, and IDE usage from beginner setup to advanced workflows. It is published as a documentation website (codexguide.ai) with learning paths, quick-start tutorials, real-world recipes, and a theme gallery.

## Use cases
- learn how to install and use OpenAI Codex CLI
- set up the Codex desktop app on macOS or Windows
- write AGENTS.md files for coding agents
- find real-world Codex workflow examples like CI auto-fix or browser automation
- understand Codex sandbox, permissions, and approval flows
- learn Codex skills and plugins for repeated tasks
- get a Chinese-language tutorial for AI coding assistants

## When to choose
- you are a beginner starting with OpenAI Codex and want a structured learning path
- you want practical, task-oriented recipes rather than a command cheat sheet
- you prefer Chinese-language documentation for Codex
- you want to integrate Codex into real workflows like CI, code review, or note-taking

## When to avoid
- you need official, authoritative Codex documentation - always verify against OpenAI's docs
- you want documentation for other AI coding tools like Claude Code or Cursor
- you need an interactive tool or software library rather than a guide

## Facets
- artifact type: learning-resource
- maturity: active
- function: documentation, developer-tools, prompt-engineering, agent-framework
- domain: tutorials, large-language-models, developer-tools, documentation
- platform: cross-platform, windows
- tags: openai-codex, coding-agent, chinese-tutorial, agentic-coding, vitepress-docs, cli-guide, workflow-automation, ai-agents, web-server, macos, linux

## Member repositories
- freestylefly/CodexGuide (main) score 58

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:55.666907+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:42:56.633255+00:00, confidence not recorded.
  - readme: https://github.com/freestylefly/CodexGuide (fetched 2026-08-28T04:07:55.666907+00:00, sha 44837d28565d)
  - homepage: https://codexguide.ai (fetched 2026-08-29T09:35:38.439186+00:00, sha d904b5a0dc05)
  - site_page: https://codexguide.ai/start/02-app-installation.html (fetched 2026-08-29T09:35:38.448286+00:00, sha 67548f7c610f)
  - site_page: https://codexguide.ai/start/10-cli-installation.html (fetched 2026-08-29T09:35:38.450074+00:00, sha 6d5a62564c83)
- Data as of 2026-08-30T08:39:29.467469+00:00.