javdict 1.2.2 → 1.2.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_en.md DELETED
@@ -1,239 +0,0 @@
1
- # AvDict 🎬
2
-
3
- > A command-line tool to look up JAV metadata by title ID — cast, release date, studio, and more
4
-
5
- [![npm version](https://img.shields.io/badge/version-1.2.1-blue.svg)](https://github.com/gdjdkid/AvDict)
6
- [![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-green.svg)](https://nodejs.org)
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
8
- [![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20Windows%20%7C%20macOS-lightgrey.svg)]()
9
-
10
- Type a title ID, get back the full details — cast, release date, studio, duration, tags, and more. Multiple data sources are queried automatically with no manual switching required.
11
-
12
- ![Example](https://raw.githubusercontent.com/gdjdkid/AvDict/master/example.gif)
13
-
14
- ---
15
-
16
- ## Features
17
-
18
- - 🔍 **Multi-source fallback** — Queries JAVBUS → NJAV → JavLibrary → JAVDB in order; returns on first hit
19
- - 📋 **Rich metadata** — Cast, release date, duration, studio, label, director, series, tags, cover image, rating
20
- - 💾 **Local cache** — Results cached for 7 days to reduce repeat requests
21
- - 🖥️ **Cross-platform** — Linux, Windows, and macOS supported
22
- - 🎨 **Color output** — Terminal-formatted display with field-level color coding
23
- - ⚡ **Fast lookups** — Direct URL construction by title ID; no login required for most sources
24
-
25
- ---
26
-
27
- ## Requirements
28
-
29
- - Node.js >= 18.0.0
30
- - npm >= 6.0.0
31
- - curl (built into Linux/macOS; ensure it's available in your Git Bash environment on Windows)
32
-
33
- ---
34
-
35
- ## Platform Support
36
-
37
- | Platform | JAVBUS | NJAV | JavLibrary | JAVDB |
38
- |----------|--------|------|------------|-------|
39
- | Linux / macOS | ✅ | ✅ | ✅ | ✅ |
40
- | Windows | ✅ | ✅ | ✅ | ❌ |
41
-
42
- > JAVDB is unavailable on Windows due to Cloudflare TLS fingerprint restrictions. The other three sources work fully on Windows.
43
-
44
- ---
45
-
46
- ## Installation
47
-
48
- **Option 1: Install via npm (recommended)**
49
- ```bash
50
- npm install -g javdict
51
- ```
52
-
53
- **Option 2: Clone from GitHub (for developers)**
54
- ```bash
55
- git clone https://github.com/gdjdkid/AvDict.git
56
- cd AvDict
57
- npm install
58
- npm install -g .
59
- ```
60
-
61
- **Verify the installation:**
62
-
63
- ```bash
64
- jav -v
65
- ```
66
-
67
- ---
68
-
69
- ## Usage
70
-
71
- **Look up a title ID:**
72
-
73
- ```bash
74
- jav SSIS-001
75
- jav ABF-331
76
- jav JUR-067
77
- ```
78
-
79
- **Output raw JSON:**
80
-
81
- ```bash
82
- jav -r SSIS-001
83
- ```
84
-
85
- **Clear local cache:**
86
-
87
- ```bash
88
- jav --clear-cache
89
- ```
90
-
91
- **Configure JAVDB Cookie (optional):**
92
-
93
- ```bash
94
- jav --setup
95
- ```
96
-
97
- **Show help:**
98
-
99
- ```bash
100
- jav -h
101
- ```
102
-
103
- ---
104
-
105
- ## CLI Options
106
-
107
- ```
108
- Usage: jav [options] [id]
109
-
110
- Arguments:
111
- id Title ID to look up, e.g. SSIS-001
112
-
113
- Options:
114
- -v, --version Print version number
115
- -r, --raw Output raw JSON instead of formatted display
116
- --setup Configure JAVDB Cookie (optional, improves coverage)
117
- --clear-cache Clear local result cache
118
- -h, --help Show help
119
- ```
120
-
121
- ---
122
-
123
- ## Configuration
124
-
125
- ### JAVDB Cookie (optional)
126
-
127
- The tool works without any configuration. Adding a JAVDB Cookie improves coverage for niche titles that only exist in JAVDB's database. This only takes effect on Linux/macOS.
128
-
129
- **How to get your Cookie:**
130
-
131
- 1. Open [https://javdb.com](https://javdb.com) in Chrome and sign in
132
- 2. Install the Chrome extension [Get cookies.txt LOCALLY](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc)
133
- 3. Click the extension icon on the JAVDB page and export your cookies
134
- 4. Find the `_jdb_session` row and copy the value in the last column
135
- 5. Run the setup command and paste it in:
136
-
137
- ```bash
138
- jav --setup
139
- ```
140
-
141
- Your Cookie is saved locally at `~/.config/javinfo/config.json` and never sent anywhere.
142
-
143
- **Cookies typically expire in about 2 weeks.** When niche titles start returning "not found", just run `jav --setup` again to refresh.
144
-
145
- ---
146
-
147
- ## Caching
148
-
149
- Query results are automatically cached to `~/.config/javinfo/cache.json` with a 7-day TTL. This speeds up repeat lookups and reduces load on the source sites.
150
-
151
- To force a fresh fetch:
152
-
153
- ```bash
154
- jav --clear-cache
155
- ```
156
-
157
- ---
158
-
159
- ## FAQ
160
-
161
- **Q: I get "title not found" — what's wrong?**
162
-
163
- A: There are three likely causes:
164
- 1. The title isn't indexed by any of the four sources (extremely niche content)
165
- 2. Your JAVDB Cookie has expired — run `jav --setup` to refresh it
166
- 3. Your network can't reach the source sites — check your proxy settings
167
-
168
- **Q: Some titles don't show up on Windows?**
169
-
170
- A: JAVDB is unavailable on Windows due to Cloudflare restrictions. A small number of titles that only exist in JAVDB can't be found on Windows. For full coverage, use a Linux environment (e.g. a Raspberry Pi).
171
-
172
- **Q: I get `Permission denied` when installing?**
173
-
174
- A: Global installation requires elevated permissions:
175
- ```bash
176
- sudo npm install -g .
177
- ```
178
-
179
- **Q: How often do I need to update my Cookie?**
180
-
181
- A: Roughly every 2 weeks. If niche titles that previously worked start returning "not found", your Cookie has likely expired — run `jav --setup` to update it.
182
-
183
- **Q: Does it support FC2 amateur titles?**
184
-
185
- A: Yes. Enter the title in hyphen format, e.g. `031926-100`. The tool auto-detects FC2 format and handles the conversion internally.
186
-
187
- ---
188
-
189
- ## Data Sources
190
-
191
- | Source | Website | Notes |
192
- |--------|---------|-------|
193
- | JAVBUS | [javbus.com](https://www.javbus.com) | Fast, broad coverage |
194
- | NJAV | [njav.com](https://www.njav.com) | High coverage, no Cookie needed |
195
- | JavLibrary | [javlibrary.com](https://www.javlibrary.com) | Detailed metadata, includes ratings |
196
- | JAVDB | [javdb.com](https://javdb.com) | Most comprehensive, requires Cookie |
197
-
198
- ---
199
-
200
- ## License
201
-
202
- This project is open source under the [MIT License](LICENSE). You're free to use, modify, and distribute it.
203
-
204
- ---
205
-
206
- ## Contributing
207
-
208
- PRs and Issues are welcome!
209
-
210
- 1. Fork this repository
211
- 2. Create your branch: `git checkout -b feat/your-feature`
212
- 3. Commit your changes: `git commit -m "feat: describe your change"`
213
- 4. Push the branch: `git push origin feat/your-feature`
214
- 5. Open a Pull Request
215
-
216
- **Commit message conventions:**
217
- - `feat:` — new feature
218
- - `fix:` — bug fix
219
- - `docs:` — documentation update
220
- - `chore:` — maintenance / housekeeping
221
-
222
- ---
223
-
224
- ## Buy Me a Coffee ☕
225
-
226
- If this tool saves you time, consider supporting development:
227
-
228
- | WeChat Pay | Alipay |
229
- |------------|--------|
230
- | *(QR code)* | *(QR code)* |
231
-
232
- ---
233
-
234
- ## Changelog
235
-
236
- - **v1.2.1** — Minor fixes and stability improvements
237
- - **v1.2.0** — Added NJAV as fourth data source; reordered source priority
238
- - **v1.1.x** — Three-source fallback; JAVDB Cookie made optional; cross-platform compatibility fixes
239
- - **v1.0.0** — Initial release