pattyeng 1.0.4 → 1.0.7
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/README.md +103 -43
- package/bin/pattyeng.js +25 -14
- package/lib/skills.js +198 -0
- package/lib/upgrade.js +46 -0
- package/package.json +5 -3
- package/skills/.system/.codex-system-skills.marker +1 -0
- package/skills/.system/imagegen/LICENSE.txt +201 -0
- package/skills/.system/imagegen/SKILL.md +356 -0
- package/skills/.system/imagegen/agents/openai.yaml +6 -0
- package/skills/.system/imagegen/assets/imagegen-small.svg +5 -0
- package/skills/.system/imagegen/assets/imagegen.png +0 -0
- package/skills/.system/imagegen/references/cli.md +242 -0
- package/skills/.system/imagegen/references/codex-network.md +33 -0
- package/skills/.system/imagegen/references/image-api.md +90 -0
- package/skills/.system/imagegen/references/prompting.md +118 -0
- package/skills/.system/imagegen/references/sample-prompts.md +433 -0
- package/skills/.system/imagegen/scripts/image_gen.py +995 -0
- package/skills/.system/imagegen/scripts/remove_chroma_key.py +440 -0
- package/skills/.system/openai-docs/LICENSE.txt +201 -0
- package/skills/.system/openai-docs/SKILL.md +167 -0
- package/skills/.system/openai-docs/agents/openai.yaml +14 -0
- package/skills/.system/openai-docs/assets/openai-small.svg +3 -0
- package/skills/.system/openai-docs/assets/openai.png +0 -0
- package/skills/.system/openai-docs/references/latest-model.md +37 -0
- package/skills/.system/openai-docs/references/prompting-guide.md +244 -0
- package/skills/.system/openai-docs/references/upgrade-guide.md +181 -0
- package/skills/.system/openai-docs/scripts/fetch-codex-manual.mjs +598 -0
- package/skills/.system/openai-docs/scripts/resolve-latest-model-info.js +147 -0
- package/skills/.system/plugin-creator/SKILL.md +243 -0
- package/skills/.system/plugin-creator/agents/openai.yaml +6 -0
- package/skills/.system/plugin-creator/assets/plugin-creator-small.svg +3 -0
- package/skills/.system/plugin-creator/assets/plugin-creator.png +0 -0
- package/skills/.system/plugin-creator/references/installing-and-updating.md +143 -0
- package/skills/.system/plugin-creator/references/plugin-json-spec.md +194 -0
- package/skills/.system/plugin-creator/scripts/create_basic_plugin.py +324 -0
- package/skills/.system/plugin-creator/scripts/read_marketplace_name.py +48 -0
- package/skills/.system/plugin-creator/scripts/update_plugin_cachebuster.py +78 -0
- package/skills/.system/plugin-creator/scripts/validate_plugin.py +586 -0
- package/skills/.system/skill-creator/SKILL.md +416 -0
- package/skills/.system/skill-creator/agents/openai.yaml +5 -0
- package/skills/.system/skill-creator/assets/skill-creator-small.svg +3 -0
- package/skills/.system/skill-creator/assets/skill-creator.png +0 -0
- package/skills/.system/skill-creator/license.txt +202 -0
- package/skills/.system/skill-creator/references/openai_yaml.md +49 -0
- package/skills/.system/skill-creator/scripts/generate_openai_yaml.py +226 -0
- package/skills/.system/skill-creator/scripts/init_skill.py +400 -0
- package/skills/.system/skill-creator/scripts/quick_validate.py +101 -0
- package/skills/.system/skill-installer/LICENSE.txt +202 -0
- package/skills/.system/skill-installer/SKILL.md +58 -0
- package/skills/.system/skill-installer/agents/openai.yaml +5 -0
- package/skills/.system/skill-installer/assets/skill-installer-small.svg +3 -0
- package/skills/.system/skill-installer/assets/skill-installer.png +0 -0
- package/skills/.system/skill-installer/scripts/github_utils.py +21 -0
- package/skills/.system/skill-installer/scripts/install-skill-from-github.py +308 -0
- package/skills/.system/skill-installer/scripts/list-skills.py +107 -0
- package/skills/cap/SKILL.md +77 -0
- package/skills/caveman/SKILL.md +49 -0
- package/skills/code-review/SKILL.md +46 -0
- package/skills/codebook/SKILL.md +184 -0
- package/skills/doc-review/SKILL.md +147 -0
- package/skills/feature-research/SKILL.md +34 -0
- package/skills/file-op/SKILL.md +116 -0
- package/skills/grill-me/SKILL.md +10 -0
- package/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/skills/grill-with-docs/SKILL.md +88 -0
- package/skills/handoff/SKILL.md +17 -0
- package/skills/improve-codebase/SKILL.md +79 -0
- package/skills/linear/SKILL.md +107 -0
- package/skills/next-step/SKILL.md +61 -0
- package/skills/no-reinvent/SKILL.md +131 -0
- package/skills/no-wall/SKILL.md +146 -0
- package/skills/online/SKILL.md +54 -0
- package/skills/plan-review/SKILL.md +55 -0
- package/skills/professional/SKILL.md +111 -0
- package/skills/promise-tracking/SKILL.md +131 -0
- package/skills/prove/SKILL.md +135 -0
- package/skills/read-before-write/SKILL.md +123 -0
- package/skills/review/SKILL.md +78 -0
- package/skills/review-mp/SKILL.md +78 -0
- package/skills/scope-boundary/SKILL.md +121 -0
- package/skills/semble-search/SKILL.md +40 -0
- package/skills/sitrep/SKILL.md +126 -0
- package/skills/structure-code/SKILL.md +116 -0
- package/skills/surface-assumptions/SKILL.md +139 -0
- package/skills/teach/GLOSSARY-FORMAT.md +35 -0
- package/skills/teach/LEARNING-RECORD-FORMAT.md +46 -0
- package/skills/teach/MISSION-FORMAT.md +31 -0
- package/skills/teach/RESOURCES-FORMAT.md +32 -0
- package/skills/teach/SKILL.md +131 -0
- package/skills/team-protocol/SKILL.md +172 -0
- package/skills/tech-lead/SKILL.md +332 -0
- package/skills/to-issues/SKILL.md +83 -0
- package/skills/to-prd/SKILL.md +74 -0
- package/skills/vectorbt-expert/SKILL.md +253 -0
- package/skills/verify-done/SKILL.md +128 -0
- package/skills/work-log/SKILL.md +141 -0
- package/skills/work-log/template.html +496 -0
- package/skills/zoom-out/SKILL.md +7 -0
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const fs = require("node:fs/promises");
|
|
4
|
+
const path = require("node:path");
|
|
5
|
+
|
|
6
|
+
const DEFAULT_URL =
|
|
7
|
+
"https://developers.openai.com/api/docs/guides/latest-model.md";
|
|
8
|
+
const DEFAULT_BASE_URL = "https://developers.openai.com";
|
|
9
|
+
|
|
10
|
+
function parseArgs(argv) {
|
|
11
|
+
const args = {
|
|
12
|
+
source: process.env.LATEST_MODEL_URL || DEFAULT_URL,
|
|
13
|
+
baseUrl: process.env.LATEST_MODEL_BASE_URL || DEFAULT_BASE_URL,
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
for (let i = 2; i < argv.length; i += 1) {
|
|
17
|
+
const arg = argv[i];
|
|
18
|
+
if (arg === "--source" || arg === "--url") {
|
|
19
|
+
args.source = argv[i + 1];
|
|
20
|
+
i += 1;
|
|
21
|
+
} else if (arg === "--base-url") {
|
|
22
|
+
args.baseUrl = argv[i + 1];
|
|
23
|
+
i += 1;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
return args;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
async function readSource(source) {
|
|
31
|
+
if (source.startsWith("file://")) {
|
|
32
|
+
return fs.readFile(new URL(source), "utf8");
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
if (!/^https?:\/\//.test(source)) {
|
|
36
|
+
return fs.readFile(path.resolve(source), "utf8");
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const response = await fetch(source, {
|
|
40
|
+
headers: { accept: "text/markdown,text/plain,*/*" },
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
if (!response.ok) {
|
|
44
|
+
throw new Error(`failed to fetch ${source}: ${response.status}`);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
return response.text();
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
function parseIndentedInfo(lines, startIndex) {
|
|
51
|
+
const info = {};
|
|
52
|
+
|
|
53
|
+
for (let i = startIndex + 1; i < lines.length; i += 1) {
|
|
54
|
+
const line = lines[i];
|
|
55
|
+
if (!line.trim()) {
|
|
56
|
+
continue;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const match = line.match(/^ {2}([A-Za-z][A-Za-z0-9_-]*):\s*(.+?)\s*$/);
|
|
60
|
+
if (!match) {
|
|
61
|
+
break;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
info[match[1]] = match[2].replace(/^["']|["']$/g, "");
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return info;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
function parseFlatInfo(block) {
|
|
71
|
+
const info = {};
|
|
72
|
+
|
|
73
|
+
for (const line of block.split(/\r?\n/)) {
|
|
74
|
+
const match = line.match(/^\s*([A-Za-z][A-Za-z0-9_-]*):\s*(.+?)\s*$/);
|
|
75
|
+
if (match) {
|
|
76
|
+
info[match[1]] = match[2].replace(/^["']|["']$/g, "");
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
return info;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
function extractLatestModelInfo(markdown) {
|
|
84
|
+
const lines = markdown.split(/\r?\n/);
|
|
85
|
+
const latestModelInfoIndex = lines.findIndex((line) =>
|
|
86
|
+
/^latestModelInfo:\s*$/.test(line)
|
|
87
|
+
);
|
|
88
|
+
|
|
89
|
+
if (latestModelInfoIndex >= 0) {
|
|
90
|
+
return parseIndentedInfo(lines, latestModelInfoIndex);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
const commentMatch = markdown.match(
|
|
94
|
+
/<!--\s*latestModelInfo\s*\n([\s\S]*?)\n\s*-->/m
|
|
95
|
+
);
|
|
96
|
+
if (commentMatch) {
|
|
97
|
+
return parseFlatInfo(commentMatch[1]);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return undefined;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
function modelToSkillSlug(model) {
|
|
104
|
+
return model.trim().replace(/\./g, "p");
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
function absoluteUrl(baseUrl, value) {
|
|
108
|
+
return new URL(value, baseUrl).toString();
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
function normalizeInfo(info, baseUrl) {
|
|
112
|
+
const model = info?.model?.trim();
|
|
113
|
+
const migrationGuide = info?.migrationGuide?.trim();
|
|
114
|
+
const promptingGuide = info?.promptingGuide?.trim();
|
|
115
|
+
|
|
116
|
+
if (!model || !migrationGuide || !promptingGuide) {
|
|
117
|
+
throw new Error(
|
|
118
|
+
"latestModelInfo must include model, migrationGuide, and promptingGuide"
|
|
119
|
+
);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return {
|
|
123
|
+
model,
|
|
124
|
+
modelSlug: modelToSkillSlug(model),
|
|
125
|
+
migrationGuideUrl: absoluteUrl(baseUrl, migrationGuide),
|
|
126
|
+
promptingGuideUrl: absoluteUrl(baseUrl, promptingGuide),
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
async function main() {
|
|
131
|
+
const { source, baseUrl } = parseArgs(process.argv);
|
|
132
|
+
const markdown = await readSource(source);
|
|
133
|
+
const info = extractLatestModelInfo(markdown);
|
|
134
|
+
|
|
135
|
+
if (!info) {
|
|
136
|
+
throw new Error(`latestModelInfo block not found in ${source}`);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
process.stdout.write(
|
|
140
|
+
`${JSON.stringify(normalizeInfo(info, baseUrl), null, 2)}\n`
|
|
141
|
+
);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
main().catch((error) => {
|
|
145
|
+
console.error(error.message);
|
|
146
|
+
process.exit(1);
|
|
147
|
+
});
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: plugin-creator
|
|
3
|
+
description: Create and scaffold plugin directories for Codex with a required `.codex-plugin/plugin.json`, optional plugin folders/files, valid manifest defaults, and personal-marketplace entries by default. Use when Codex needs to create a new personal plugin, add optional plugin structure, generate or update marketplace entries for plugin ordering and availability metadata, or update an existing local plugin during development with the CLI-driven cachebuster and reinstall flow.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Plugin Creator
|
|
7
|
+
|
|
8
|
+
## Quick Start
|
|
9
|
+
|
|
10
|
+
1. Run the scaffold script:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Plugin names are normalized to lower-case hyphen-case and must be <= 64 chars.
|
|
14
|
+
# The generated folder and plugin.json name are always the same.
|
|
15
|
+
# Run from the skill root (the directory containing this `SKILL.md`).
|
|
16
|
+
# By default creates in `~/plugins/<plugin-name>`.
|
|
17
|
+
python3 scripts/create_basic_plugin.py <plugin-name>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
2. Edit `<plugin-path>/.codex-plugin/plugin.json` when the request gives specific metadata.
|
|
21
|
+
The scaffold starts with valid defaults and must not contain `[TODO: ...]` placeholders.
|
|
22
|
+
|
|
23
|
+
3. Generate or update the personal marketplace entry when the plugin should appear in Codex UI ordering:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Personal marketplace entries default to `~/.agents/plugins/marketplace.json`.
|
|
27
|
+
python3 scripts/create_basic_plugin.py my-plugin --with-marketplace
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Only specify `--marketplace-name <name>` when the default `personal` marketplace name is already
|
|
31
|
+
taken or installed and you need to seed a different new marketplace file:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
python3 scripts/create_basic_plugin.py my-plugin \
|
|
35
|
+
--with-marketplace \
|
|
36
|
+
--marketplace-name team-local
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Only use a repo/team marketplace when the user specifically asks for that destination:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
python3 scripts/create_basic_plugin.py my-plugin \
|
|
43
|
+
--path <repo-root>/plugins \
|
|
44
|
+
--marketplace-path <repo-root>/.agents/plugins/marketplace.json \
|
|
45
|
+
--with-marketplace
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
When the user specifies a marketplace path, make sure that marketplace is actually installed before
|
|
49
|
+
telling the user to reinstall from it. The default personal marketplace file at
|
|
50
|
+
`~/.agents/plugins/marketplace.json` is discovered implicitly, but other marketplace paths are not.
|
|
51
|
+
On Windows, use the equivalent path under the user profile.
|
|
52
|
+
|
|
53
|
+
4. Generate/adjust optional companion folders as needed:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
python3 scripts/create_basic_plugin.py my-plugin \
|
|
57
|
+
--path <parent-plugin-directory> \
|
|
58
|
+
--marketplace-path <marketplace-json-path> \
|
|
59
|
+
--with-skills --with-hooks --with-scripts --with-assets --with-mcp --with-apps --with-marketplace
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
`<parent-plugin-directory>` is the directory where the plugin folder `<plugin-name>` will be
|
|
63
|
+
created (for example `~/plugins`).
|
|
64
|
+
|
|
65
|
+
5. Before handing back a generated plugin, run:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
python3 scripts/validate_plugin.py <plugin-path>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
For updates to an existing local plugin during development, keep the scaffold flow as-is and use the
|
|
72
|
+
reference instead of hand-editing marketplace files:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
python3 scripts/update_plugin_cachebuster.py <plugin-path>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Prefer the helper default cachebuster unless the user explicitly asks for a specific override.
|
|
79
|
+
See `references/installing-and-updating.md` for the expected cachebuster and reinstall flow while iterating on an existing local plugin.
|
|
80
|
+
|
|
81
|
+
## What this skill creates
|
|
82
|
+
|
|
83
|
+
- Default marketplace-backed scaffolds use the personal marketplace file at
|
|
84
|
+
`~/.agents/plugins/marketplace.json`, with plugins generally being stored in
|
|
85
|
+
`~/plugins/<plugin-name>/`.
|
|
86
|
+
- Creates plugin root at `/<parent-plugin-directory>/<plugin-name>/`.
|
|
87
|
+
- Always creates `/<parent-plugin-directory>/<plugin-name>/.codex-plugin/plugin.json`.
|
|
88
|
+
- Fills the manifest with the validated schema shape that the ingestion path accepts.
|
|
89
|
+
- Creates or updates `~/.agents/plugins/marketplace.json` when `--with-marketplace` is set.
|
|
90
|
+
- If the marketplace file does not exist yet, seed a personal marketplace root before adding the first plugin entry.
|
|
91
|
+
- `<plugin-name>` is normalized using skill-creator naming rules:
|
|
92
|
+
- `My Plugin` → `my-plugin`
|
|
93
|
+
- `My--Plugin` → `my-plugin`
|
|
94
|
+
- underscores, spaces, and punctuation are converted to `-`
|
|
95
|
+
- result is lower-case hyphen-delimited with consecutive hyphens collapsed
|
|
96
|
+
- Supports optional creation of:
|
|
97
|
+
- `skills/`
|
|
98
|
+
- `hooks/`
|
|
99
|
+
- `scripts/`
|
|
100
|
+
- `assets/`
|
|
101
|
+
- `.mcp.json`
|
|
102
|
+
- `.app.json`
|
|
103
|
+
|
|
104
|
+
## Marketplace workflow
|
|
105
|
+
|
|
106
|
+
- Personal-marketplace creation defaults to `~/.agents/plugins/marketplace.json`. Here,
|
|
107
|
+
"personal marketplace" means the marketplace whose file is at that path.
|
|
108
|
+
- Repo/team marketplace creation is opt-in through both `--path` and `--marketplace-path`, only
|
|
109
|
+
when the user specifically requests it.
|
|
110
|
+
- `--marketplace-name` is an exception path. Use it only when the default `personal` marketplace
|
|
111
|
+
name is already taken and you need to seed a different new marketplace file.
|
|
112
|
+
- Do not use `--marketplace-name` to rename an existing marketplace file in place. If the file
|
|
113
|
+
already exists, its top-level `name` must already match.
|
|
114
|
+
- If the user specifies a different marketplace path, treat that marketplace as needing explicit installation via `codex plugin marketplace add`.
|
|
115
|
+
- Prefer `scripts/read_marketplace_name.py` when you need the marketplace name from any
|
|
116
|
+
`marketplace.json` file. With no argument it reads the default personal marketplace; with an
|
|
117
|
+
explicit path it works for repo/team marketplaces too.
|
|
118
|
+
- In either location, the generated source path remains `./plugins/<plugin-name>`.
|
|
119
|
+
- Marketplace root metadata supports top-level `name` plus optional `interface.displayName`.
|
|
120
|
+
- Treat plugin order in `plugins[]` as render order in Codex. Append new entries unless a user explicitly asks to reorder the list.
|
|
121
|
+
- `displayName` belongs inside the marketplace `interface` object, not individual `plugins[]` entries.
|
|
122
|
+
- Each generated marketplace entry must include all of:
|
|
123
|
+
- `policy.installation`
|
|
124
|
+
- `policy.authentication`
|
|
125
|
+
- `category`
|
|
126
|
+
- Default new entries to:
|
|
127
|
+
- `policy.installation: "AVAILABLE"`
|
|
128
|
+
- `policy.authentication: "ON_INSTALL"`
|
|
129
|
+
- Override defaults only when the user explicitly specifies another allowed value.
|
|
130
|
+
- Allowed `policy.installation` values:
|
|
131
|
+
- `NOT_AVAILABLE`
|
|
132
|
+
- `AVAILABLE`
|
|
133
|
+
- `INSTALLED_BY_DEFAULT`
|
|
134
|
+
- Allowed `policy.authentication` values:
|
|
135
|
+
- `ON_INSTALL`
|
|
136
|
+
- `ON_USE`
|
|
137
|
+
- Treat `policy.products` as an override. Omit it unless the user explicitly requests product gating.
|
|
138
|
+
- The generated plugin entry shape is:
|
|
139
|
+
|
|
140
|
+
```json
|
|
141
|
+
{
|
|
142
|
+
"name": "plugin-name",
|
|
143
|
+
"source": {
|
|
144
|
+
"source": "local",
|
|
145
|
+
"path": "./plugins/plugin-name"
|
|
146
|
+
},
|
|
147
|
+
"policy": {
|
|
148
|
+
"installation": "AVAILABLE",
|
|
149
|
+
"authentication": "ON_INSTALL"
|
|
150
|
+
},
|
|
151
|
+
"category": "Productivity"
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
- Use `--force` only when intentionally replacing an existing marketplace entry for the same plugin name.
|
|
156
|
+
- If the target marketplace file does not exist yet, create it with top-level `"name"`, an `"interface"` object containing `"displayName"`, and a `plugins` array, then add the new entry.
|
|
157
|
+
|
|
158
|
+
- For a brand-new marketplace file, the root object should look like:
|
|
159
|
+
|
|
160
|
+
```json
|
|
161
|
+
{
|
|
162
|
+
"name": "personal",
|
|
163
|
+
"interface": {
|
|
164
|
+
"displayName": "Personal"
|
|
165
|
+
},
|
|
166
|
+
"plugins": [
|
|
167
|
+
{
|
|
168
|
+
"name": "plugin-name",
|
|
169
|
+
"source": {
|
|
170
|
+
"source": "local",
|
|
171
|
+
"path": "./plugins/plugin-name"
|
|
172
|
+
},
|
|
173
|
+
"policy": {
|
|
174
|
+
"installation": "AVAILABLE",
|
|
175
|
+
"authentication": "ON_INSTALL"
|
|
176
|
+
},
|
|
177
|
+
"category": "Productivity"
|
|
178
|
+
}
|
|
179
|
+
]
|
|
180
|
+
}
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
## Required behavior
|
|
184
|
+
|
|
185
|
+
- Outer folder name and `plugin.json` `"name"` are always the same normalized plugin name.
|
|
186
|
+
- Do not remove required structure; keep `.codex-plugin/plugin.json` present.
|
|
187
|
+
- Do not leave `[TODO: ...]` placeholders in plugin manifests.
|
|
188
|
+
- Keep `apps` and `mcpServers` out of `plugin.json` unless their companion files are actually created.
|
|
189
|
+
- Omit unsupported plugin manifest fields that validation rejects, including `hooks`.
|
|
190
|
+
- If creating files inside an existing plugin path, use `--force` only when overwrite is intentional.
|
|
191
|
+
- Preserve any existing marketplace `interface.displayName`.
|
|
192
|
+
- When generating marketplace entries, always write `policy.installation`, `policy.authentication`, and `category` even if their values are defaults.
|
|
193
|
+
- Add `policy.products` only when the user explicitly asks for that override.
|
|
194
|
+
- Keep marketplace `source.path` relative to the selected marketplace root as `./plugins/<plugin-name>`.
|
|
195
|
+
- Only use `--marketplace-name` when creating a new marketplace file whose name should not be
|
|
196
|
+
`personal` because that name is already taken or installed elsewhere.
|
|
197
|
+
- If Codex would need approval to write the marketplace file, ask for that approval before
|
|
198
|
+
proceeding. If the user prefers to run the write themselves, provide the exact scaffold command
|
|
199
|
+
and then continue from validation or subsequent plugin edits instead of leaving the workflow
|
|
200
|
+
vague.
|
|
201
|
+
- For updates to an existing local plugin during development, do not hand-edit marketplace config
|
|
202
|
+
or `marketplace.json`. Use the update flow documented in
|
|
203
|
+
`references/installing-and-updating.md` and `scripts/update_plugin_cachebuster.py`.
|
|
204
|
+
- Do not tell the user to run `codex plugin marketplace add` for the default personal-marketplace
|
|
205
|
+
flow. That command is for explicit non-default marketplace configuration, not for the standard
|
|
206
|
+
`~/.agents/plugins/marketplace.json` path.
|
|
207
|
+
- If the user provided a non-default `--marketplace-path`, make sure that marketplace is installed
|
|
208
|
+
before giving reinstall instructions. Use `codex plugin marketplace add <path-to-marketplace-root>`
|
|
209
|
+
when that explicit marketplace has not been configured yet.
|
|
210
|
+
- When the workflow created or updated a marketplace-backed plugin, end the final user-facing
|
|
211
|
+
response with a short Codex app handoff. Say `To view this in the Codex app:` and write
|
|
212
|
+
`View <normalized plugin name>` and `Share <normalized plugin name>` as Markdown links, not raw
|
|
213
|
+
URLs or code spans.
|
|
214
|
+
- The View deeplink uses `codex://plugins/<normalized plugin name>?marketplacePath=<absolute marketplace.json path>`.
|
|
215
|
+
The Share deeplink uses the same URL with `&mode=share`.
|
|
216
|
+
- Replace the placeholders with the real normalized plugin name and absolute `marketplace.json`
|
|
217
|
+
path from the scaffolded plugin. URL-encode the path segment and query value when needed.
|
|
218
|
+
- Do not add `pluginName` or `hostId` query parameters to these deeplinks. Codex derives both after
|
|
219
|
+
the user clicks the link.
|
|
220
|
+
- Do not emit the `View <normalized plugin name>` or `Share <normalized plugin name>` links when no marketplace entry was
|
|
221
|
+
created or updated.
|
|
222
|
+
|
|
223
|
+
## Reference to exact spec sample
|
|
224
|
+
|
|
225
|
+
For the exact canonical sample JSON for both plugin manifests and marketplace entries, use:
|
|
226
|
+
|
|
227
|
+
- `references/plugin-json-spec.md`
|
|
228
|
+
- `references/installing-and-updating.md` for update/reinstall guidance while
|
|
229
|
+
iterating on an existing local plugin, plus the new-thread pickup behavior after reinstall
|
|
230
|
+
|
|
231
|
+
## Validation
|
|
232
|
+
|
|
233
|
+
After editing `SKILL.md`, run:
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
python3 ../skill-creator/scripts/quick_validate.py .
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
Before handing back a generated plugin, run:
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
python3 scripts/validate_plugin.py <plugin-path>
|
|
243
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Plugin Creator"
|
|
3
|
+
short_description: "Scaffold plugins and marketplace entries"
|
|
4
|
+
default_prompt: "Use $plugin-creator to scaffold a valid plugin in the personal marketplace, then validate it before handing it back."
|
|
5
|
+
icon_small: "./assets/plugin-creator-small.svg"
|
|
6
|
+
icon_large: "./assets/plugin-creator.png"
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" viewBox="0 0 20 20">
|
|
2
|
+
<path fill="#0D0D0D" d="M12.03 4.113a3.612 3.612 0 0 1 5.108 5.108l-6.292 6.29c-.324.324-.56.561-.791.752l-.235.176c-.205.14-.422.261-.65.36l-.229.093a4.136 4.136 0 0 1-.586.16l-.764.134-2.394.4c-.142.024-.294.05-.423.06-.098.007-.232.01-.378-.026l-.149-.05a1.081 1.081 0 0 1-.521-.474l-.046-.093a1.104 1.104 0 0 1-.075-.527c.01-.129.035-.28.06-.422l.398-2.394c.1-.602.162-.987.295-1.35l.093-.23c.1-.228.22-.445.36-.65l.176-.235c.19-.232.428-.467.751-.79l6.292-6.292Zm-5.35 7.232c-.35.35-.534.535-.66.688l-.11.147a2.67 2.67 0 0 0-.24.433l-.062.154c-.08.22-.124.462-.232 1.112l-.398 2.394-.001.001h.003l2.393-.399.717-.126a2.63 2.63 0 0 0 .394-.105l.154-.063a2.65 2.65 0 0 0 .433-.24l.147-.11c.153-.126.339-.31.688-.66l4.988-4.988-3.227-3.226-4.987 4.988Zm9.517-6.291a2.281 2.281 0 0 0-3.225 0l-.364.362 3.226 3.227.363-.364c.89-.89.89-2.334 0-3.225ZM4.583 1.783a.3.3 0 0 1 .294.241c.117.585.347 1.092.707 1.48.357.385.859.668 1.549.783a.3.3 0 0 1 0 .592c-.69.115-1.192.398-1.549.783-.315.34-.53.77-.657 1.265l-.05.215a.3.3 0 0 1-.588 0c-.117-.585-.347-1.092-.707-1.48-.357-.384-.859-.668-1.549-.783a.3.3 0 0 1 0-.592c.69-.115 1.192-.398 1.549-.783.36-.388.59-.895.707-1.48l.015-.05a.3.3 0 0 1 .279-.19Z"/>
|
|
3
|
+
</svg>
|
|
Binary file
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# Updating Existing Local Plugins
|
|
2
|
+
|
|
3
|
+
Use this reference when a plugin already exists and the request is about updating the plugin during
|
|
4
|
+
local development.
|
|
5
|
+
|
|
6
|
+
All scripts here are specified relative to the skill root. Update the path for running the scripts
|
|
7
|
+
depending on your current working directory.
|
|
8
|
+
|
|
9
|
+
## When To Use This Flow
|
|
10
|
+
|
|
11
|
+
Use this flow when all of the following are true:
|
|
12
|
+
|
|
13
|
+
- the plugin already exists locally
|
|
14
|
+
- the marketplace entry already points at the plugin source you are editing
|
|
15
|
+
- the user wants Codex to see the updated plugin without manually editing marketplace files
|
|
16
|
+
|
|
17
|
+
If the user still needs the initial plugin entry or marketplace structure created, use the scaffold
|
|
18
|
+
flow first and only then switch to this reinstall flow.
|
|
19
|
+
|
|
20
|
+
## Update Loop
|
|
21
|
+
|
|
22
|
+
1. Update the plugin manifest to a single Codex cachebuster suffix:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
python3 scripts/update_plugin_cachebuster.py \
|
|
26
|
+
<plugin-path>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Prefer the default helper behavior here. If you omit `--cachebuster`, the helper uses a UTC
|
|
30
|
+
timestamp down to seconds, which is the recommended path for routine local iteration.
|
|
31
|
+
|
|
32
|
+
Only use a manual cachebuster override when the user explicitly asks for one or when a workflow
|
|
33
|
+
outside Codex depends on a specific token:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
python3 scripts/update_plugin_cachebuster.py \
|
|
37
|
+
<plugin-path> \
|
|
38
|
+
--cachebuster local-20260519-184516
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
2. For the default scaffolded flow, read the marketplace name from the personal marketplace file:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
python3 scripts/read_marketplace_name.py
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Here, "personal marketplace" means the marketplace whose file is at
|
|
48
|
+
`~/.agents/plugins/marketplace.json`. On Windows, use the equivalent path under the user profile.
|
|
49
|
+
The helper uses Python's home-directory resolution and prints the marketplace name to use when
|
|
50
|
+
constructing the install command.
|
|
51
|
+
|
|
52
|
+
To read the name from a different marketplace file, pass the path directly:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
python3 scripts/read_marketplace_name.py --marketplace-path <path-to-marketplace.json>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
3. Reinstall from that marketplace name:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
codex plugin add <plugin-name>@<marketplace-name-from-marketplace-json>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The default personal marketplace is discovered implicitly from
|
|
65
|
+
`~/.agents/plugins/marketplace.json`. You do not need `codex plugin marketplace add` for that
|
|
66
|
+
path, and `codex plugin marketplace list` is not the right check for whether that default
|
|
67
|
+
marketplace exists.
|
|
68
|
+
|
|
69
|
+
4. If the plugin is not using the personal marketplace file, check which configured local
|
|
70
|
+
marketplace is actually surfacing that plugin:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
codex plugin list
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
If the plugin is not in the personal marketplace file, confirm which marketplace entry points at
|
|
77
|
+
the plugin source you are editing and make sure that marketplace is still local. If it is a
|
|
78
|
+
different local marketplace, reinstall from that marketplace name instead of forcing the personal
|
|
79
|
+
marketplace flow. If it is not local, stop and help the user resolve the mismatch before
|
|
80
|
+
continuing.
|
|
81
|
+
|
|
82
|
+
5. If the plugin lives in a different confirmed local marketplace, substitute that marketplace
|
|
83
|
+
name:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
codex plugin add <plugin-name>@<local-marketplace>
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
6. Prompt the user to use a new thread to try the updated plugin, so that Codex picks up new skills
|
|
90
|
+
and tools.
|
|
91
|
+
|
|
92
|
+
## Cachebuster Policy
|
|
93
|
+
|
|
94
|
+
- Preserve the existing version prefix and replace only the suffix.
|
|
95
|
+
- Treat the preserved prefix as everything before `+`.
|
|
96
|
+
- Use the format:
|
|
97
|
+
|
|
98
|
+
```text
|
|
99
|
+
<base-version>+codex.<cachebuster>
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Examples:
|
|
103
|
+
|
|
104
|
+
- `0.1.0` → `0.1.0+codex.local-20260519-184516`
|
|
105
|
+
- `0.1.0+codex.old-token` → `0.1.0+codex.local-20260519-184516`
|
|
106
|
+
- `1.2.3-beta.1+codex.prev` → `1.2.3-beta.1+codex.local-20260519-184516`
|
|
107
|
+
- `dev-build+other-tag` → `dev-build+codex.local-20260519-184516`
|
|
108
|
+
|
|
109
|
+
Replace the existing Codex cachebuster instead of appending another one. Do not keep incrementing
|
|
110
|
+
numeric version components just to trigger reinstall behavior.
|
|
111
|
+
|
|
112
|
+
## Marketplace Rules
|
|
113
|
+
|
|
114
|
+
- Marketplace manipulation should happen through commands, not by hand-editing `marketplace.json`
|
|
115
|
+
or `config.toml` during this update/reinstall flow.
|
|
116
|
+
- Prefer the personal marketplace file for the default scaffolded flow.
|
|
117
|
+
- Read the personal marketplace name with
|
|
118
|
+
`python3 scripts/read_marketplace_name.py` and use the printed value when constructing
|
|
119
|
+
`codex plugin add <plugin-name>@<marketplace-name>`.
|
|
120
|
+
- For non-default marketplace files, use
|
|
121
|
+
`python3 scripts/read_marketplace_name.py --marketplace-path <path-to-marketplace.json>` to read
|
|
122
|
+
the name before constructing reinstall commands.
|
|
123
|
+
- Do not tell the user to run `codex plugin marketplace add` for the default personal-marketplace
|
|
124
|
+
flow. That marketplace is discovered implicitly by Codex.
|
|
125
|
+
- If the user specified a different marketplace path, make sure that marketplace is installed
|
|
126
|
+
before giving install or reinstall instructions. Non-default marketplace paths are not
|
|
127
|
+
discovered implicitly.
|
|
128
|
+
- Use `codex plugin list` when the plugin lives in a different configured marketplace and you need
|
|
129
|
+
to confirm which marketplace is surfacing that plugin.
|
|
130
|
+
- If a non-default local marketplace has not been configured yet, install it with
|
|
131
|
+
`codex plugin marketplace add <path-to-marketplace-root>` before telling the user to run
|
|
132
|
+
`codex plugin add <plugin-name>@<marketplace-name>`.
|
|
133
|
+
- If the plugin is not in the personal marketplace file, confirm that the selected marketplace is
|
|
134
|
+
local before telling the user to reinstall from it.
|
|
135
|
+
- If the selected marketplace is not local, stop and help the user resolve that mismatch rather
|
|
136
|
+
than pretending the normal local reinstall flow applies.
|
|
137
|
+
- If the plugin source is not already the source referenced by the chosen marketplace entry, stop
|
|
138
|
+
and fix that first. This update flow does not rewrite marketplace entries.
|
|
139
|
+
|
|
140
|
+
## After Reinstall
|
|
141
|
+
|
|
142
|
+
After reinstalling, prompt the user to start a new thread for testing. That is the safe boundary for
|
|
143
|
+
picking up the updated plugin and its MCP tools.
|