ai-coding-guide  by stormzhang

AI programming CLI tutorials for beginners

Created 12 years ago
1,437 stars

Top 27.7% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

This repository offers a meticulously curated, beginner-friendly Chinese tutorial series for AI coding assistants Claude Code and Codex. It aims to demystify AI-powered command-line tools for novice users, enabling them to quickly master these technologies and integrate them into their development workflows, thereby reducing common pitfalls.

How It Works

The tutorial series prioritizes accuracy by grounding all content in official Claude Code and Codex documentation, rigorously verifying features and commands. It employs a unique three-part explanation structure (scenario, analogy, practice) and incorporates real-world developer experiences, including specific pitfalls and solutions. Each lesson provides runnable commands with expected outputs, facilitating immediate hands-on validation and learning.

Quick Start & Requirements

The tutorial content itself is free under the MIT license. However, utilizing the covered AI tools, Claude Code and Codex, necessitates paid subscriptions (starting at $20/month) or API access. A VPN is required for tool installation, login, and usage. The initial "Basic Introduction" section caters to users with no prior command-line experience.

Highlighted Details

  • Features 92 comprehensive Chinese articles, split into 53 for Claude Code and 39 for Codex.
  • Claude Code coverage spans from installation to advanced topics like proxy loops, MCP, sub-agents, Skills, Hooks, Agent SDK, and GitHub Actions.
  • Codex content includes entry points, AGENTS.md, sandbox approval, config.toml, Chronicle memory, Worktrees, and migration guides.
  • Includes 64 original SVG/PNG illustrations with a consistent dark theme and minimal text.
  • The tutorial site is built with VitePress, featuring a Catppuccin Mocha theme and Shiki syntax highlighting.

Maintenance & Community

The project is marked as stable (🟢) with all 92 articles finalized and reviewed. Future updates will focus on incremental fixes and potentially new articles for emerging AI tools. Contributions are welcomed via Issues for corrections and PRs for improvements. Specific community channels like Discord or Slack are not listed.

Licensing & Compatibility

The tutorial content is licensed under MIT, permitting broad use and distribution. While the tutorial is free, the underlying AI tools (Claude Code, Codex) require paid subscriptions. The MIT license generally allows for integration into commercial or closed-source projects.

Limitations & Caveats

Users must be aware of the recurring costs associated with Claude Code and Codex subscriptions and the mandatory requirement for a VPN. The tutorial's scope is limited to the features and functionalities of these specific AI tools as documented at the time of writing.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
9
Issues (30d)
24
Star History
535 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.