You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,6 +70,7 @@ This is a public repository. When working on security-related docs or fixes:
70
70
- Use neutral functional wording, such as `improve input validation`, instead of naming the vulnerability class.
71
71
- Keep vulnerability details in private reporting channels.
72
72
- Never commit `PROMPT_READY.txt` generated from a private project.
73
+
- When documenting downstream product-repo setup, keep installed APCP operating files local/private by default and prefer local Git excludes over committed `.gitignore` rules if public GitHub should not reveal AI workflow filenames.
73
74
- Do not weaken `.gitignore`, security guidance, or private-context warnings without a clear replacement.
- Private AI system prompts, tool policies, vector-store layout
303
305
Storage: local workspace, private docs, or approved internal knowledge base
304
-
Rule: Do not commit to public GitHub or customer packages. Create a sanitized public summary instead.
306
+
Rule: Do not commit to public GitHub or customer packages by default. AI agents may read these files locally, from private/cloud knowledge bases, or from generated context bundles. Create a sanitized public summary or template only when explicitly approved.
Copy file name to clipboardExpand all lines: DOMAIN_SPECIFIC_GITIGNORE_PROTOCOLS.md
+45-7Lines changed: 45 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -210,6 +210,8 @@ Universal rule:
210
210
211
211
Treat filled project context files like secrets when they reveal how the system is built. Backend topology, route maps, service names, database internals, private infrastructure, internal admin flows, security controls, deployment topology, private prompts, tool policies, vector-store layout, threat models, penetration-test reports, and runbooks should not be pushed to a public repository or included in a customer package by default.
212
212
213
+
For downstream product repositories that should not reveal local AI workflow files on GitHub, use local Git excludes instead of committed ignore rules. `.git/info/exclude` and private global excludes files let AI agents read APCP files locally while keeping the public repository free of the protocol filenames and generated context artifacts.
214
+
213
215
If public documentation is needed, create a sanitized public version that removes internal hostnames, admin routes, service topology, database details, security controls, credentials, private prompts, and exploit-relevant implementation details.
214
216
215
217
AI prompt:
@@ -227,7 +229,7 @@ State whether the repository is safe for public GitHub.
227
229
228
230
## 3. AI-Assisted Project and APCP Gitignore Block
229
231
230
-
Use for APCP/MACP projects, AI coding sessions, prompt packs, context gatherers, and multi-agent workflows.
232
+
Use for APCP/MACP projects, AI coding sessions, prompt packs, context gatherers, and multi-agent workflows. Apply this block to `.git/info/exclude` when public GitHub should not show the local AI workflow filenames. Apply it to committed `.gitignore` only when the repository intentionally makes those ignore rules public.
231
233
232
234
```gitignore
233
235
# APCP / MACP / AI-generated context
@@ -245,6 +247,34 @@ PROMPT_READY.tmp
245
247
*.context.local
246
248
*.scratch.md
247
249
250
+
# Installed Nexus-APCP operating files in downstream product repos
251
+
AI_PROJECT_CONTEXT_PROTOCOL.md
252
+
AI_MAIN.md
253
+
TASK_PROGRESS.yaml
254
+
DECISION_LOG_PROTOCOL.md
255
+
CONTEXT_OPTIMIZATION.md
256
+
CAVEMAN_RULES.md
257
+
EMOJI_POLICY.md
258
+
VISUAL_CONTEXT_MERMAID.md
259
+
AI_AGENT_SKILLS_PROTOCOL.md
260
+
AI_TOOL_ADAPTER_COMPATIBILITY_PROTOCOL.md
261
+
FILE_STRUCTURE_REFACTOR_PROTOCOL.md
262
+
WORKSPACE_SPECIFIC_DELIVERY_PROTOCOLS.md
263
+
WEBSITE_BACKEND_SECURITY_OPTIMIZATION_PROTOCOL.md
264
+
DOMAIN_SPECIFIC_GITIGNORE_PROTOCOLS.md
265
+
UPDATE_SYSTEM_RECOMMENDATION_PROTOCOL.md
266
+
DEBLOAT_APPLICATION_GUIDE.md
267
+
DISCOVER_ALGORITHM_DESIGN_GUIDE.md
268
+
FRONTEND_APPLICATION_DESIGN_PROTOCOL.md
269
+
MACP_IMPLEMENTATION_GUIDE.md
270
+
UNIVERSAL_APPLICATION_SECURITY_PROTOCOL.md
271
+
WATERFALL_DEVELOPMENT_PROTOCOL.md
272
+
README_APCP_KIT.md
273
+
MASTER_PROMPT.md
274
+
AI_ASSISTANT_PROMPT_TEMPLATES.md
275
+
docs/AI_ASSISTANT_PROMPT_TEMPLATES.md
276
+
scripts/apcp-gather.py
277
+
248
278
# Filled APCP project context is private by default
249
279
AI_PROJECT_CONTEXT.md
250
280
PROJECT_CONTEXT.md
@@ -262,8 +292,9 @@ Rules:
262
292
263
293
- Do not commit raw AI logs containing secrets, private prompts, customer data, local file paths, or credentials.
264
294
- Do not commit temporary prompt bundles generated from private repositories.
295
+
- Do not commit installed Nexus-APCP operating files to downstream public product repositories by default; keep them local or in an approved private/cloud knowledge base for AI agents.
265
296
- Do not commit filled `AI_PROJECT_CONTEXT.md` files for real projects when they expose backend structure, database layout, infrastructure, internal services, route maps, private prompts, or security assumptions.
266
-
- Do commit sanitized protocol templates.
297
+
- Do commit sanitized protocol templates only when the repository intentionally publishes its AI workflow templates.
267
298
- Do commit decision logs if they contain no secrets or customer data.
268
299
- Do not paste local secret files into AI context.
269
300
@@ -272,7 +303,9 @@ AI prompt:
272
303
```text
273
304
You are preparing an APCP/MACP repository for safe GitHub use.
274
305
Review the project for AI-generated context artifacts, local prompt bundles, heartbeats, temporary scratch files, and private session logs.
275
-
Create or update `.gitignore` so generated AI artifacts are ignored, but protocol templates, sanitized handoffs, sanitized state files, and documentation remain trackable.
306
+
If public GitHub should not reveal local AI workflow files, add installed APCP operating files and generated AI artifacts to `.git/info/exclude` or a private global excludes file instead of committed `.gitignore`.
307
+
Use committed `.gitignore` only when the public ignore rule itself is acceptable.
308
+
Keep protocol templates, sanitized handoffs, sanitized state files, and documentation trackable only when the repository intentionally publishes them.
276
309
Also list any file currently tracked that should be removed from Git with `git rm --cached`.
277
310
```
278
311
@@ -1201,6 +1234,8 @@ Checklist:
1201
1234
-`git check-ignore -v path/to/suspicious/file` for any file that should be ignored.
1202
1235
- Confirm no `.env`, local database, dump, build, package, credential, customer export, private dataset, vector store, or model checkpoint is staged.
1203
1236
- Confirm no filled project context, backend map, internal architecture, private threat model, deployment topology, database internals, penetration-test report, or security runbook is staged for a public repository.
1237
+
- Confirm no downstream installed APCP operating file or generated context bundle is staged unless sanitized publication was explicitly approved.
1238
+
- If public GitHub should not reveal AI workflow filenames, confirm APCP rules live in `.git/info/exclude` or a private global excludes file instead of committed `.gitignore`.
1204
1239
- Confirm `.env.example` is staged/tracked when config changed.
1205
1240
- Confirm migrations are tracked when schema changed.
1206
1241
- Confirm lockfiles are tracked when dependencies changed.
@@ -1212,13 +1247,14 @@ AI prompt:
1212
1247
1213
1248
```text
1214
1249
Perform a pre-push gitignore audit.
1215
-
1. Read `.gitignore`.
1250
+
1. Read `.gitignore` and, when relevant, `.git/info/exclude`.
1216
1251
2. Read `git status --short`.
1217
1252
3. Inspect staged and unstaged file names.
1218
-
4. Identify any secrets, environment files, local DBs, dumps, generated builds, customer exports, AI vector stores, model checkpoints, logs, crash dumps, private project context, backend maps, internal architecture docs, private threat models, deployment topology maps, or domain-sensitive data that should not be committed.
1253
+
4. Identify any secrets, environment files, local DBs, dumps, generated builds, customer exports, AI vector stores, model checkpoints, logs, crash dumps, downstream installed APCP operating files, generated context bundles, private project context, backend maps, internal architecture docs, private threat models, deployment topology maps, or domain-sensitive data that should not be committed.
1219
1254
5. Identify any important source/config files that are accidentally ignored.
1220
-
6. Provide exact remediation commands, but do not run destructive commands without approval.
1221
-
7. State whether the repository is safe to push.
1255
+
6. If public GitHub should not reveal AI workflow filenames, prefer local exclude remediation over committed `.gitignore` changes.
1256
+
7. Provide exact remediation commands, but do not run destructive commands without approval.
1257
+
8. State whether the repository is safe to push.
1222
1258
```
1223
1259
1224
1260
---
@@ -1334,6 +1370,7 @@ Every delivery report should include a `.gitignore` section:
1334
1370
Gitignore and public exposure:
1335
1371
- Workspace/domain:
1336
1372
- .gitignore updated: yes/no
1373
+
- Local exclude used for APCP/AI workflow files: yes/no
1337
1374
- Domain-specific blocks applied:
1338
1375
- Files intentionally ignored:
1339
1376
- Files intentionally kept tracked:
@@ -1371,6 +1408,7 @@ Before suggesting "push to GitHub", "package this", "send to the customer", or "
1371
1408
- Does it block internal project context, backend maps, architecture maps, deployment maps, and private threat models?
1372
1409
- Does it block secrets and private keys?
1373
1410
- Does it block AI private context and vector stores?
1411
+
- If public GitHub should not reveal AI workflow files, are installed APCP files handled through local/private excludes instead of committed public ignore rules?
1374
1412
- Does it avoid hiding files that must be tracked?
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
12
12
Use Nexus-APCP with **Claude Code, Cursor, ChatGPT, Gemini, GitHub Copilot, local LLMs, and multi-agent development workflows** to reduce context loss, repeated explanations, inconsistent code suggestions, and prompt bloat. It also gives teams a safe way to document AI tool and adapter differences without copying vendor system prompts into public repos.
13
13
14
-
> Security note: protocol templates may be public, but filled project-context files, backend maps, internal architecture diagrams, deployment maps, database internals, private threat models, and security runbooks should stay local/private unless sanitized and explicitly approved.
14
+
> Security note: protocol templates may be public in this Nexus-APCP source repository, but downstream product repositories should keep installed Nexus-APCP operating files local or in an approved private/cloud knowledge base by default. Filled project-context files, backend maps, internal architecture diagrams, deployment maps, database internals, private threat models, and security runbooks should stay local/private unless sanitized and explicitly approved.
15
15
16
16
## What Nexus-APCP Solves
17
17
@@ -31,7 +31,7 @@ AI-assisted software development gets slower when every new model, chat, IDE age
31
31
-**Website backend security**: static-first backend rules help teams avoid unnecessary SQL/auth/API surface for portfolio, landing, and brochure sites while still supporting secure growth into dynamic features.
32
32
-**User-requested update systems**: update-system fit checks help agents recommend a GitHub SemVer + zip-sync updater only when the project and user request make it appropriate.
33
33
-**Emoji-free output**: `EMOJI_POLICY.md` bans emoji in repository files and AI-generated output, with a user-approved temporary exception only for missing button icons.
34
-
-**Safer publishing**: domain-specific `.gitignore`guidance helps prevent secrets, internal maps, customer data, and generated context from leaking.
34
+
-**Safer publishing**: domain-specific ignore and local-exclude guidance helps prevent secrets, internal maps, customer data, generated context, and downstream APCP operating files from leaking.
35
35
36
36
## Core Features
37
37
@@ -52,7 +52,7 @@ AI-assisted software development gets slower when every new model, chat, IDE age
52
52
| Update System Recommendation Protocol | Guides AI agents to suggest a lightweight GitHub SemVer + zip-sync updater only when the user requests updates and the project profile fits. |
53
53
| Debloat Application Guide | Guides ad-free, consent-aware, dependency-light application design with optional features and measurable performance checks. |
54
54
| Emoji Policy | Bans emoji in repository content and AI output except user-approved temporary button icon placeholders. |
55
-
| GitHub Safety Rules | Includes broad `.gitignore`patterns for AI artifacts, secrets, generated files, domain data, and private docs. |
55
+
| GitHub Safety Rules | Includes broad ignore and local-exclude patterns for AI artifacts, protocol operating files, secrets, generated files, domain data, and private docs. |
56
56
57
57
## Quick Start
58
58
@@ -86,6 +86,8 @@ mkdir -p /your/project/scripts
86
86
cp scripts/apcp-gather.py /your/project/scripts/
87
87
```
88
88
89
+
For a downstream product repository, treat these copied files as local agent operating context by default. AI agents can read them from local paths, private cloud docs, or generated context bundles, but the public GitHub repository does not need to expose the AI workflow files unless you intentionally publish sanitized templates. If the public repo should not show these files, put the APCP paths in `.git/info/exclude` or a private global excludes file before any push; use a committed `.gitignore` block only when the public ignore rule itself is acceptable.
90
+
89
91
Generate an AI-ready context package:
90
92
91
93
```bash
@@ -115,6 +117,11 @@ Git command rule:
115
117
- Inspect files and folders directly first.
116
118
- If Git state is truly needed, explain why and ask before running the command.
117
119
120
+
Public repository rule:
121
+
- Install Nexus-APCP files for local or approved private/cloud agent context by default.
122
+
- Before any GitHub push, keep installed APCP files, generated context bundles, private task state, and internal maps out of the public repository unless I explicitly approve sanitized public templates.
123
+
- Prefer `.git/info/exclude` or a private global excludes file when the public GitHub repo should not reveal local AI workflow files.
124
+
118
125
Install these core files when available:
119
126
- AI_PROJECT_CONTEXT_PROTOCOL.md
120
127
- AI_MAIN.md
@@ -238,7 +245,7 @@ Yes. Nexus-APCP is model-agnostic and works with hosted assistants, IDE agents,
238
245
239
246
### Is filled project context safe to publish?
240
247
241
-
Usually no. Filled project context can expose internal architecture, deployment topology, database internals, secrets, private prompts, or security assumptions. Publish sanitized templates, not private implementation maps.
248
+
Usually no. Filled project context can expose internal architecture, deployment topology, database internals, secrets, private prompts, security assumptions, and local AI workflow details. In downstream product repositories, keep installed APCP operating files local or in approved private/cloud knowledge bases by default. Publish sanitized templates, not private implementation maps.
Copy file name to clipboardExpand all lines: README_APCP_KIT.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
## KIT CONTENTS (4 Files)
8
8
9
-
This kit consists of 4 core files. You should use them all together:
9
+
This kit consists of 4 core files. You should use them all together as agent operating context. In downstream product repositories, keep installed Nexus-APCP files local or in an approved private/cloud knowledge base by default unless you intentionally publish sanitized templates.
Security rule: the filled `AI_PROJECT_CONTEXT_PROTOCOL.md` for a real project is private by default. It can expose backend structure, internal architecture, database internals, deployment topology, admin flows, private prompts, and security assumptions. Keep it local or in an approved private knowledge base unless you create a sanitized public version.
106
106
107
+
Public repository rule: AI agents may read APCP files from local paths, private cloud docs, or generated context bundles, but public GitHub does not need to show the local AI workflow files. Use `.git/info/exclude` or a private global excludes file when those filenames should not appear in the public repository.
108
+
107
109
### Step 3: Create Helper Scripts (5 min)
108
110
109
111
```bash
@@ -114,20 +116,16 @@ Security rule: the filled `AI_PROJECT_CONTEXT_PROTOCOL.md` for a real project is
Copy file name to clipboardExpand all lines: SECURITY.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
# Security Policy
2
2
3
-
Nexus-APCP is a public protocol kit, but real project context can be sensitive. Treat filled context files and generated AI context packagesas private by default.
3
+
Nexus-APCP is a public protocol kit, but real project context can be sensitive. Treat filled context files, generated AI context packages, and downstream installed APCP operating files as private by default unless sanitized publication is explicitly approved.
4
4
5
5
## Do Not Publish
6
6
7
7
- Filled `AI_PROJECT_CONTEXT.md` files from real projects.
8
+
- Installed Nexus-APCP operating files copied into downstream public product repositories, unless they are intentionally approved sanitized templates.
0 commit comments