xevol 0.11.15 → 0.11.17

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 (3) hide show
  1. package/README.md +51 -45
  2. package/dist/index.js +251 -253
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -37,6 +37,12 @@ Or run without installing:
37
37
  npx xevol
38
38
  ```
39
39
 
40
+ or install with brew:
41
+
42
+ ```bash
43
+ brew install xevol/tap/xevol
44
+ ```
45
+
40
46
  Requires Node.js 18+.
41
47
 
42
48
  ## Quick Start
@@ -57,19 +63,19 @@ xevol view <id>
57
63
 
58
64
  ## Commands
59
65
 
60
- | Command | Description |
61
- |---------|-------------|
62
- | `login` | Authenticate via device flow (opens browser) |
63
- | `logout` | Clear stored credentials |
64
- | `whoami` | Show current user, plan, and usage |
65
- | `add` | Add a YouTube URL for transcription |
66
- | `list` | List your transcriptions |
67
- | `view` | View a transcription summary or full transcript |
68
- | `analyze` | Generate AI analysis using a prompt |
69
- | `prompts` | List available analysis prompts |
70
- | `stream` | Stream analysis output via SSE |
71
- | `resume` | Resume a previous streaming session |
72
- | `config` | View or edit CLI configuration |
66
+ | Command | Description |
67
+ | --------- | ----------------------------------------------- |
68
+ | `login` | Authenticate via device flow (opens browser) |
69
+ | `logout` | Clear stored credentials |
70
+ | `whoami` | Show current user, plan, and usage |
71
+ | `add` | Add a YouTube URL for transcription |
72
+ | `list` | List your transcriptions |
73
+ | `view` | View a transcription summary or full transcript |
74
+ | `analyze` | Generate AI analysis using a prompt |
75
+ | `prompts` | List available analysis prompts |
76
+ | `stream` | Stream analysis output via SSE |
77
+ | `resume` | Resume a previous streaming session |
78
+ | `config` | View or edit CLI configuration |
73
79
 
74
80
  All commands support `--json` for machine-readable output.
75
81
 
@@ -114,13 +120,13 @@ xevol add "https://youtube.com/watch?v=abc123" --analyze facts,advice
114
120
  xevol add "https://youtube.com/watch?v=abc123" --analyze facts --stream
115
121
  ```
116
122
 
117
- | Flag | Description |
118
- |------|-------------|
119
- | `--no-wait` | Return immediately without waiting |
120
- | `--lang <code>` | Language code (e.g. `en`, `de`, `ja`) |
123
+ | Flag | Description |
124
+ | --------------------- | ----------------------------------------------------- |
125
+ | `--no-wait` | Return immediately without waiting |
126
+ | `--lang <code>` | Language code (e.g. `en`, `de`, `ja`) |
121
127
  | `--analyze <prompts>` | Comma-separated prompt IDs to run after transcription |
122
- | `--stream` | Stream analysis output via SSE |
123
- | `--json` | JSON output |
128
+ | `--stream` | Stream analysis output via SSE |
129
+ | `--json` | JSON output |
124
130
 
125
131
  ### `xevol list`
126
132
 
@@ -141,13 +147,13 @@ xevol list --json
141
147
  xevol list --csv
142
148
  ```
143
149
 
144
- | Flag | Description |
145
- |------|-------------|
146
- | `--page <n>` | Page number |
147
- | `--limit <n>` | Results per page |
150
+ | Flag | Description |
151
+ | -------------- | ---------------- |
152
+ | `--page <n>` | Page number |
153
+ | `--limit <n>` | Results per page |
148
154
  | `--status <s>` | Filter by status |
149
- | `--json` | JSON output |
150
- | `--csv` | CSV output |
155
+ | `--json` | JSON output |
156
+ | `--csv` | CSV output |
151
157
 
152
158
  ### `xevol view`
153
159
 
@@ -167,11 +173,11 @@ xevol view abc123def45 --clean
167
173
  xevol view abc123def45 --json
168
174
  ```
169
175
 
170
- | Flag | Description |
171
- |------|-------------|
172
- | `--raw` | Print the full transcript text |
173
- | `--clean` | Use cleaned/processed content |
174
- | `--json` | JSON output |
176
+ | Flag | Description |
177
+ | --------- | ------------------------------ |
178
+ | `--raw` | Print the full transcript text |
179
+ | `--clean` | Use cleaned/processed content |
180
+ | `--json` | JSON output |
175
181
 
176
182
  ### `xevol analyze`
177
183
 
@@ -188,11 +194,11 @@ xevol analyze abc123def45 --prompt facts --lang de
188
194
  xevol analyze abc123def45 --prompt facts --json
189
195
  ```
190
196
 
191
- | Flag | Description |
192
- |------|-------------|
197
+ | Flag | Description |
198
+ | --------------- | --------------------------------- |
193
199
  | `--prompt <id>` | Prompt to use (default: `review`) |
194
- | `--lang <code>` | Output language |
195
- | `--json` | JSON output |
200
+ | `--lang <code>` | Output language |
201
+ | `--json` | JSON output |
196
202
 
197
203
  Use `xevol prompts` to see all available prompts.
198
204
 
@@ -241,12 +247,12 @@ xevol config set default.limit 50
241
247
 
242
248
  Available config keys:
243
249
 
244
- | Key | Description |
245
- |-----|-------------|
246
- | `apiUrl` | Base API URL |
247
- | `default.lang` | Default output language |
250
+ | Key | Description |
251
+ | --------------- | ---------------------------- |
252
+ | `apiUrl` | Base API URL |
253
+ | `default.lang` | Default output language |
248
254
  | `default.limit` | Default page size for `list` |
249
- | `api.timeout` | API request timeout (ms) |
255
+ | `api.timeout` | API request timeout (ms) |
250
256
 
251
257
  ## Output Formats
252
258
 
@@ -327,13 +333,13 @@ xevol list --csv > my-transcriptions.csv
327
333
 
328
334
  ## Global Options
329
335
 
330
- | Flag | Description |
331
- |------|-------------|
336
+ | Flag | Description |
337
+ | ----------------- | ---------------------------------------- |
332
338
  | `--token <token>` | Override auth token for a single command |
333
- | `--no-color` | Disable colored output |
334
- | `--json` | Machine-readable JSON output |
335
- | `-V, --version` | Print version |
336
- | `-h, --help` | Show help |
339
+ | `--no-color` | Disable colored output |
340
+ | `--json` | Machine-readable JSON output |
341
+ | `-V, --version` | Print version |
342
+ | `-h, --help` | Show help |
337
343
 
338
344
  ## Links
339
345