[#184] Document mcs export command and Export/ architecture#191
[#184] Document mcs export command and Export/ architecture#191
Conversation
- Add mcs export with all flags to CLAUDE.md commands block - Add ExportCommand.swift and Export/ subsection to architecture docs - Move Quick Start with mcs export to top of creating-tech-packs guide
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to reflect the mcs export command and the new Sources/mcs/Export/ architecture, and makes the export quick-start more prominent for users authoring tech packs.
Changes:
- Adds
mcs exportusage (including flags) toCLAUDE.mdand documents theExport/subsystem files. - Promotes the “Quick Start with
mcs export” section to the top ofdocs/creating-tech-packs.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/creating-tech-packs.md |
Moves/export quick-start to the top and describes export behavior. |
CLAUDE.md |
Documents mcs export command/flags and adds Export/ architecture bullets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The export wizard discovers your MCP servers, hooks, skills, commands, plugins, CLAUDE.md sections, gitignore entries, and settings — then generates a complete pack directory with `techpack.yaml` and all supporting files. | ||
|
|
||
| **What it handles automatically:** | ||
| - Sensitive env vars (API keys, tokens) are replaced with `__PLACEHOLDER__` tokens and corresponding `prompts:` entries are generated |
There was a problem hiding this comment.
Docs say sensitive env vars are replaced with __PLACEHOLDER__, but mcs export actually replaces them with __<ENV_VAR_NAME>__ (e.g., __API_KEY__) and generates matching prompts entries. Update this bullet to match the actual placeholder format so users don't copy the wrong token.
| - Sensitive env vars (API keys, tokens) are replaced with `__PLACEHOLDER__` tokens and corresponding `prompts:` entries are generated | |
| - Sensitive env vars (API keys, tokens) are replaced with `__<ENV_VAR_NAME>__` tokens (e.g., `__API_KEY__`) and corresponding `prompts:` entries are generated |
docs/creating-tech-packs.md
Outdated
| mcs export ./my-pack --global --dry-run | ||
| ``` | ||
|
|
||
| The export wizard discovers your MCP servers, hooks, skills, commands, plugins, CLAUDE.md sections, gitignore entries, and settings — then generates a complete pack directory with `techpack.yaml` and all supporting files. |
There was a problem hiding this comment.
The quick-start summary implies mcs export always discovers gitignore entries, but ConfigurationDiscovery only reads gitignore entries for --global exports. Consider clarifying this (e.g., “gitignore entries (global export only)”) to avoid confusing users exporting a project-scoped pack.
| The export wizard discovers your MCP servers, hooks, skills, commands, plugins, CLAUDE.md sections, gitignore entries, and settings — then generates a complete pack directory with `techpack.yaml` and all supporting files. | |
| The export wizard discovers your MCP servers, hooks, skills, commands, plugins, CLAUDE.md sections, gitignore entries (global export only), and settings — then generates a complete pack directory with `techpack.yaml` and all supporting files. |
- Add "(global export only)" qualifier to gitignore mention in export docs
Summary
PR #178 added
mcs exportbut CLAUDE.md was not updated. This adds the missing documentation and promotes the export quick-start guide in the creating-tech-packs doc.Changes
mcs exportwith all flags (--global,--identifier,--non-interactive,--dry-run) to the CLAUDE.md commands blockExportCommand.swiftbullet to the Commands architecture section### Export (Sources/mcs/Export/)subsection documentingConfigurationDiscovery,ManifestBuilder,PackWritermcs export" from bottom to top ofdocs/creating-tech-packs.mdTest plan
swift buildpasses locallyCLAUDE.md,docs/)Closes #184