Repository navigation
CLI Overview
앱 실행 파일 하나가 인자를 보고 편집기와 명령줄 도구 둘로 돈다. 명령줄 도구는 AI 에이전트와 스크립트가 vault 를 조회하는 길이고, 읽기만 한다. 이 페이지는 그 성질과 각각의 이유를 한 줄씩 요약한다 — 모양은 Architecture, 이유의 전문은 Decisions and history 가 답한다.
| 성질 | 무엇 | 왜 |
|---|---|---|
| 실행 파일 하나, 모드 둘 | argv 만 보고 GUI 와 CLI 를 가른다 (cli::mode_for) |
두 번째 실행 파일을 번들에 싣지 않으므로 서명 · 공증 · universal 빌드가 그대로이고, CLI 와 앱의 버전이 어긋날 수 없다 (결정) |
| 앱 없이 직접 읽는다 | 앱을 거치지 않고 앱과 같은 Rust 함수로 디스크의 vault 를 직접 읽는다 | 앱을 거치면 앱에 새 입구(소켓)가 생기고 그 입구의 인증 · 경로 제한을 따로 설계해야 한다. 앱이 꺼져 있으면 창도 띄워야 한다 (결정) |
| 읽기 전용 | vault, 앱의 config.json, 앱 로그 파일에 쓰지 않는다 |
쓰기 명령은 열린 탭과 충돌하지 않으려면 앱을 거쳐야 한다 — 윗줄이 피한 새 입구를 요구한다 (결정) |
| JSON 은 공개 계약 | IPC 구조체를 그대로 직렬화하지 않고 CLI 전용 구조체로 옮겨 담는다 | IPC 구조체는 프런트엔드의 필요로 바뀐다 (결정) |
vault 를 읽는 명령은 앱과 같은 Rust 함수를 부른다 — 앱과 같은 답을 내는 것이 목표이기 때문이다. 다른 곳은 이유를 적어 둔다. 함수를 나눠 쓰는 구조는 Architecture 의 경계 2, 갈림의 종류는 Links and app parity, 갈림의 목록과 예는 사용자 문서 의 "앱과 다른 점" 이 답한다.
- Architecture — 먼저 읽는다. 층과 경계, 그리고 경로 인자나 출력 한 주제에 속하지 않는 불변식. 나머지 페이지는 이 그림 위의 이야기다.
- 그 다음은 관심 영역으로. 경로 인자를 더하거나 고친다면
Paths and vault boundary, 출력이나 오류를 건드린다면
Output contract, CLI 와 앱의 답이 갈린다는 보고를 받았다면
Links and app parity,
baram mcp를 건드린다면 MCP server. - Decisions and history — 결정을 되짚거나 뒤집기 전에 읽는다.
이 wiki 의 CLI 페이지는 main 브랜치의 코드를 적는다. 명령 목록과 쓰는 법은 사용자 문서 가, CLI 가 든 릴리스가 있는지와 무엇이 머지됐고 다음 단계가 무엇인지는 #847 이 답한다.
wiki 는 거의 변하지 않는 것만 싣는다. 자주 변하는 것은 canonical 한 집이 있다.
| 찾는 것 | 가는 곳 |
|---|---|
| 명령 · 플래그 · 출력 형식 · 오류 코드 · 앱과 다른 점 | 사용자 문서 |
| 무엇이 머지됐고 다음 단계는 무엇인가 · 남은 수동 확인 | 추적 이슈 |
| 코드가 지키는 계약 |
src-tauri/src/cli/ 의 모듈 헤더와 함수 · 타입의 문서 주석 |
| 왜 이렇게 정했나 | Decisions and history |
이 wiki 는 baram 리포의 wiki/ 에서
생성됩니다. 여기서 편집하지 마세요 — 다음 게시가 덮어씁니다. 고칠 것은 리포에 PR 로 보내 주세요.
링크 없는 항목은 아직 쓰지 않았다. 그 주제의 현재 출처는 해당 모듈의 헤더 주석이고, 어느 파일인지는 Code map 이, 구현 현황은 #298 · #372 가 답한다.
- Overview
- Architecture
- Core state machine — 미작성
- Adapters — 미작성
- Hangul and IME — 미작성
- Input islands and block entry
- Search — 미작성
- Source mode and code block CM
- Lifecycle and settings — 미작성
- WebKit selection churn
- PM machinery in non-editable views — 미작성
- Performance — 미작성
- Resource and security boundaries — 미작성
- Internal contracts — 미작성
- Command reference — 미작성
- Testing methodology — 미작성
- Code map
- Decisions and history
링크 없는 항목은 아직 쓰지 않았다. 쓰는 법은 사용자 문서 가,
구현 현황과 다음 단계는 추적 이슈 가, 계약은
src-tauri/src/cli/ 의 모듈 헤더와 함수 · 타입의 문서 주석이 답한다.
- Overview
- Architecture
- Vault resolution and app config — 미작성
- Paths and vault boundary
- Output contract
- Links and app parity
- MCP server
- Testing methodology — 미작성
- Code map — 미작성
- Decisions and history