@gemdoq/codi 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +31 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,18 +12,36 @@
12
12
  # Node.js 20 이상 필요
13
13
  node --version # v20.0.0+
14
14
 
15
- # 레포 클론 및 설치
15
+ # npm으로 설치 (추천)
16
+ npm install -g @gemdoq/codi
17
+
18
+ # 또는 설치 없이 바로 실행
19
+ npx @gemdoq/codi
20
+
21
+ # 또는 Homebrew (macOS)
22
+ brew tap gemdoq/codi
23
+ brew install codi
24
+ ```
25
+
26
+ <details>
27
+ <summary>소스에서 직접 빌드하기</summary>
28
+
29
+ ```bash
16
30
  git clone https://github.com/gemdoq/codi.git
17
31
  cd codi
18
32
  npm install
19
33
  npm run build
20
- npm link # 전역 명령어로 등록 (선택)
34
+ npm link # 전역 명령어로 등록
21
35
  ```
22
36
 
37
+ </details>
38
+
23
39
  ### 2. API 키 설정
24
40
 
25
41
  Codi는 기본적으로 **Google Gemini 2.5 Flash** (무료)를 사용합니다.
26
42
 
43
+ 처음 실행하면 설정 마법사가 자동으로 안내합니다. 수동 설정도 가능합니다:
44
+
27
45
  **API 키 발급:**
28
46
  1. [Google AI Studio](https://aistudio.google.com/apikey) 접속
29
47
  2. Google 계정으로 로그인
@@ -58,14 +76,7 @@ EOF
58
76
  ### 3. 실행
59
77
 
60
78
  ```bash
61
- # 대화형 세션 시작
62
79
  codi
63
-
64
- # 또는 빌드된 파일 직접 실행
65
- node dist/cli.js
66
-
67
- # 또는 개발 모드 (빌드 없이)
68
- npx tsx src/cli.ts
69
80
  ```
70
81
 
71
82
  ## 사용법
@@ -91,6 +102,15 @@ codi -p "이 디렉토리의 파일 목록을 보여줘"
91
102
  codi -p "README.md를 한국어로 번역해줘"
92
103
  ```
93
104
 
105
+ ### 종료
106
+
107
+ ```
108
+ exit # 또는 quit, q
109
+ /quit # 또는 /exit
110
+ Ctrl+D # 즉시 종료
111
+ Ctrl+C # 두 번 누르면 종료
112
+ ```
113
+
94
114
  ### CLI 옵션
95
115
 
96
116
  | 옵션 | 설명 |
@@ -343,8 +363,8 @@ EOF
343
363
 
344
364
  | 단축키 | 기능 |
345
365
  |--------|------|
346
- | `Ctrl+C` | 현재 작업 취소 |
347
- | `Ctrl+D` | 종료 |
366
+ | `Ctrl+C` | 현재 작업 취소 (두 번 누르면 종료) |
367
+ | `Ctrl+D` | 즉시 종료 |
348
368
  | `Ctrl+L` | 화면 지우기 |
349
369
  | `Tab` | 자동 완성 (커맨드, 파일 경로) |
350
370
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gemdoq/codi",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "AI coding agent for your terminal. Read, write, search, and execute — all through natural language.",
5
5
  "type": "module",
6
6
  "bin": {