Skip to content

Commit 37c5fed

Browse files
committed
docs: readme, skill.md 최신화 및 cli help 텍스트 수정
- version/update 명령어 섹션 추가 (README.md, SKILL.md) - 파생상품 개별주식 선물/옵션 타입 추가 (README.md) - pnpm test:e2e 스크립트 추가 (README.md) - --output 옵션 help 텍스트에 csv 포맷 반영 (index.ts)
1 parent 7bd5bd2 commit 37c5fed

3 files changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@ krx cache status # 캐시 현황 조회
118118
krx cache clear # 캐시 전체 삭제
119119
```
120120

121+
### 버전 관리
122+
123+
```bash
124+
krx version # 현재 버전 확인 및 최신 버전 비교
125+
krx update # 최신 버전으로 업데이트
126+
```
127+
121128
### ETF/ETN/ELW 조회
122129

123130
```bash
@@ -137,6 +144,10 @@ krx bond list --date 20260310 --market general
137144
```bash
138145
krx derivative list --date 20260310 --type futures
139146
krx derivative list --date 20260310 --type options
147+
krx derivative list --date 20260310 --type futures-kospi
148+
krx derivative list --date 20260310 --type futures-kosdaq
149+
krx derivative list --date 20260310 --type options-kospi
150+
krx derivative list --date 20260310 --type options-kosdaq
140151
```
141152

142153
### 일반상품 조회
@@ -373,6 +384,7 @@ MCP 클라이언트에서 자연어로 요청하면 됩니다:
373384
pnpm install
374385
pnpm build
375386
pnpm test
387+
pnpm test:e2e
376388
pnpm typecheck
377389
pnpm lint
378390
```

SKILL.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,13 @@ krx cache status # Show cache size, files, dates
152152
krx cache clear # Clear all cached data
153153
```
154154

155+
### Version & Update
156+
157+
```bash
158+
krx version # Show current version and check for updates
159+
krx update # Update to the latest version (npm install -g krx-cli)
160+
```
161+
155162
### Schema (introspection)
156163

157164
```bash

src/cli/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ program
2424
.name("krx")
2525
.description("Agent-native CLI for KRX (Korea Exchange) Open API")
2626
.version(getVersion())
27-
.option("-o, --output <format>", "output format: json, table, ndjson")
27+
.option("-o, --output <format>", "output format: json, table, ndjson, csv")
2828
.option("-f, --fields <fields>", "comma-separated fields to include")
2929
.option("--dry-run", "show request without calling API")
3030
.option("-v, --verbose", "verbose output to stderr")

0 commit comments

Comments
 (0)