# zcf — Zero-Config Setup for Claude Code & Codex

> Zero-config initializer for Claude Code and Codex: one `npx zcf i` sets up workflows, routing, and optional MCP pieces in minutes.

## Install

Copy the content below into your project:

## Quick Use

1. Open the interactive menu:
   ```bash
   npx zcf
   ```
2. Full initialization:
   ```bash
   npx zcf i
   ```
3. Update workflows later:
   ```bash
   npx zcf u
   ```

## Intro

Zero-config initializer for Claude Code and Codex: one `npx zcf i` sets up workflows, routing, and optional MCP pieces in minutes.

- **Best for:** developers who want a fast, repeatable local setup for Claude Code/Codex with fewer manual config steps
- **Works with:** Node.js, Claude Code/Codex toolchains; optional routing/MCP components depending on your choices
- **Setup time:** 10–25 minutes

## Practical Notes

- Quant: keep a baseline of 3 commands (`npx zcf`, `npx zcf i`, `npx zcf u`) and measure “time-to-first-run” after a clean machine setup.
- Quant: track how many config files are touched in your repo; fewer moving parts usually means fewer breakages.

---

## What “zero-config” should mean in practice

Treat it as a *repeatable installer*, not magic:

- It should be safe to re-run (`update` should not clobber local customizations).
- It should create a small number of well-known files.
- It should make failures obvious (clear logs + next action).

## How to adopt in a team

1. Run initialization in a sandbox repo first.
2. Commit only the minimal workflow/config artifacts you actually want shared.
3. Document a rollback: what to delete to return to a clean state.

## When not to use it

If your org already has an internal bootstrapper, keep one source of truth and integrate zcf as an optional module instead of competing installers.

### FAQ

**Q: Is `npx` required?**
A: The README promotes `npx` as the simplest path; keep Node.js available on your PATH.

**Q: How do I keep custom config?**
A: Commit only the shared artifacts and document which files are owned by zcf vs owned by your repo.

**Q: What should I test first?**
A: A clean install on a fresh machine/container and a one-command update path.

## Source & Thanks

> Source: https://github.com/UfoMiao/zcf
> License: MIT
> GitHub stars: 5,980 · forks: 419

---

<!-- ZH -->

## 快速使用

1. 打开交互式菜单：
   ```bash
   npx zcf
   ```
2. 一键完整初始化：
   ```bash
   npx zcf i
   ```
3. 后续仅更新工作流：
   ```bash
   npx zcf u
   ```

## 简介

Claude Code/Codex 的零配置初始化器：一条 `npx zcf i` 即可完成工作流、路由与可选 MCP 组件的安装配置，并支持双语界面、常用预设与一键更新，让环境从 0 到可用更快、更稳。

- **适合谁：** 想把 Claude Code/Codex 本地环境搭建做成可复用的一键流程的开发者
- **可搭配：** Node.js、Claude Code/Codex 工具链；按选择可包含路由与 MCP 组件
- **准备时间：** 10–25 分钟

## 实战建议

- 量化建议：固定 3 条命令（`npx zcf`/`i`/`u`），在全新机器上测量从 0 到首次跑通的耗时。
- 量化建议：统计初始化改动的配置文件数量；可控的“变更面”通常意味着更少的后续故障。 

## “零配置”落地应该是什么样

把它当作**可重复执行的安装器**：

- 可反复运行（更新不应覆盖你的定制）。
- 只生成少量、命名清晰的文件。
- 失败要“可见且可修复”（日志清楚 + 下一步明确）。

## 团队化采用方式

1. 先在 sandbox 仓库试跑。
2. 只提交你确实希望团队共享的最小配置/工作流产物。
3. 写明回滚步骤：删哪些文件可以回到干净状态。

## 不适用场景

如果组织已有统一 bootstrap 工具，建议保持单一事实来源；把 zcf 作为可选模块集成，而不是并行两套安装器。

### FAQ

**必须用 `npx` 吗？**
答：README 推荐 `npx` 作为最简单路径；确保 Node.js 在 PATH 中即可。

**怎么保留自定义配置？**
答：只提交共享产物，并明确哪些文件由 zcf 管、哪些由仓库自己维护。

**优先测试什么？**
答：全新环境从 0 安装 + 一键更新路径是否稳定可用。

## 来源与感谢

> Source: https://github.com/UfoMiao/zcf
> License: MIT
> GitHub stars: 5,980 · forks: 419


---
Source: https://tokrepo.com/en/workflows/zcf-zero-config-setup-for-claude-code-codex
Author: Agent Toolkit