[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Claude Code][claude-code-src]][claude-code-href]
[![codecov][codecov-src]][codecov-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![Ask DeepWiki][deepwiki-src]][deepwiki-href]

ZCF - Zero-Config Code Flow

English | 中文 | 日本語 | Changelog

✨ Full Documentation: ZCF Docs

> Zero-config, one-click setup for Claude Code & Codex with bilingual support, intelligent agent system and personalized AI assistant

♥️ Sponsor AI API

302.AI is a pay-as-you-go enterprise AI resource hub that offers the latest and most comprehensive AI models and APIs on the market, along with a variety of ready-to-use online AI applications.

---

This project is sponsored by Z.ai, supporting us with their GLM CODING PLAN.
GLM CODING PLAN is a subscription service designed for AI coding, starting at just $3/month. It provides access to their flagship GLM-4.7 model across 10+ popular AI coding tools (Claude Code, Cline, Roo Code, etc.), offering developers top-tier, fast, and stable coding experiences.
Get 10% OFF GLM CODING PLAN：https://z.ai/subscribe?ic=8JVLJQFSKB

---

Thanks to PackyCode for sponsoring this project! PackyCode is a reliable and efficient API relay service provider, offering relay services for Claude Code, Codex, Gemini, and more. PackyCode provides special discounts for our software users: register using this link and enter the "zcf" promo code during recharge to get 10% off.

Thanks to AICodeMirror for sponsoring this project! AICodeMirror provides official high-stability relay services for Claude Code/Codex/Gemini CLI, supporting enterprise-level high concurrency, fast invoicing, and 7x24 dedicated technical support. Official channels for Claude Code/Codex/Gemini at discounts as low as 38%/2%/10.9% off, with additional discounts on top-ups! AICodeMirror offers special benefits for ZCF users: users who register through this link can enjoy 20% off on first top-up, and enterprise customers can get up to 25% off!

🚀 Quick Start

- Recommended: npx zcf opens the interactive menu and guides you through install/update.
- Common commands:

``bash
npx zcf i # Full initialization: install + workflows + API/CCR + MCP
npx zcf u # Update workflows only
npx zcf --lang zh-CN # Switch interface language (example)
`

- Non-interactive example (provider preset):

`bash
npx zcf i -s -p 302ai -k "sk-xxx"
``

More usage, options, and workflows: see documentation.

📖 Full Documentation

- https://zcf.ufomiao.com/

💬 Community

Join our Telegram group for support, discussions, and updates:


🙏 Acknowledgments

This project is inspired by and incorporates work from:

- LINUX DO - New Ideal Community
- CCR
- CCometixLine
- ccusage
- BMad Method

Thanks to these community contributors for sharing their amazing projects!

❤️ Support & Sponsors

If you find this project helpful, please consider sponsoring its development. Your support is greatly appreciated!


$3

A huge thank you to all our sponsors for their generous support!

【Corporate Sponsors】

- 302.AI (first corporate sponsorship 🤠)
- GLM (first AI model sponsorship 🤖)
- PackyCode (first API proxy service sponsor 🧝🏻‍♀️)
- AICodeMirror (official high-stability relay service sponsor 🪞)
- UUCode (sponsored $100 proxy credits 💰)

【Individual Sponsors】

- Tc (first sponsor)
- Argolinhas (first ko-fi sponsor ٩(•̤̀ᵕ•̤́๑))
- r\*r (first anonymous sponsor 🤣)
- \\康 (first KFC sponsor 🍗)
- \*东 (first coffee sponsor ☕️)
- 炼\*3 (first Termux user sponsor 📱)
- chamo101 (first GitHub issue sponsor 🎉)
- 初屿贤 (first Codex user sponsor 🙅🏻‍♂️)
- Protein (first 1688 sponsor 😏)
- musistudio (first open source project author sponsor, the author of CCR 🤩)
- BeatSeat (community expert 😎, provided $1000 Claude credits)
- wenwen (community expert 🤓, provided daily $100 Claude&GPT credits)
- 16°C coffee (My best friend 🤪, offered ChatGPT Pro $200 package)

$3

Thanks to the following authors for promoting this project:

- 逛逛 GitHub, article: https://mp.weixin.qq.com/s/phqwSRb16MKCHHVozTFeiQ
- Geek, tweet: https://x.com/geekbb/status/1955174718618866076

📄 License

MIT License

---

🚀 Contributors

⭐️ Star History

If this project helps you, please give me a ⭐️ Star!


[npm-version-src]: https://img.shields.io/npm/v/zcf?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/zcf
[npm-downloads-src]: https://img.shields.io/npm/dm/zcf?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/zcf
[license-src]: https://img.shields.io/github/license/ufomiao/zcf.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/ufomiao/zcf/blob/main/LICENSE
[claude-code-src]: https://img.shields.io/badge/Claude-Code-1fa669?style=flat&colorA=080f12&colorB=1fa669
[claude-code-href]: https://claude.ai/code
[codecov-src]: https://codecov.io/gh/UfoMiao/zcf/graph/badge.svg?token=HZI6K4Y7D7&style=flat&colorA=080f12&colorB=1fa669
[codecov-href]: https://codecov.io/gh/UfoMiao/zcf
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-1fa669?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/zcf
[deepwiki-src]: https://img.shields.io/badge/Ask-DeepWiki-1fa669?style=flat&colorA=080f12&colorB=1fa669
[deepwiki-href]: https://deepwiki.com/UfoMiao/zcf