@tacone/prosey 0.1.0 → 0.2.1

package/README.md

@@ -4,23 +4,21 @@
 
 You can read, skim, search, copy, and manipulate the text using the tools you love the most.
 
+## Usage
+
 ```bash
-npx prosey https://www.youtube.com/watch?v=dQw4w9WgXcQ
+npx @tacone/prosey 771PQEDeRmw
+npx @tacone/prosey https://youtu.be/771PQEDeRmw --lang es -o transcript.txt
+npx @tacone/prosey info 771PQEDeRmw
 ```
 
 ## Install
 
-### Quick — no install (npx)
-
-```bash
-npx prosey dQw4w9WgXcQ
-```
-
 ### Global install (npm)
 
 ```bash
-npm install -g prosey
-prosey dQw4w9WgXcQ
+npm install -g @tacone/prosey
+prosey 771PQEDeRmw
 ```
 
 ### From source (development)
@@ -32,7 +30,7 @@ and running the TypeScript source directly.
 git clone https://github.com/tacone/prosey.git
 cd prosey
 bun install
-bun run start -- dQw4w9WgXcQ
+bun run start -- 771PQEDeRmw
 ```
 
 ### Prebuilt binary
@@ -44,37 +42,44 @@ 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>
 ```
 
 Pass a full YouTube URL or a bare video ID. The transcript is printed to
 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.
+
 ### Examples
 
 ```bash
 # Basic — plain text with details
-prosey dQw4w9WgXcQ
+npx @tacone/prosey 771PQEDeRmw
 
 # Specify language
-prosey https://www.youtube.com/watch?v=dQw4w9WgXcQ --lang es
+npx @tacone/prosey https://youtu.be/771PQEDeRmw --lang es
 
 # Include timestamps
-prosey dQw4w9WgXcQ -t
+npx @tacone/prosey 771PQEDeRmw -t
 
 # Save to file
-prosey dQw4w9WgXcQ -o transcript.txt
+npx @tacone/prosey 771PQEDeRmw -o transcript.txt
 
 # JSON output (timestamps always included)
-prosey dQw4w9WgXcQ --json
+npx @tacone/prosey 771PQEDeRmw --json
 
 # Transcript only, no video details
-prosey dQw4w9WgXcQ --no-details
+npx @tacone/prosey 771PQEDeRmw --no-details
 
 # List available transcript languages
-prosey dQw4w9WgXcQ --list
+npx @tacone/prosey 771PQEDeRmw --list
 
 # Show video metadata
-prosey info dQw4w9WgXcQ
+npx @tacone/prosey info 771PQEDeRmw
+
+# Summarize via the configured command
+npx @tacone/prosey summarize 771PQEDeRmw
 ```
 
 ## Options
@@ -111,15 +116,6 @@ When `--json` is used, the output is an array of objects:
 `timestamp` is always present in JSON mode. Video details are suppressed
 (silently) since JSON is structured data.
 
-## Binary
-
-Build a single-file binary with no external dependencies:
-
-```bash
-bun run build
-./dist/prosey dQw4w9WgXcQ
-```
-
 ## Development
 
 This project uses **[Bun](https://bun.sh)** for development.
@@ -128,12 +124,46 @@ This project uses **[Bun](https://bun.sh)** for development.
 bun run typecheck   # TypeScript check
 bun run start       # Run the CLI from source
 bun run test        # Run unit tests
-bun run build       # Compile standalone binary
+bun run build       # Compile Node bundle to bin/prosey
 ```
 
-Before publishing to npm, `bun run build:node` compiles the TypeScript source
-into a Node-compatible JS bundle at `bin/prosey.js`. This happens automatically
-via the `prepack` hook.
+Before publishing to npm, `bun run build` runs automatically via the `prepack`
+hook, producing a Node-compatible JS bundle at `bin/prosey`.
+
+## Configuration
+
+Prosey reads configuration from a TOML file. The location follows the
+[XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
+(`~/.config/prosey/config.toml`), or you can set the `PROSEY_CONFIG_PATH`
+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.
+
+The `[summarize]` section configures the `summarize` command:
+
+| Key       | Description                                      |
+| --------- | ------------------------------------------------ |
+| `prompt`  | Instruction prepended to the transcript          |
+| `command` | Shell command that receives the prompt via stdin |
+
+## Cache
+
+Transcripts and summaries are cached to `/tmp/prosey/`. Repeated invocations
+for the same video and options are instant and work offline. Use `--no-cache`
+to skip cache reads and force a fresh fetch.
+
+When running `prosey summarize`, the command runs inside the cache directory
+for that video. This prevents the AI agent from picking up project-specific
+files like `AGENTS.md` or `CLAUDE.md` from the current folder, and limits its
+ability to modify files outside that directory.
+
+## Exit codes
+
+| Code | Meaning                 |
+| ---- | ----------------------- |
+| `0`  | Success                 |
+| `65` | Invalid video URL or ID |
 
 ## How it works