@prompts-gpt/client 0.2.2 → 0.2.4
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.
- package/LICENSE +75 -21
- package/README.md +106 -279
- package/dist/cli.js +1513 -144
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +16 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +276 -47
- package/dist/index.js.map +1 -1
- package/dist/runtime.d.ts +223 -0
- package/dist/runtime.d.ts.map +1 -0
- package/dist/runtime.js +1444 -0
- package/dist/runtime.js.map +1 -0
- package/dist/sweep.d.ts +180 -0
- package/dist/sweep.d.ts.map +1 -0
- package/dist/sweep.js +606 -0
- package/dist/sweep.js.map +1 -0
- package/package.json +4 -5
- package/CHANGELOG.md +0 -110
package/LICENSE
CHANGED
|
@@ -1,21 +1,75 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Prompts-GPT Source Available License
|
|
2
|
+
Version 1.0 — Effective 2026
|
|
3
|
+
|
|
4
|
+
Copyright (c) 2026 Prompts-GPT. All rights reserved.
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person or organization
|
|
7
|
+
("Licensee") obtaining a copy of this software and associated documentation
|
|
8
|
+
files (the "Software"), to use the Software for personal and commercial
|
|
9
|
+
purposes, subject to the following conditions:
|
|
10
|
+
|
|
11
|
+
1. GRANT OF LICENSE
|
|
12
|
+
|
|
13
|
+
Licensee may:
|
|
14
|
+
|
|
15
|
+
a) Use the Software without restriction for personal projects,
|
|
16
|
+
commercial products, internal development, CI/CD pipelines,
|
|
17
|
+
and production deployments.
|
|
18
|
+
|
|
19
|
+
b) Install the Software in any number of environments.
|
|
20
|
+
|
|
21
|
+
2. RESTRICTIONS
|
|
22
|
+
|
|
23
|
+
Licensee shall NOT:
|
|
24
|
+
|
|
25
|
+
a) Redistribute the Software, in whole or in part, as a standalone
|
|
26
|
+
package, download, or bundled component of another software
|
|
27
|
+
distribution system.
|
|
28
|
+
|
|
29
|
+
b) Modify, adapt, translate, reverse engineer, decompile, or
|
|
30
|
+
create derivative works of the Software's source code or
|
|
31
|
+
compiled artifacts.
|
|
32
|
+
|
|
33
|
+
c) Sublicense, rent, lease, sell, or otherwise transfer the
|
|
34
|
+
Software or rights to it to any third party.
|
|
35
|
+
|
|
36
|
+
d) Remove, alter, or obscure any proprietary notices, attribution
|
|
37
|
+
markers, or license text embedded in the Software.
|
|
38
|
+
|
|
39
|
+
e) Use the Software to build a competing prompt management
|
|
40
|
+
platform, agent orchestration service, or equivalent product.
|
|
41
|
+
|
|
42
|
+
3. ATTRIBUTION
|
|
43
|
+
|
|
44
|
+
Build artifacts and runtime telemetry may contain account attribution
|
|
45
|
+
metadata. Tampering with or removing attribution data is prohibited.
|
|
46
|
+
|
|
47
|
+
4. INTELLECTUAL PROPERTY
|
|
48
|
+
|
|
49
|
+
The Software is and remains the exclusive property of Prompts-GPT.
|
|
50
|
+
No title or ownership is transferred to Licensee.
|
|
51
|
+
|
|
52
|
+
5. WARRANTY DISCLAIMER
|
|
53
|
+
|
|
54
|
+
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
|
|
55
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
56
|
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
|
|
57
|
+
NONINFRINGEMENT.
|
|
58
|
+
|
|
59
|
+
6. LIMITATION OF LIABILITY
|
|
60
|
+
|
|
61
|
+
IN NO EVENT SHALL PROMPTS-GPT BE LIABLE FOR ANY INDIRECT,
|
|
62
|
+
INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES ARISING
|
|
63
|
+
OUT OF THE USE OR INABILITY TO USE THE SOFTWARE.
|
|
64
|
+
|
|
65
|
+
7. TERMINATION
|
|
66
|
+
|
|
67
|
+
This license terminates automatically if Licensee breaches any
|
|
68
|
+
term. Upon termination, Licensee must stop using the Software.
|
|
69
|
+
|
|
70
|
+
8. GOVERNING LAW
|
|
71
|
+
|
|
72
|
+
This agreement is governed by the laws of the State of Delaware,
|
|
73
|
+
USA, without regard to conflict of laws principles.
|
|
74
|
+
|
|
75
|
+
For licensing inquiries: licensing@prompts-gpt.com
|
package/README.md
CHANGED
|
@@ -1,346 +1,173 @@
|
|
|
1
1
|
# @prompts-gpt/client
|
|
2
2
|
|
|
3
|
-
CLI and
|
|
3
|
+
CLI and SDK for syncing [Prompts-GPT](https://prompts-gpt.com) prompt packs into any project — with integrations for **Codex**, **Claude Code**, **Cursor**, **VS Code**, **GitHub Copilot**, **Continue**, **Gemini CLI**, **Windsurf**, **Cline**, **Junie**, and **Amp**.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
AI coding agents work best when they have stable, discoverable instructions inside the repository. This package bridges Prompts-GPT's cloud prompt library with the local files each agent reads:
|
|
10
|
-
|
|
11
|
-
| Agent | What gets written |
|
|
12
|
-
|-------|-------------------|
|
|
13
|
-
| **Codex** | `AGENTS.md` managed block |
|
|
14
|
-
| **Cursor** | `.cursor/rules/prompts-gpt-*.mdc` |
|
|
15
|
-
| **VS Code** | `.github/copilot-instructions.md` + `.github/instructions/*.instructions.md` + `.vscode/*.code-snippets` |
|
|
16
|
-
| **Copilot** | `.github/prompts/*.prompt.md` |
|
|
17
|
-
|
|
18
|
-
Prompt Markdown files and a `manifest.json` are always written to `.prompts-gpt/` for discovery.
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Quick start
|
|
7
|
+
## Get Started
|
|
23
8
|
|
|
24
9
|
```bash
|
|
25
|
-
#
|
|
26
|
-
npm
|
|
27
|
-
|
|
28
|
-
# Sync prompt packs + agent files in one command
|
|
29
|
-
npm exec --yes @prompts-gpt/client@latest -- sync --agent all
|
|
10
|
+
# Install
|
|
11
|
+
npm install -D @prompts-gpt/client
|
|
30
12
|
|
|
31
|
-
#
|
|
32
|
-
|
|
33
|
-
--goal "Review this diff for security issues" \
|
|
34
|
-
--context "Node.js API with PostgreSQL" \
|
|
35
|
-
--agent codex,cursor,vscode
|
|
13
|
+
# Interactive setup — handles credentials, config, and shows runnable commands
|
|
14
|
+
npx prompts-gpt quickstart
|
|
36
15
|
```
|
|
37
16
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
## Install
|
|
17
|
+
Or step by step:
|
|
41
18
|
|
|
42
19
|
```bash
|
|
43
|
-
|
|
20
|
+
npx prompts-gpt init # save your project token (prompts interactively)
|
|
21
|
+
npx prompts-gpt sync # pull prompts and write agent files
|
|
22
|
+
npx prompts-gpt list # see what's available
|
|
23
|
+
npx prompts-gpt run # execute a single prompt
|
|
24
|
+
npx prompts-gpt sweep # run a multi-iteration sweep
|
|
44
25
|
```
|
|
45
26
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
```json
|
|
49
|
-
{
|
|
50
|
-
"scripts": {
|
|
51
|
-
"prompts:sync": "prompts-gpt sync --agent all",
|
|
52
|
-
"prompts:generate": "prompts-gpt generate --goal \"Review this diff for security issues\" --agent codex"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Or run directly with `npx` — no install required:
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
npx @prompts-gpt/client@latest <command>
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
**Requires** Node.js 18.18 or later.
|
|
27
|
+
**Requires** Node.js 18.18+.
|
|
64
28
|
|
|
65
29
|
---
|
|
66
30
|
|
|
67
|
-
##
|
|
31
|
+
## What It Does
|
|
68
32
|
|
|
69
|
-
|
|
33
|
+
Bridges the Prompts-GPT cloud library with the agent instruction files each tool reads:
|
|
70
34
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
35
|
+
| Agent | Written files |
|
|
36
|
+
|-------|--------------|
|
|
37
|
+
| Codex | `AGENTS.md` |
|
|
38
|
+
| Claude Code | `CLAUDE.md` |
|
|
39
|
+
| Cursor | `.cursor/rules/*.mdc` + `.cursor/commands/*.md` |
|
|
40
|
+
| VS Code | `.github/copilot-instructions.md` + `.vscode/*.code-snippets` |
|
|
41
|
+
| Copilot | `.github/prompts/*.prompt.md` |
|
|
42
|
+
| Continue | `.continue/rules/*.md` |
|
|
43
|
+
| Gemini CLI | `GEMINI.md` |
|
|
44
|
+
| Windsurf | `.windsurf/rules/*.md` |
|
|
45
|
+
| Cline | `.clinerules/*.md` |
|
|
46
|
+
| Junie | `.junie/guidelines.md` |
|
|
47
|
+
| Amp | `AGENT.md` |
|
|
76
48
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
For CI/CD or secret-manager pipes, use stdin instead of putting the raw token in shell history:
|
|
49
|
+
---
|
|
80
50
|
|
|
81
|
-
|
|
82
|
-
printf '%s' "$PROMPTS_GPT_TOKEN" | prompts-gpt sync --token-stdin --agent all
|
|
83
|
-
```
|
|
51
|
+
## Important Use Notes
|
|
84
52
|
|
|
85
|
-
|
|
53
|
+
- `@prompts-gpt/client` is the published npm package. If you see examples that reference internal app modules such as `lib/sdk`, those are app-internal examples, not the public package import path.
|
|
54
|
+
- Local orchestration can send prompt text, code context, and repository files to third-party model providers and agent CLIs. Review each provider's terms, privacy settings, and permitted automation paths before using private or regulated data.
|
|
55
|
+
- Run artifacts are written locally and can include prompts, model output, logs, and worktree snapshots. Treat `.scripts/runs` as sensitive and do not commit or share it casually.
|
|
86
56
|
|
|
87
57
|
---
|
|
88
58
|
|
|
89
|
-
## CLI
|
|
59
|
+
## CLI Commands
|
|
60
|
+
|
|
61
|
+
| Command | Description |
|
|
62
|
+
|---------|-------------|
|
|
63
|
+
| `quickstart` | Interactive setup — credentials, config, and first run |
|
|
64
|
+
| `init` | Save project token (prompts interactively if no flags given) |
|
|
65
|
+
| `setup` | Scaffold local orchestration config |
|
|
66
|
+
| `sync` | Pull + generate + write agent files |
|
|
67
|
+
| `pull` | Download prompt packs as Markdown files |
|
|
68
|
+
| `generate` | Generate a prompt pack from a goal |
|
|
69
|
+
| `load-config` | Pull full config from Prompts Studio |
|
|
70
|
+
| `run` | Execute one prompt with a local agent (`-f <file>`) |
|
|
71
|
+
| `run-batch` | Execute multiple prompts |
|
|
72
|
+
| `sweep` | Multi-iteration execution (`-f <file> -n <count>`) |
|
|
73
|
+
| `list` | Show prompts, sweeps, agents |
|
|
74
|
+
| `status` | Show workspace readiness |
|
|
75
|
+
| `providers` | Show detected CLIs |
|
|
76
|
+
| `doctor` | Validate prerequisites |
|
|
77
|
+
| `validate` | Check config for errors |
|
|
78
|
+
| `project` | Show the current project linked to the token |
|
|
79
|
+
|
|
80
|
+
Run `prompts-gpt help <command>` for detailed options.
|
|
90
81
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
prompts-gpt init (--token <token> | --token-stdin | --token-prompt) [--api-url <url>] [--cwd <path>]
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
Use `--token-prompt` for local interactive setup and `--token-stdin` for CI or secret-manager pipes.
|
|
82
|
+
---
|
|
98
83
|
|
|
99
|
-
|
|
84
|
+
## Examples
|
|
100
85
|
|
|
101
86
|
```bash
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
The default workflow. Pulls library prompts, optionally generates one, writes Markdown files, agent integration files, and a manifest.
|
|
87
|
+
# Run a single prompt (auto-selects if only one exists)
|
|
88
|
+
prompts-gpt run -f .prompts-gpt/review.md --agent cursor
|
|
106
89
|
|
|
107
|
-
|
|
90
|
+
# Run a sweep (auto-detects local sweeps, reads iterations from frontmatter)
|
|
91
|
+
prompts-gpt sweep
|
|
92
|
+
prompts-gpt sweep -f .prompts-gpt/sweeps/design.md -n 5
|
|
108
93
|
|
|
109
|
-
|
|
94
|
+
# Preview what a sweep would do
|
|
95
|
+
prompts-gpt sweep --dry-run
|
|
110
96
|
|
|
111
|
-
|
|
112
|
-
prompts-gpt
|
|
113
|
-
```
|
|
97
|
+
# Sync from cloud
|
|
98
|
+
prompts-gpt sync --agent all
|
|
114
99
|
|
|
115
|
-
|
|
100
|
+
# Generate a prompt pack from a goal
|
|
101
|
+
prompts-gpt generate --goal "Review PRs for security issues" --sync-agents
|
|
116
102
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### `install-agents` — Write agent files only
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
prompts-gpt install-agents [--agent codex,cursor,vscode,copilot]
|
|
103
|
+
# CI/CD — pipe token from secret
|
|
104
|
+
printf '%s' "$PROMPTS_GPT_TOKEN" | prompts-gpt sync --token-stdin --agent all
|
|
125
105
|
```
|
|
126
106
|
|
|
127
|
-
|
|
107
|
+
---
|
|
128
108
|
|
|
129
|
-
|
|
130
|
-
prompts-gpt project
|
|
131
|
-
```
|
|
109
|
+
## Configuration
|
|
132
110
|
|
|
133
|
-
|
|
111
|
+
Create `.prompts-gpt/config.json` via `prompts-gpt setup`, or manually:
|
|
134
112
|
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
|
|
113
|
+
```json
|
|
114
|
+
{
|
|
115
|
+
"providerOrder": ["codex", "cursor", "claude", "copilot"],
|
|
116
|
+
"defaultAgent": "router",
|
|
117
|
+
"timeoutSeconds": 900,
|
|
118
|
+
"artifactsDir": ".scripts/runs"
|
|
119
|
+
}
|
|
138
120
|
```
|
|
139
121
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
| Flag | Description |
|
|
143
|
-
|------|-------------|
|
|
144
|
-
| `--token <token>` | Project API token |
|
|
145
|
-
| `--token-stdin` | Read the token from stdin |
|
|
146
|
-
| `--token-prompt` | Prompt for the token without echoing it |
|
|
147
|
-
| `--api-url <url>` | Custom API base URL |
|
|
148
|
-
| `--cwd <path>` | Target directory for config and generated files |
|
|
149
|
-
| `--agent <targets>` | Comma-separated: `codex`, `cursor`, `vscode`, `copilot`, or `all` |
|
|
150
|
-
| `--overwrite` | Replace existing files instead of skipping |
|
|
151
|
-
| `--out <dir>` | Output directory (default: `.prompts-gpt`) |
|
|
152
|
-
|
|
153
|
-
### Supported tools
|
|
154
|
-
|
|
155
|
-
Codex, Claude Code, Cursor, GitHub Copilot, ChatGPT, Gemini, Perplexity, Grok, DeepSeek, Claude.
|
|
122
|
+
All options can be overridden via environment variables. See `prompts-gpt help setup`.
|
|
156
123
|
|
|
157
124
|
---
|
|
158
125
|
|
|
159
|
-
##
|
|
126
|
+
## SDK
|
|
160
127
|
|
|
161
128
|
```typescript
|
|
162
|
-
import {
|
|
163
|
-
DEFAULT_PROMPTS_GPT_API_URL,
|
|
164
|
-
PromptsGptClient,
|
|
165
|
-
syncPrompts,
|
|
166
|
-
writeAgentFiles,
|
|
167
|
-
formatPromptMarkdown,
|
|
168
|
-
} from "@prompts-gpt/client";
|
|
129
|
+
import { PromptsGptClient, syncPrompts } from "@prompts-gpt/client";
|
|
169
130
|
|
|
170
131
|
const client = new PromptsGptClient({
|
|
171
|
-
token: "
|
|
172
|
-
apiUrl:
|
|
132
|
+
token: "pgpt_your_token",
|
|
133
|
+
apiUrl: "https://prompts-gpt.com",
|
|
173
134
|
fetch,
|
|
174
135
|
});
|
|
175
136
|
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
console.log(project.brandName, project.websiteUrl);
|
|
179
|
-
|
|
180
|
-
// Pull prompt packs from the library
|
|
181
|
-
const prompts = await client.pullPrompts({ limit: 10, tool: "Codex" });
|
|
182
|
-
|
|
183
|
-
// Generate a project-aware prompt
|
|
184
|
-
const generated = await client.generatePrompt({
|
|
185
|
-
goal: "Review production diffs for security issues",
|
|
186
|
-
context: "Node.js microservice with PostgreSQL",
|
|
187
|
-
tool: "Codex",
|
|
188
|
-
});
|
|
189
|
-
|
|
190
|
-
// Sync everything to disk (Markdown + agent files + manifest)
|
|
191
|
-
const result = await syncPrompts([...prompts, generated], {
|
|
192
|
-
agent: "all",
|
|
193
|
-
overwrite: true,
|
|
194
|
-
});
|
|
195
|
-
|
|
196
|
-
console.log(`Wrote ${result.markdown.written.length} prompts`);
|
|
197
|
-
console.log(`Synced ${result.agents.written.length} agent files`);
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Runtime requirements
|
|
201
|
-
|
|
202
|
-
- `PromptsGptClient` requires an explicit `fetch` implementation. In Node.js 18.18+ you can pass the built-in `fetch`.
|
|
203
|
-
- The SDK is ESM-only. Use `import`, not `require`.
|
|
204
|
-
- File-writing helpers only write inside the provided project directory and reject path traversal.
|
|
205
|
-
|
|
206
|
-
### API methods
|
|
207
|
-
|
|
208
|
-
| Method | Description |
|
|
209
|
-
|--------|-------------|
|
|
210
|
-
| `client.getProject()` | Returns project context (brand, competitors, keywords) |
|
|
211
|
-
| `client.pullPrompts(query?)` | Fetches prompt packs from the library |
|
|
212
|
-
| `client.generatePrompt(input)` | Generates a prompt using project context |
|
|
213
|
-
|
|
214
|
-
### File-writing utilities
|
|
215
|
-
|
|
216
|
-
| Function | Description |
|
|
217
|
-
|----------|-------------|
|
|
218
|
-
| `syncPrompts(prompts, opts)` | Full sync: Markdown + agents + manifest |
|
|
219
|
-
| `writePromptMarkdownFiles(prompts, opts)` | Write `.md` files only |
|
|
220
|
-
| `writeAgentFiles(prompts, opts)` | Write agent integration files only |
|
|
221
|
-
| `writePromptManifest(prompts, opts)` | Write `manifest.json` only |
|
|
222
|
-
| `formatPromptMarkdown(prompt)` | Render a single prompt as Markdown |
|
|
223
|
-
| `saveLocalCredentials(input)` | Save token to `.prompts-gpt/.credentials.json` |
|
|
224
|
-
| `loadLocalCredentials(cwd?)` | Load saved credentials |
|
|
225
|
-
|
|
226
|
-
---
|
|
227
|
-
|
|
228
|
-
## Generated file structure
|
|
229
|
-
|
|
230
|
-
After running `sync --agent all`, your repository will contain:
|
|
231
|
-
|
|
232
|
-
```
|
|
233
|
-
.prompts-gpt/
|
|
234
|
-
manifest.json # Machine-readable index
|
|
235
|
-
README.md # Human-readable index
|
|
236
|
-
senior-code-reviewer.md # Prompt pack (YAML frontmatter + Markdown)
|
|
237
|
-
...
|
|
238
|
-
|
|
239
|
-
AGENTS.md # Codex: managed <!-- prompts-gpt:start --> block
|
|
240
|
-
|
|
241
|
-
.cursor/rules/
|
|
242
|
-
prompts-gpt-senior-code-reviewer.mdc # Cursor rule file
|
|
243
|
-
|
|
244
|
-
.github/
|
|
245
|
-
copilot-instructions.md # VS Code / Copilot shared instructions
|
|
246
|
-
instructions/
|
|
247
|
-
prompts-gpt.instructions.md # Copilot path-specific instructions for generated artifacts
|
|
248
|
-
prompts/
|
|
249
|
-
prompts-gpt-senior-code-reviewer.prompt.md # Copilot prompt file
|
|
250
|
-
|
|
251
|
-
.vscode/
|
|
252
|
-
prompts-gpt.code-snippets # VS Code snippets
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
`manifest.json` includes each prompt's supported agent targets, recommended local path, and generated file locations so downstream tools can discover the synced artifacts without guessing paths.
|
|
256
|
-
|
|
257
|
-
---
|
|
258
|
-
|
|
259
|
-
## Environment variables
|
|
260
|
-
|
|
261
|
-
| Variable | Description |
|
|
262
|
-
|----------|-------------|
|
|
263
|
-
| `PROMPTS_GPT_TOKEN` | Shell variable you can expand into `--token` for CI or local scripts |
|
|
264
|
-
| `PROMPTS_GPT_API_URL` | Shell variable you can expand into `--api-url` for self-hosted instances |
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
## Error handling
|
|
269
|
-
|
|
270
|
-
```typescript
|
|
271
|
-
import { PromptsGptApiError } from "@prompts-gpt/client";
|
|
272
|
-
|
|
273
|
-
try {
|
|
274
|
-
await client.pullPrompts();
|
|
275
|
-
} catch (error) {
|
|
276
|
-
if (error instanceof PromptsGptApiError) {
|
|
277
|
-
console.error(error.message); // Human-readable message
|
|
278
|
-
console.error(error.code); // Machine-readable code
|
|
279
|
-
console.error(error.status); // HTTP status (e.g. 401, 429)
|
|
280
|
-
console.error(error.recovery); // Suggested fix
|
|
281
|
-
}
|
|
282
|
-
}
|
|
137
|
+
const prompts = await client.pullPrompts();
|
|
138
|
+
await syncPrompts(prompts, { agent: "all" });
|
|
283
139
|
```
|
|
284
140
|
|
|
285
|
-
**Error codes:** `AUTH_ERROR`, `VALIDATION_ERROR`, `RATE_LIMIT_ERROR`, `TIMEOUT`, `NETWORK_ERROR`, `INVALID_RESPONSE`, `MISSING_FETCH`.
|
|
286
|
-
|
|
287
|
-
The client automatically retries on `429`, `502`, `503`, and `504` responses with exponential backoff and jitter.
|
|
288
|
-
|
|
289
|
-
SDK responses include `X-Request-Id` plus rate-limit headers so CLI errors can be correlated with one server-side request path during support or incident triage.
|
|
290
|
-
|
|
291
141
|
---
|
|
292
142
|
|
|
293
|
-
##
|
|
143
|
+
## Data Privacy
|
|
294
144
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
run: npm exec --yes @prompts-gpt/client@latest -- sync --token "$PROMPTS_GPT_TOKEN" --agent all --overwrite
|
|
301
|
-
```
|
|
145
|
+
**What stays local:**
|
|
146
|
+
- `.prompts-gpt/*.md` prompt files are written locally
|
|
147
|
+
- Agent files (`AGENTS.md`, `.cursor/rules/`, etc.) are updated locally
|
|
148
|
+
- Run artifacts (`.scripts/runs/`) including logs, diffs, and summaries stay local
|
|
149
|
+
- No local files, repo content, or uncommitted changes are uploaded
|
|
302
150
|
|
|
303
|
-
|
|
151
|
+
**What is sent to prompts-gpt.com:**
|
|
152
|
+
- `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
|
|
153
|
+
- `prompts-gpt sync --goal ...` — same as above when `--goal` is used
|
|
154
|
+
- `prompts-gpt pull` / `sync` / `load-config` — your project token is sent to authenticate and download prompts from your library
|
|
304
155
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
## Package contents
|
|
308
|
-
|
|
309
|
-
The published tarball includes:
|
|
310
|
-
|
|
311
|
-
- `dist/` ESM JavaScript, source maps, and `.d.ts` files
|
|
312
|
-
- `README.md`
|
|
313
|
-
- `CHANGELOG.md`
|
|
314
|
-
- `LICENSE`
|
|
315
|
-
- `package.json`
|
|
316
|
-
|
|
317
|
-
This package intentionally does not publish source TypeScript, test fixtures, or local credential files.
|
|
318
|
-
|
|
319
|
-
Before publishing a new release, run:
|
|
320
|
-
|
|
321
|
-
```bash
|
|
322
|
-
TMPDIR=/private/tmp npm_config_cache=/private/tmp/prompts-gpt-npm-cache npm pack --dry-run
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
That verifies the `files` whitelist, the generated `dist/` output, and the executable mode on `dist/cli.js` without mutating the real npm cache.
|
|
326
|
-
|
|
327
|
-
Publish with the default npm flow unless the release runs inside a provider that supports npm provenance attestation. If you want provenance, enable it explicitly in that CI job instead of forcing it in `package.json`.
|
|
328
|
-
|
|
329
|
-
---
|
|
156
|
+
**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.
|
|
330
157
|
|
|
331
158
|
## Security
|
|
332
159
|
|
|
333
|
-
- Credentials stored with `0600`
|
|
334
|
-
-
|
|
335
|
-
-
|
|
336
|
-
-
|
|
160
|
+
- Credentials stored with `0600` permissions
|
|
161
|
+
- Credentials added to `.gitignore`
|
|
162
|
+
- Token prefix (`pgpt_`) validated before requests
|
|
163
|
+
- HTTPS enforced for non-localhost
|
|
337
164
|
- Path traversal blocked for all file writes
|
|
338
|
-
-
|
|
339
|
-
-
|
|
340
|
-
-
|
|
165
|
+
- Secret patterns (`pgpt_`, `sk-`, `ghp_`) are redacted from API-bound input, command previews, and error output
|
|
166
|
+
- SIGINT/SIGTERM cleanup releases locks
|
|
167
|
+
- Run artifact directories are intended to stay local and may contain sensitive prompt, output, and diff data
|
|
341
168
|
|
|
342
169
|
---
|
|
343
170
|
|
|
344
171
|
## License
|
|
345
172
|
|
|
346
|
-
[
|
|
173
|
+
[Prompts-GPT Source Available License](./LICENSE) — free for personal and commercial use. Redistribution and modification of the package are not permitted.
|