@tacone/prosey 0.2.3 → 0.2.6

package/README.md

@@ -4,20 +4,43 @@
 
 You can read, skim, search, copy, and manipulate the text using the tools you love the most.
 
-## Usage
+## Features
+
+| Feature                              | Description                                                                                     |
+| ------------------------------------ | ----------------------------------------------------------------------------------------------- |
+| **📋 Transcript download** | Fetch YouTube transcripts as plain text or JSON                                                 |
+| **🤖 AI summarization**    | Pipe transcripts to any AI agent (opencode, Claude, Copilot, Codex)                             |
+| **🎨 Smart pager**         | Automatic syntax highlighting if bat, glow or mdcat are installed (or configure your own pager) |
+| **🛠️ Customization**            | Use `prosey config` to access and edit your configuration                                       |
+| **💾 Disk caching**        | Transcripts and summaries cached for instant repeat                                             |
+| **📄 Supported formats**   | Plain text and JSON                                                                             |
+
+## Quickstart
+
+Try it out immediately with npx:
 
 ```bash
 npx @tacone/prosey 771PQEDeRmw
 npx @tacone/prosey https://youtu.be/771PQEDeRmw --lang es -o transcript.txt
-npx @tacone/prosey info 771PQEDeRmw
 ```
 
 ## Install
 
-### Global install (npm)
+Install globally with your favorite package manager:
 
 ```bash
 npm install -g @tacone/prosey
+# or
+yarn global add @tacone/prosey
+# or
+pnpm add -g @tacone/prosey
+# or
+bun install -g @tacone/prosey
+```
+
+Then use it anywhere:
+
+```bash
 prosey 771PQEDeRmw
 ```
 
@@ -43,6 +66,7 @@ Grab a compiled binary from the `dist/` directory (requires no runtime).
 prosey [options] <video-url-or-id>
 prosey info [options] <video-url-or-id>
 prosey summarize [options] <video-url-or-id>
+prosey config
 ```
 
 Pass a full YouTube URL or a bare video ID. The transcript is printed to
@@ -51,35 +75,41 @@ stdout by default, with video details prepended.
 The `summarize` command fetches a transcript, prepends the prompt from the
 `[summarize]` config section, and pipes the result to the configured command.
 
+The `config` command opens your config file in `$EDITOR` for editing. If
+`$EDITOR` is not set, the config file path is printed.
+
 ### Examples
 
 ```bash
 # Basic — plain text with details
-npx @tacone/prosey 771PQEDeRmw
+prosey 771PQEDeRmw
 
 # Specify language
-npx @tacone/prosey https://youtu.be/771PQEDeRmw --lang es
+prosey https://youtu.be/771PQEDeRmw --lang es
 
 # Include timestamps
-npx @tacone/prosey 771PQEDeRmw -t
+prosey 771PQEDeRmw -t
 
 # Save to file
-npx @tacone/prosey 771PQEDeRmw -o transcript.txt
+prosey 771PQEDeRmw -o transcript.txt
 
 # JSON output (timestamps always included)
-npx @tacone/prosey 771PQEDeRmw --json
+prosey 771PQEDeRmw --json
 
 # Transcript only, no video details
-npx @tacone/prosey 771PQEDeRmw --no-details
+prosey 771PQEDeRmw --no-details
 
 # List available transcript languages
-npx @tacone/prosey 771PQEDeRmw --list
+prosey 771PQEDeRmw --list
 
 # Show video metadata
-npx @tacone/prosey info 771PQEDeRmw
+prosey info 771PQEDeRmw
 
 # Summarize via the configured command
-npx @tacone/prosey summarize 771PQEDeRmw
+prosey summarize 771PQEDeRmw
+
+# Edit config in $EDITOR
+prosey config
 ```
 
 ## Options
@@ -95,6 +125,13 @@ npx @tacone/prosey summarize 771PQEDeRmw
 | `--details`             | Prepend video details (title, channel, duration, views, description) to the transcript (default).              |
 | `--no-details`          | Suppress video details, transcript only.                                                                       |
 | `--no-decode-entities`  | Preserve raw HTML entities (e.g. `&#39;`). Decoded by default in text mode.                                    |
+| `--no-cache`            | Skip cache reads and force a fresh fetch.                                                                      |
+| `--no-format`           | Skip prettier markdown formatting on summarize output.                                                         |
+| `-q`, `--quiet`         | Suppress all stderr logging.                                                                                   |
+| `-v`, `--verbose`       | Print debug information to stderr.                                                                             |
+| `--no-pager`            | Disable pager for stdout output (auto-detected by default).                                                    |
+| `--pager`               | Use pager for stdout output (default).                                                                         |
+| `--reset-config`        | Reset config file to defaults and exit.                                                                        |
 | `--help`                | Show help message and exit.                                                                                    |
 | `--version`             | Show version number and exit.                                                                                  |
 
@@ -140,6 +177,15 @@ environment variable to use a custom path.
 The config file is created automatically on first run with default values.
 Use `--reset-config` to restore the defaults at any time.
 
+### `pager`
+
+Pager command for transcript and summary output. Defaults to `"auto"`, which
+detects the first available of: `bat -lmd --style plain` → `glow -p` → `mdcat -l -p` → `less`.
+Set to a custom command (e.g. `"less -R"`) to override. The `PROSEY_PAGER`
+environment variable takes precedence over this setting.
+
+### `[summarize]`
+
 The `[summarize]` section configures the `summarize` command:
 
 | Key       | Description                                      |
@@ -147,6 +193,11 @@ The `[summarize]` section configures the `summarize` command:
 | `prompt`  | Instruction prepended to the transcript          |
 | `command` | Shell command that receives the prompt via stdin |
 
+### `PROSEY_PAGER`
+
+Environment variable to set the pager command. Takes precedence over the
+`pager` config value. Set to `"auto"` or empty to use auto-detection.
+
 ## Cache
 
 Transcripts and summaries are cached to `/tmp/prosey/`. Repeated invocations