reredd-cli 2.0.0 → 2.1.4

package/README.md

@@ -0,0 +1,122 @@
+# Reredd CLI
+The professional engine for Reddit market research and customer pain point validation.
+
+Reredd CLI is a CLI tool for researchers to validate product-market fit. It automates the process of discovering signals, monitoring community discussions, and engaging with potential customers through AI-synthesized context.
+
+---
+
+## Installation
+
+Install the global command via the NPM registry. This package includes pre-compiled binaries for macOS, Linux, and Windows.
+
+```bash
+npm install -g reredd-cli
+```
+
+---
+
+## Authentication
+
+Reredd CLI operates using your existing browser session. This avoids traditional API limitations and ensures authentic community interaction.
+
+### 1. Install Extension
+Install the "Copy Cookies" extension to export your session data:
+[Download Copy Cookies](https://chromewebstore.google.com/detail/copy-cookies/jcbpglbplpblnagieibnemmkiamekcdg?hl=en-US)
+
+### 2. Export Cookies
+1. Log in to your Reddit account in your browser.
+2. Open the "Copy Cookies" extension and click the export button to copy your session to the clipboard.
+
+### 3. Add Account to CLI
+Run the following command and paste your clipboard when prompted:
+```bash
+reredd account add my-account-alias
+```
+
+---
+
+## Setup and Configuration
+
+Before running research campaigns, you must configure your LLM provider.
+
+### `reredd configure`
+The interactive setup wizard for your AI agents.
+- **Provider**: Choose between Google (Gemini) or OpenAI.
+- **API Key**: Securely store your provider key locally.
+- **Model**: Set a universal fallback model (e.g., gpt-4o or gemini-1.5-pro).
+
+### `reredd config llm`
+Fast-access command to update specific LLM settings.
+- `-p, --provider`: Set provider.
+- `-m, --model`: Set fallback model.
+- `-k, --apiKey`: Update API key.
+- `-b, --baseURL`: Set custom base URL for OpenAI-compatible proxies.
+
+---
+
+## Market Research and Validation
+
+### `reredd campaign`
+The primary module for market research and pain point analysis.
+
+#### `campaign create`
+Starts the interactive mission wizard. You will define your research intent (e.g., "Validate a new scheduling tool for dentists"), target subreddits, key metrics, and monitoring duration.
+
+#### `campaign start [name]`
+Executes the defined mission. The agent will monitor subreddits, identify relevant threads, and find customer signals.
+- `--verbose`: Enable detailed logs including internal agent decision-making timestamps.
+
+#### `campaign runs [name]`
+Lists all historical execution cycles for a specific campaign.
+
+#### `campaign resume [name] [runId]`
+Resumes an interrupted or paused research run using a specific Run ID.
+
+#### `campaign report [name] [runId]`
+Manually triggers the synthesis engine to generate a research report in HTML format.
+- `--final`: Generates a comprehensive final report summarizing all discovered themes.
+- Without the flag, it generates an **intermediate report** focusing on the latest signals.
+- Intermediate reports are saved in: `~/.reredd/campaigns/[name]/runs/[runId]/report-intermediate.html`
+- Final reports are saved in: `~/.reredd/campaigns/[name]/report-final.html`
+
+---
+
+## Community Engagement
+
+### `reredd account`
+- `add [alias]`: Register a new profile.
+- `list`: View all registered aliases.
+- `use <alias>`: Switch the active global account.
+- `remove <alias>`: Delete an account from the local vault.
+
+### `reredd post`
+- `create`: Interactive wizard to draft and publish posts. Includes an automated Flair Fetcher to ensure your post complies with subreddit requirements.
+
+### `reredd comment`
+- `fetch <postId>`: Scrapes comments for a specific post. It automatically returns cursor tokens for handling large threads.
+- `-s, --subreddit <name>`: Explicitly define the subreddit if not automatically detected.
+
+### `reredd followup <postId> <commentId>`
+The core engagement tool. It prompts you for a reply or uses the internal agent to draft a contextual response based on the parent comment's tone and technical content.
+
+### `reredd subreddit info <name>`
+Fetches critical metadata for a subreddit.
+- **Metrics**: Current subscriber count and active users.
+- **Community Rules**: Parses and displays the official rules to ensure your research stays within community guidelines.
+- `--debug`: Saves the raw subreddit HTML to `debug-subreddit.html` for technical auditing.
+
+---
+
+## Local Storage and Security
+
+Reredd is **local-first**. All data is stored in your home directory at `~/.reredd/`:
+- `agent.config.json`: LLM provider settings.
+- `sessions.json`: Encrypted/Structured Reddit session data.
+- `campaigns/`: Folder containing all research logs and HTML reports.
+
+No data is ever sent to a central server; all API calls are made directly from your machine to Reddit and your chosen LLM provider.
+
+---
+
+## License
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reredd-cli",
-  "version": "2.0.0",
+  "version": "2.1.4",
   "description": "Premium Reddit automation CLI — Pre-compiled binaries.",
   "bin": {
     "reredd": "./bin/reredd.js"
@@ -9,9 +9,9 @@
     "bin/"
   ],
   "optionalDependencies": {
-    "reredd-darwin-arm64": "2.0.0",
-    "reredd-darwin-x64": "2.0.0",
-    "reredd-linux-x64": "2.0.0",
-    "reredd-windows-x64": "2.0.0"
+    "reredd-darwin-arm64": "2.1.4",
+    "reredd-darwin-x64": "2.1.4",
+    "reredd-linux-x64": "2.1.4",
+    "reredd-windows-x64": "2.1.4"
   }
 }