trainfinder 1.0.3 → 1.0.4
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/README.md +32 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,56 +1,69 @@
|
|
|
1
1
|
# TrainFinder CLI
|
|
2
2
|
|
|
3
|
-
`TrainFinder
|
|
4
|
-
|
|
3
|
+
`TrainFinder` is a **terminal-based CLI library** that allows you to search for **domestic high-speed train information in South Korea**.
|
|
4
|
+
You can search for trains based on **departure station, arrival station, and date**.
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
## ⚡
|
|
8
|
+
## ⚡ Installation
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
11
|
npm install -g trainfinder
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
##
|
|
15
|
-
|
|
14
|
+
## 🚄 Train Types
|
|
15
|
+
|
|
16
|
+
> ⚠️ Only the train types listed below are accepted as valid input.
|
|
17
|
+
|
|
18
|
+
- ktx
|
|
19
|
+
- ktx산천A
|
|
20
|
+
- ktx산천B
|
|
21
|
+
- ktx이음
|
|
22
|
+
- srt
|
|
23
|
+
- ktx청룡
|
|
16
24
|
|
|
17
25
|
```bash
|
|
18
26
|
trainfinder trainlist
|
|
19
27
|
```
|
|
20
28
|
|
|
21
|
-
##
|
|
29
|
+
## 🚉 Station List
|
|
22
30
|
```bash
|
|
23
31
|
trainfinder stationlist
|
|
24
32
|
```
|
|
25
33
|
|
|
26
|
-
##
|
|
34
|
+
## 🔍 Check Station Existence
|
|
35
|
+
> Check whether a station exists.
|
|
36
|
+
> ⚠️ **Station names must be entered in Korean.**
|
|
37
|
+
|
|
27
38
|
```bash
|
|
28
|
-
trainfinder station --st
|
|
39
|
+
trainfinder station --st <station_name>
|
|
29
40
|
|
|
30
41
|
# 예시
|
|
31
42
|
trainfinder station --st 수서
|
|
32
43
|
```
|
|
33
44
|
|
|
34
45
|
## 기차 조회
|
|
46
|
+
> Search for trains based on departure station, arrival station, and date.
|
|
35
47
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
48
|
+
| Option | Description | Default |
|
|
49
|
+
| --------- | ------------------------- | ------- |
|
|
50
|
+
| `--dep` | Departure station name | — |
|
|
51
|
+
| `--arr` | Arrival station name | — |
|
|
52
|
+
| `--date` | Date to search (YYYYMMDD) | Today |
|
|
53
|
+
| `--train` | Train type | ktx |
|
|
40
54
|
|
|
41
|
-
--arr : 도착역 코드
|
|
42
|
-
|
|
43
|
-
--date : 조회할 날짜 (기본값: 오늘 날짜)
|
|
44
|
-
|
|
45
|
-
--train : 열차 종류 (기본값: ktx)
|
|
46
55
|
|
|
47
56
|
|
|
48
57
|
```bash
|
|
49
|
-
trainfinder search
|
|
58
|
+
trainfinder search \
|
|
59
|
+
--dep <departure_station> \
|
|
60
|
+
--arr <arrival_station> \
|
|
61
|
+
--date <YYYYMMDD> \
|
|
62
|
+
--train <train_type>
|
|
50
63
|
```
|
|
51
64
|
|
|
52
65
|
```bash
|
|
53
|
-
#
|
|
66
|
+
# Example
|
|
54
67
|
trainfinder search --dep 서울 --arr 오송 --date 20251212 --train ktx
|
|
55
68
|
```
|
|
56
69
|
|