@prompts-gpt/client 0.2.3 → 0.2.4

package/README.md

@@ -7,15 +7,21 @@ CLI and SDK for syncing [Prompts-GPT](https://prompts-gpt.com) prompt packs into
 ## Get Started
 
 ```bash
-# 1. Install
+# Install
 npm install -D @prompts-gpt/client
 
-# 2. Save your project token
-npx prompts-gpt init --token-prompt
+# Interactive setup — handles credentials, config, and shows runnable commands
+npx prompts-gpt quickstart
+```
+
+Or step by step:
 
-# 3. Sync prompts and run
-npx prompts-gpt load-config
-npx prompts-gpt run
+```bash
+npx prompts-gpt init                  # save your project token (prompts interactively)
+npx prompts-gpt sync                  # pull prompts and write agent files
+npx prompts-gpt list                  # see what's available
+npx prompts-gpt run                   # execute a single prompt
+npx prompts-gpt sweep                 # run a multi-iteration sweep
 ```
 
 **Requires** Node.js 18.18+.
@@ -54,18 +60,22 @@ Bridges the Prompts-GPT cloud library with the agent instruction files each tool
 
 | Command | Description |
 |---------|-------------|
-| `init` | Save project token |
-| `load-config` | Pull full config from Prompts Studio |
+| `quickstart` | Interactive setup — credentials, config, and first run |
+| `init` | Save project token (prompts interactively if no flags given) |
+| `setup` | Scaffold local orchestration config |
 | `sync` | Pull + generate + write agent files |
-| `run` | Execute one prompt with a local agent |
+| `pull` | Download prompt packs as Markdown files |
+| `generate` | Generate a prompt pack from a goal |
+| `load-config` | Pull full config from Prompts Studio |
+| `run` | Execute one prompt with a local agent (`-f <file>`) |
 | `run-batch` | Execute multiple prompts |
-| `sweep` | Multi-iteration execution |
-| `setup` | Scaffold local config |
-| `status` | Show workspace readiness |
+| `sweep` | Multi-iteration execution (`-f <file> -n <count>`) |
 | `list` | Show prompts, sweeps, agents |
+| `status` | Show workspace readiness |
 | `providers` | Show detected CLIs |
 | `doctor` | Validate prerequisites |
 | `validate` | Check config for errors |
+| `project` | Show the current project linked to the token |
 
 Run `prompts-gpt help <command>` for detailed options.
 
@@ -74,15 +84,22 @@ Run `prompts-gpt help <command>` for detailed options.
 ## Examples
 
 ```bash
-# Run a single prompt
-prompts-gpt run --prompt-file .prompts-gpt/review.md --agent cursor
+# Run a single prompt (auto-selects if only one exists)
+prompts-gpt run -f .prompts-gpt/review.md --agent cursor
 
-# Run a sweep (multi-iteration)
-prompts-gpt sweep --prompt-file .prompts-gpt/sweeps/design.md --iterations 3
+# Run a sweep (auto-detects local sweeps, reads iterations from frontmatter)
+prompts-gpt sweep
+prompts-gpt sweep -f .prompts-gpt/sweeps/design.md -n 5
+
+# Preview what a sweep would do
+prompts-gpt sweep --dry-run
 
 # Sync from cloud
 prompts-gpt sync --agent all
 
+# Generate a prompt pack from a goal
+prompts-gpt generate --goal "Review PRs for security issues" --sync-agents
+
 # CI/CD — pipe token from secret
 printf '%s' "$PROMPTS_GPT_TOKEN" | prompts-gpt sync --token-stdin --agent all
 ```
@@ -123,6 +140,21 @@ await syncPrompts(prompts, { agent: "all" });
 
 ---
 
+## Data Privacy
+
+**What stays local:**
+- `.prompts-gpt/*.md` prompt files are written locally
+- Agent files (`AGENTS.md`, `.cursor/rules/`, etc.) are updated locally
+- Run artifacts (`.scripts/runs/`) including logs, diffs, and summaries stay local
+- No local files, repo content, or uncommitted changes are uploaded
+
+**What is sent to prompts-gpt.com:**
+- `prompts-gpt generate --goal ...` — the text you explicitly pass via `--goal`, `--context`, and `--constraints` flags is sent to the API for AI-powered prompt generation
+- `prompts-gpt sync --goal ...` — same as above when `--goal` is used
+- `prompts-gpt pull` / `sync` / `load-config` — your project token is sent to authenticate and download prompts from your library
+
+**Do not include PII, secrets, or confidential data** in `--goal`, `--context`, or `--constraints` flags. Use `--dry-run` with `sync` to preview what would be sent.
+
 ## Security
 
 - Credentials stored with `0600` permissions
@@ -130,7 +162,7 @@ await syncPrompts(prompts, { agent: "all" });
 - Token prefix (`pgpt_`) validated before requests
 - HTTPS enforced for non-localhost
 - Path traversal blocked for all file writes
-- Secret redaction in command previews and error output
+- Secret patterns (`pgpt_`, `sk-`, `ghp_`) are redacted from API-bound input, command previews, and error output
 - SIGINT/SIGTERM cleanup releases locks
 - Run artifact directories are intended to stay local and may contain sensitive prompt, output, and diff data