Repository navigation
docs(engine): clarify ENGINE_V2 opt-in startup #2694
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -286,15 +286,26 @@ WASM ──► 화이트리스트 ──► 누출 스캔 ──► 자격 증 | |||||
|
|
||||||
| ## 사용법 | ||||||
|
|
||||||
| Engine v2는 현재 옵트인입니다. 기존 에이전트 루프 대신 새 엔진을 사용하려면 `ENGINE_V2=true`를 설정해서 IronClaw를 시작하세요. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This localized README is missing the link to the Engine v2 architecture documentation that was added to the main
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| # 첫 설정 (데이터베이스, 인증 등 구성) | ||||||
| ironclaw onboard | ||||||
|
|
||||||
| # 대화형 REPL 시작 | ||||||
| # 설치된 바이너리 시작 | ||||||
| ironclaw | ||||||
|
|
||||||
| # Engine v2로 설치된 바이너리 시작 | ||||||
| ENGINE_V2=true ironclaw | ||||||
|
|
||||||
| # 소스에서 대화형 REPL 시작 | ||||||
| cargo run | ||||||
|
|
||||||
| # 디버그 로깅 사용 | ||||||
| RUST_LOG=ironclaw=debug cargo run | ||||||
| # 소스에서 Engine v2 대화형 REPL 시작 | ||||||
| ENGINE_V2=true cargo run | ||||||
|
|
||||||
| # Engine v2를 디버그 로깅과 함께 시작 | ||||||
| ENGINE_V2=true RUST_LOG=ironclaw=debug cargo run | ||||||
| ``` | ||||||
|
|
||||||
| ## 개발 | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -286,15 +286,20 @@ External content passes through multiple security layers: | |||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Usage | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Engine v2 is opt-in right now. If you want to run the new engine instead of the legacy agent loop, start IronClaw with `ENGINE_V2=true`. See [Engine v2 architecture](docs/internal/engine-v2-architecture.md#enabling-engine-v2) for more details. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
| # First-time setup (configures database, auth, etc.) | ||||||||||||||||||||||
| ironclaw onboard | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # Start interactive REPL | ||||||||||||||||||||||
| cargo run | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # With debug logging | ||||||||||||||||||||||
| RUST_LOG=ironclaw=debug cargo run | ||||||||||||||||||||||
| # Start interactive REPL with engine v2 | ||||||||||||||||||||||
| ENGINE_V2=true cargo run | ||||||||||||||||||||||
|
Comment on lines
+298
to
+299
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The main
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # Engine v2 with debug logging | ||||||||||||||||||||||
| ENGINE_V2=true RUST_LOG=ironclaw=debug cargo run | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Development | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -281,15 +281,26 @@ WASM ──► Валидатор ──► Сканер ───► Инъек | |||||
|
|
||||||
| ## Использование | ||||||
|
|
||||||
| Сейчас engine v2 включается отдельно. Если вы хотите запускать новый движок вместо устаревшего цикла агента, запускайте IronClaw с `ENGINE_V2=true`. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This localized README is missing the link to the Engine v2 architecture documentation that was added to the main
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| # Первоначальная настройка (БД, аутентификация и т.д.) | ||||||
| ironclaw onboard | ||||||
|
|
||||||
| # Запуск интерактивного REPL | ||||||
| # Запуск установленного бинарника | ||||||
| ironclaw | ||||||
|
|
||||||
| # Запуск установленного бинарника с engine v2 | ||||||
| ENGINE_V2=true ironclaw | ||||||
|
|
||||||
| # Запуск интерактивного REPL из исходников | ||||||
| cargo run | ||||||
|
|
||||||
| # С отладочными логами | ||||||
| RUST_LOG=ironclaw=debug cargo run | ||||||
| # Запуск интерактивного REPL из исходников с engine v2 | ||||||
| ENGINE_V2=true cargo run | ||||||
|
|
||||||
| # Engine v2 с отладочными логами | ||||||
| ENGINE_V2=true RUST_LOG=ironclaw=debug cargo run | ||||||
| ``` | ||||||
|
|
||||||
| ## Разработка | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -277,15 +277,26 @@ WASM ──► 白名单 ──► 泄露扫描 ──► 凭据 ──► 执 | |||||
|
|
||||||
| ## 使用方式 | ||||||
|
|
||||||
| Engine v2 当前需要显式开启。如果你想运行新的引擎而不是旧的代理循环,请在启动 IronClaw 时设置 `ENGINE_V2=true`。 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This localized README is missing the link to the Engine v2 architecture documentation that was added to the main
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| # 首次设置(配置数据库、认证等) | ||||||
| ironclaw onboard | ||||||
|
|
||||||
| # 启动交互式 REPL | ||||||
| # 启动已安装的二进制 | ||||||
| ironclaw | ||||||
|
|
||||||
| # 使用 Engine v2 启动已安装的二进制 | ||||||
| ENGINE_V2=true ironclaw | ||||||
|
|
||||||
| # 从源码启动交互式 REPL | ||||||
| cargo run | ||||||
|
|
||||||
| # 启用调试日志 | ||||||
| RUST_LOG=ironclaw=debug cargo run | ||||||
| # 从源码启动 Engine v2 交互式 REPL | ||||||
| ENGINE_V2=true cargo run | ||||||
|
|
||||||
| # 使用 Engine v2 并启用调试日志 | ||||||
| ENGINE_V2=true RUST_LOG=ironclaw=debug cargo run | ||||||
| ``` | ||||||
|
|
||||||
| ## 开发 | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This localized README is missing the link to the Engine v2 architecture documentation that was added to the main
README.md. Adding it would help users find more detailed information about enabling the new engine.