You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: QUICKSTART.ko.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ uv run repoagents ops status
38
38
cat .ai-repoagents/reports/ops/latest.json
39
39
```
40
40
41
-
`uv run repoagents init`을 플래그 없이 실행하면 대화형 초기화가 시작됩니다. 초기 설정을 deterministic mock backend로 두고 싶다면 `--backend mock`을 사용하면 됩니다. GitHub 없이 로컬 JSON inbox로만 돌리려면 `--tracker-kind local_file`를 사용하면 됩니다.
41
+
`uv run repoagents init`을 플래그 없이 실행하면 대화형 초기화가 시작됩니다. GitHub 없이 로컬 JSON inbox로만 돌리려면 `--tracker-kind local_file`를 사용하면 됩니다. 라이브 Codex 세션 없이 오프라인 walkthrough를 하고 싶다면 저장소에 포함된 demo script가 결정적인 fake `codex` shim을 자동으로 설치합니다.
Copy file name to clipboardExpand all lines: QUICKSTART.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ uv run repoagents ops status
36
36
cat .ai-repoagents/reports/ops/latest.json
37
37
```
38
38
39
-
Running `uv run repoagents init` without flags starts an interactive setup flow. Use `--backend mock` if you want the initialized config to default to the deterministic mock backend. Use `--tracker-kind local_file`when you want a local JSON inbox instead of GitHub.
39
+
Running `uv run repoagents init` without flags starts an interactive setup flow. Use `--tracker-kind local_file` when you want a local JSON inbox instead of GitHub. The repo-level demo scripts install a deterministic fake `codex` shim when you want offline walkthroughs without a live Codex session.
40
40
41
41
Generated control files:
42
42
@@ -106,11 +106,16 @@ That wrapper runs `repoagents release check --format all`, which executes releas
106
106
```bash
107
107
cd examples/python-lib
108
108
uv run repoagents init --preset python-library --fixture-issues issues.json --tracker-repo demo/python-lib
109
+
uv run --project /path/to/RepoAgents python -m repoagents.testing.fake_codex \
- 로컬 오프라인 tracker는 `.ai-repoagents/sync/<tracker>/issue-<id>/` 아래에 publish proposal을 stage할 수 있습니다.
96
97
- 로컬 Markdown tracker는 쓰기가 켜져 있으면 publish 제안을 `.ai-repoagents/sync/local-markdown/issue-<id>/` 아래에 stage합니다.
98
+
- 저장소에 포함된 demo script는 오프라인 walkthrough를 위해 결정적인 fake `codex` shim을 자동으로 설치합니다.
97
99
-`uv run repoagents init --upgrade`는 로컬 managed 파일을 덮어쓰지 않고 scaffold drift를 점검합니다.
98
100
99
101
### preset 고르기
@@ -102,6 +104,7 @@ preset은 핵심 `triage -> planner -> engineer -> reviewer` 파이프라인 자
102
104
103
105
| preset | 잘 맞는 저장소 | 기본적으로 더 강조하는 것 | 이런 경우 고르기 좋음 |
104
106
| --- | --- | --- | --- |
107
+
|`none`| 저장소 유형별 튜닝 없이 공통 RepoAgents 기본값만 쓰고 싶은 저장소 | 중립적인 워크플로 가이드, 명시적인 리스크 표면화, 최소한의 도메인 가정 | preset별 정책 편향 없이 시작하고 나중에 스캐폴드를 다듬고 싶을 때 |
105
108
|`python-library`| Python 패키지, CLI, API, 백엔드 서비스 | 작은 Python 코드 변경, 집중된 테스트, 패키징 위생, API surface 변경 요약 | 저장소의 중심이 `src/`, `tests/`, `pyproject.toml`에 있거나, 가장 무난한 기본값으로 시작하고 싶을 때 |
106
109
|`web-app`| 프론트엔드 앱, UI가 있는 풀스택 저장소 | 컴포넌트/라우트 단위 변경, 시각적 회귀 경계, env/deploy 설정 주의 | 페이지, 정적 자산, 라우트, 서버/클라이언트 코드가 함께 있고 UI 깨짐과 설정 drift가 중요할 때 |
107
110
|`docs-only`| 문서 사이트, 핸드북 저장소, 스펙 저장소, 예제 중심 문서 프로젝트 | Markdown과 문서 도구, 예제, 복붙 정확성 유지, 명시적 요청 없는 코드 변경 억제 | 저장소의 주된 산출물이 문서이고, 제품 코드 변경은 예외적으로만 허용하고 싶을 때 |
@@ -110,6 +113,7 @@ preset은 핵심 `triage -> planner -> engineer -> reviewer` 파이프라인 자
110
113
실전 기준으로 고르면:
111
114
112
115
- 애매하면 `python-library`부터 시작하는 편이 가장 안전합니다.
116
+
- 저장소 성격을 아직 정하지 않았거나 공통 기본값만 원하면 `none`을 고르면 됩니다.
113
117
- 브라우저/UI 동작이 리뷰 범위에 직접 들어오면 `web-app`이 더 잘 맞습니다.
114
118
- “요청 없이는 제품 코드를 건드리지 않는 것”이 핵심이면 `docs-only`가 좋습니다.
Copy file name to clipboardExpand all lines: README.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,11 +89,13 @@ uv run repoagents doctor
89
89
Useful setup variations:
90
90
91
91
-`uv run repoagents init` starts the interactive setup flow.
92
-
-`uv run repoagents init --backend mock` seeds the repo with the deterministic mock backend.
92
+
- the interactive preset picker supports arrow-key selection and includes a `none` option for the shared baseline scaffold.
93
+
- when `tracker.kind=github`, interactive init can verify the tracker repo with `gh` and offer to create it with a `public` or `private` visibility choice if it does not exist yet.
93
94
-`uv run repoagents init --tracker-kind local_file --tracker-path issues.json` uses a local JSON inbox instead of GitHub.
94
95
-`uv run repoagents init --tracker-kind local_markdown --tracker-path issues` uses a local Markdown issue directory.
95
96
- local offline trackers can stage publication proposals under `.ai-repoagents/sync/<tracker>/issue-<id>/`.
96
97
- local Markdown trackers with writes enabled stage publication proposals under `.ai-repoagents/sync/local-markdown/issue-<id>/`.
98
+
- repo-level demo scripts install a deterministic fake `codex` shim for offline walkthroughs.
97
99
-`uv run repoagents init --upgrade` inspects managed scaffold drift without overwriting local managed-file edits.
98
100
99
101
### Choosing a preset
@@ -102,6 +104,7 @@ Presets do not change the core `triage -> planner -> engineer -> reviewer` pipel
102
104
103
105
| Preset | Best for | What it biases toward | Pick it when |
104
106
| --- | --- | --- | --- |
107
+
|`none`| Repositories that want the shared RepoAgents baseline without repo-type tuning | Neutral workflow guidance, explicit risk surfacing, and minimal domain assumptions | You want to start without preset-specific policy bias and refine the scaffold later |
105
108
|`python-library`| Python packages, CLIs, APIs, and backend services | Small Python code changes, focused tests, packaging hygiene, and explicit API-surface notes | Most of the repo lives in `src/`, `tests/`, and `pyproject.toml`, or you want the safest default starting point |
106
109
|`web-app`| Frontend apps or full-stack repos with UI and deployment concerns | Focused component/route changes, visual-regression awareness, and careful handling of env/deploy config | The repo ships pages, assets, routes, or server/client code where UI breakage and config drift matter |
107
110
|`docs-only`| Documentation sites, handbook repos, specs, or example-heavy docs projects | Staying inside Markdown, docs tooling, examples, and copy/paste accuracy unless code edits are explicitly requested | The repository is primarily prose and reference material, and maintainers want code changes to stay exceptional |
@@ -110,6 +113,7 @@ Presets do not change the core `triage -> planner -> engineer -> reviewer` pipel
110
113
Practical rule of thumb:
111
114
112
115
- Start with `python-library` if the repo is mostly application or library code and you are unsure.
116
+
- Use `none` when you want the baseline RepoAgents scaffold without repository-type tuning.
113
117
- Use `web-app` when browser/UI behavior is part of the review surface, not just implementation detail.
114
118
- Use `docs-only` when “do not wander into product code unless asked” is the main requirement.
115
119
- Use `research-project` when preserving experiment context matters more than keeping the tree tidy.
@@ -161,7 +165,7 @@ The operating model stays in the repo, so maintainers can inspect and evolve it
161
165
162
166
## Demo Paths
163
167
164
-
The examples are designed for local fixture issues and the mock backend. That keeps demos deterministic while preserving the production architecture.
168
+
The examples are designed for local fixture issues and an offline fake `codex` shim. That keeps demos deterministic while preserving the production architecture.
165
169
166
170
Recommended first runs:
167
171
@@ -198,11 +202,16 @@ Recommended first runs:
198
202
```bash
199
203
cd examples/python-lib
200
204
uv run repoagents init --preset python-library --fixture-issues issues.json --tracker-repo demo/python-lib
205
+
uv run --project /path/to/RepoAgents python -m repoagents.testing.fake_codex \
0 commit comments