@odyssey365/cli 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +77 -0
- package/README.md +216 -21
- package/dist/files.js +58 -0
- package/dist/guide.js +132 -0
- package/dist/index.js +92 -2
- package/dist/oauth.js +2 -9
- package/dist/rpc.js +20 -13
- package/dist/session.js +57 -1
- package/dist/watch-agent.js +45 -0
- package/dist/watch-events.js +78 -0
- package/dist/watch.js +181 -0
- package/examples/watch-agent/README.md +123 -0
- package/examples/watch-agent/config.example.json +20 -0
- package/examples/watch-agent/dispatcher.mjs +1443 -0
- package/examples/watch-agent/gitignore.template +6 -0
- package/examples/watch-agent/package.json +12 -0
- package/examples/watch-agent/test/dispatcher.test.mjs +763 -0
- package/examples/watch-agent/test/supervisor.test.mjs +126 -0
- package/package.json +21 -5
- package/prompts/watch-agent.md +250 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# Odyssey 감시 에이전트 예제
|
|
2
|
+
|
|
3
|
+
> `@odyssey365/cli` **0.2.0+** · 감시는 CLI 전용 Firebase 신원(OAuth 프로필)이 필요합니다.
|
|
4
|
+
|
|
5
|
+
Odyssey에서 태그나 댓글로 맡긴 일을 Claude Code에 전달하는 실행 가능한 예제입니다.
|
|
6
|
+
할일·항목마다 세션 하나를 만들고, 이후 댓글은 같은 세션으로 이어 받습니다.
|
|
7
|
+
대기 중에는 모델을 부르지 않습니다. 컴퓨터가 켜져 있고 이 프로그램이 실행 중이어야 받습니다.
|
|
8
|
+
|
|
9
|
+
## 처음 시작하기
|
|
10
|
+
|
|
11
|
+
Node.js 20 이상, OAuth 로그인한 Odyssey CLI, 로그인한 Claude Code가 필요합니다.
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npm install -g @odyssey365/cli
|
|
15
|
+
odyssey --version # 0.2.0+
|
|
16
|
+
odyssey login
|
|
17
|
+
odyssey whoami
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
실제로 작업할 프로젝트 폴더에서 예제를 준비합니다. **새 폴더**를 지정하세요. 기존 폴더는 덮어쓰지 않습니다.
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
cd /path/to/my-project
|
|
24
|
+
odyssey watch-agent init ../my-watch-agent
|
|
25
|
+
cd ../my-watch-agent
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
생성된 `config.json`의 `workDir`은 명령을 실행한 프로젝트 폴더입니다.
|
|
29
|
+
`odysseyBin`에는 설치한 CLI의 JS 경로를 넣으므로 전역 npm 명령의 위치를 다시 찾을 필요가 없습니다.
|
|
30
|
+
프로필을 고르려면 생성할 때 `-p work`를 붙입니다. 자격증명·토큰은 복사하지 않습니다.
|
|
31
|
+
|
|
32
|
+
Claude Code의 Odyssey MCP도 **작업할 프로젝트 폴더에서 같은 계정으로** 연결하세요.
|
|
33
|
+
이미 연결했다면 다시 추가할 필요가 없습니다. 새 연결은 다음 명령으로 등록하고 Claude Code를 열어 `/mcp`에서 로그인합니다.
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
cd /path/to/my-project
|
|
37
|
+
claude mcp add --transport http odyssey https://mcp-odyssey30-60.odyssey365.app
|
|
38
|
+
claude
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Claude Code에서 Odyssey 계정·카테고리 등 읽기 작업을 한 번 확인한 후 예제 폴더로 돌아옵니다.
|
|
42
|
+
CLI 로그인과 MCP 로그인은 별개입니다. `--check`는 MCP 등록을 확인하며 두 로그인 계정의 일치까지 증명하지 않습니다.
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
node dispatcher.mjs --check
|
|
46
|
+
node dispatcher.mjs --dry-run
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
`--check`는 모델을 부르지 않고 CLI OAuth 인증·Claude Code 설치·MCP 등록을 확인합니다.
|
|
50
|
+
`--dry-run`은 실제 감시를 연결하지만 일꾼을 깨우거나 댓글을 쓰지 않습니다. 로그에서 `ready`와 배달 예정을 확인하고 Ctrl+C로 끕니다.
|
|
51
|
+
시험할 할일 하나에 `클로드 코드` 태그를 붙이거나 메모에 `@클로드코드` 댓글을 써서 배달 예정이 나오는지 보세요.
|
|
52
|
+
|
|
53
|
+
검사가 끝났으면 실제 모드를 켭니다.
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
node dispatcher.mjs
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
시험 항목의 작은 일 하나부터 맡기세요. 일꾼이 남긴 질문에 댓글로 답하면 같은 세션으로 이어 받습니다.
|
|
60
|
+
처음 켤 때 태그가 달린 미시작 할일도 처리 대상입니다. 실제 모드는 댓글·항목을 읽고 수정하며 모델 사용량이 발생합니다.
|
|
61
|
+
기본 파일 편집 권한은 `acceptEdits`, 셸 명령은 허용한 패턴만 자동 승인합니다.
|
|
62
|
+
|
|
63
|
+
## 보통 바꾸는 설정
|
|
64
|
+
|
|
65
|
+
| 키 | 기본값·설명 |
|
|
66
|
+
|---|---|
|
|
67
|
+
| `workDir` | 일꾼이 일할 프로젝트 폴더. `./`·`../`는 config.json 기준 |
|
|
68
|
+
| `odysseyProfile` | `default`. `odyssey profiles`에서 확인 |
|
|
69
|
+
| `expectedUid` | 생성 시 로컬에 알려진 계정 uid. 비어 있으면 `--check`의 uid를 넣을 수 있음 |
|
|
70
|
+
| `claudeBin` | `claude`. PATH에 없으면 실행 파일 절대 경로 |
|
|
71
|
+
| `odysseyMcpName` | `odyssey`. 작업 폴더의 `claude mcp list`에 보이는 이름 |
|
|
72
|
+
| `watchTag` / `mentions` | `클로드 코드` / `@클로드코드`. 댓글 멘션의 공백·대소문자는 무시 |
|
|
73
|
+
| `turnBudgetUsd` / `dailyBudgetUsd` | 턴 $1 / 하루 $5. Claude Code의 API 환산 사용량 기준 |
|
|
74
|
+
| `allowedTools` | 추가로 자동 승인할 패턴. 예: `Bash(npm test:*)`, `Bash(git status:*)` |
|
|
75
|
+
| `extraRules` | 일꾼에게 매번 전할 프로젝트 규칙 |
|
|
76
|
+
| `readyTimeoutMs` | 시작·재연결 준비 대기 120초. 실패하면 백오프 후 재시작 |
|
|
77
|
+
|
|
78
|
+
하루 예산은 턴이 끝난 뒤 합산하므로 최대 한 턴 예산만큼 넘을 수 있습니다. 구독·API 청구액과 같은 값으로 간주하지 마세요.
|
|
79
|
+
태그 할일과 세션이 생긴 항목의 **내 댓글**이 후속 지시입니다. 다른 사람이 쓴 댓글과 에이전트 댓글은 일꾼을 깨우지 않습니다.
|
|
80
|
+
에이전트 답글에는 별도 작성자 표식이 붙어 자기 답에 다시 반응하는 일을 막습니다.
|
|
81
|
+
|
|
82
|
+
## 끄기·복구·상태
|
|
83
|
+
|
|
84
|
+
- **끄기:** 실행 중인 터미널에서 Ctrl+C. 일꾼이 도는 중이면 끊고 다음 실행에서 이어 받습니다.
|
|
85
|
+
- **다시 켜기:** 같은 폴더에서 `node dispatcher.mjs`. 마지막 배달 커서·세션·예산은 `state.json`에 남습니다.
|
|
86
|
+
- **연결 복구:** 감시 프로세스 종료·리스너 error·ready 시간 초과를 받으면 5초부터 최대 5분까지 간격을 늘려 재시작합니다. 10분간 정상 연결된 뒤 간격을 초기화합니다.
|
|
87
|
+
- **로그:** 터미널과 `logs/dispatcher.log`. 로그에는 맡긴 내용이 들어갈 수 있으므로 공유 전에 확인하세요.
|
|
88
|
+
- **단일 실행:** 같은 상태 파일의 실행 잠금으로 중복 실행을 막습니다. 복제한 여러 폴더로 같은 일을 동시에 감시하지 마세요.
|
|
89
|
+
- **계정 변경:** 계정마다 별도 예제 폴더를 만드세요. 상태 파일에 이전 계정 uid가 있으면 다른 계정으로 이어 받지 않습니다.
|
|
90
|
+
- **로그인 필요:** `odyssey login -p <프로필>` 뒤 다시 실행합니다. API 키 로그인은 watch에 사용할 수 없습니다.
|
|
91
|
+
- **세션 직접 열기:** 멈춘 상태에서 state.json의 sessionId를 찾아 작업 폴더에서 `claude --resume <id>`. 일꾼이 실행 중일 때 같은 세션을 열지 마세요.
|
|
92
|
+
- **초기화:** config.json과 state.json을 지우기보다 별도 폴더를 만들어 시작하세요. 상태를 잃으면 미완료 작업을 다시 맡길 수 있습니다.
|
|
93
|
+
|
|
94
|
+
모의 실행의 상태·로그는 `state.dry-run.json`·`dispatcher.dry-run.log`로 분리합니다.
|
|
95
|
+
첫 실행 전의 댓글은 자동으로 소급하지 않습니다. 이후 꺼져 있던 동안의 댓글은 저장한 커서부터 따라잡습니다.
|
|
96
|
+
댓글 중복 기억은 항목당 최근 1,000건입니다. 네트워크 장애와 일꾼 중단 중 외부 작업을 정확히 한 번만 실행하는 것은 보장하지 않습니다.
|
|
97
|
+
재개한 일꾼은 항목·스레드를 다시 읽고 이미 한 작업을 확인합니다.
|
|
98
|
+
|
|
99
|
+
## 자동 시작은 직접 선택
|
|
100
|
+
|
|
101
|
+
이 예제는 로그인 시 자동 실행을 등록하지 않습니다. 터미널에서 확인한 뒤 macOS는 LaunchAgent, Linux는 사용자 systemd 서비스로 등록할 수 있습니다.
|
|
102
|
+
설정·로그·상태 파일을 둘 폴더의 절대 경로와 `command -v node`로 확인한 Node 경로를 사용하세요.
|
|
103
|
+
PATH가 짧은 환경에서는 `claudeBin`도 절대 경로를 사용합니다. 중지할 때는 해당 서비스도 내려야 자동 재시작하지 않습니다.
|
|
104
|
+
컴퓨터가 잠들거나 꺼져 있으면 감시도 쉬며, 다음 시작 때 커서부터 이어 받습니다.
|
|
105
|
+
|
|
106
|
+
Windows에서는 Node와 Claude Code 실행 파일 또는 JS 진입점 경로를 지정하세요. JS 파일은 현재 Node로 실행하므로 `.cmd` 셸 인용에 의존하지 않습니다.
|
|
107
|
+
Windows·Linux 실기기에서의 전체 로그인·장기 감시는 별도 확인이 필요합니다.
|
|
108
|
+
|
|
109
|
+
## 예제 검사
|
|
110
|
+
|
|
111
|
+
```sh
|
|
112
|
+
npm test
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
실제 Odyssey와 Claude 대신 가짜 프로세스를 사용합니다. 배달·세션 재개·중복 방지·커서·FIFO·예산·오류 복구를 확인합니다.
|
|
116
|
+
구조를 바꾸고 싶으면 `odyssey agent-guide --watch-agent`의 프롬프트를 코딩 에이전트에 주되, 이 검사를 함께 유지하세요.
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
## 댓글과 자격 회수
|
|
120
|
+
|
|
121
|
+
`claude`·`companion`·알 수 없는 작성자 표식은 모두 AI 댓글입니다. 멘션이 있거나 이미 열린 세션이어도 일꾼에게 지시로 배달하지 않습니다.
|
|
122
|
+
서버가 OAuth 연결을 회수하면 해당 CLI 신원의 데이터 접근과 Firebase 갱신을 막습니다. 일반 앱 로그인과 다른 OAuth 연결은 유지됩니다.
|
|
123
|
+
이미 받은 데이터·진행 중인 일꾼 작업은 회수로 되돌아가지 않습니다. 감시 오류 뒤에는 예제의 재시작 간격이 적용됩니다.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"workDir": "./work",
|
|
3
|
+
"odysseyProfile": "default",
|
|
4
|
+
"odysseyBin": "odyssey",
|
|
5
|
+
"claudeBin": "claude",
|
|
6
|
+
"odysseyMcpName": "odyssey",
|
|
7
|
+
"expectedUid": "",
|
|
8
|
+
"watchTag": "클로드 코드",
|
|
9
|
+
"mentions": ["@클로드코드"],
|
|
10
|
+
"mentionAck": "👀 받았어요.",
|
|
11
|
+
"permissionMode": "acceptEdits",
|
|
12
|
+
"allowedTools": [],
|
|
13
|
+
"disallowedTools": ["Bash(git push:*)", "Bash(firebase deploy:*)", "Bash(npm publish:*)"],
|
|
14
|
+
"extraRules": [],
|
|
15
|
+
"turnBudgetUsd": 1,
|
|
16
|
+
"dailyBudgetUsd": 5,
|
|
17
|
+
"readyTimeoutMs": 120000,
|
|
18
|
+
"statePath": "./state.json",
|
|
19
|
+
"logPath": "./logs/dispatcher.log"
|
|
20
|
+
}
|