### Setup Completion Summary Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-setup/SKILL.md This summary confirms the completion of the Compound Engineering setup, listing installed and skipped items. It also provides a command to re-check the setup. ```text ✅ Compound Engineering setup complete Installed: agent-browser, gh, jq Skipped: rtk Run /ce-setup anytime to re-check. ``` -------------------------------- ### Progressive Help Discovery Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/solutions/agent-friendly-cli-principles.md Demonstrates layered help output for a CLI, starting from top-level commands to subcommand-specific options and examples. This helps agents discover functionality incrementally. ```bash $ blog-cli --help Usage: blog-cli Commands: publish Publish content posts List and manage posts ``` ```bash $ blog-cli publish --help Publish a markdown file to your blog. Options: --content Path to markdown file --status Post status (draft, published, scheduled; default: published) --yes Skip confirmation prompt --json Output as JSON --dry-run Preview without publishing Examples: blog-cli publish --content my-post.md blog-cli publish --content my-post.md --status draft blog-cli publish --content my-post.md --dry-run ``` -------------------------------- ### Local Development Setup Commands Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/README.md Commands for setting up local development environment, including installing dependencies, running tests, and validating the release. These commands are executed from the repository root. ```bash bun install ``` ```bash bun test ``` ```bash bun run release:validate ``` -------------------------------- ### Sync to Copilot Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/plans/2026-02-14-feat-add-copilot-converter-target-plan.md Example command to synchronize files to the Copilot target. ```bash compound sync copilot ``` -------------------------------- ### Install Copilot CLI Plugin Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/specs/copilot.md Use these commands to install a Copilot CLI plugin from the marketplace or directly. ```text /plugin marketplace add EveryInc/compound-engineering-plugin /plugin install compound-engineering@compound-engineering-plugin ``` ```bash copilot plugin marketplace add EveryInc/compound-engineering-plugin copilot plugin install compound-engineering@compound-engineering-plugin ``` -------------------------------- ### Check agent-browser Installation Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-demo-reel/references/tier-browser-reel.md This message is displayed if the `agent-browser` tool is not installed, guiding the user to run `/ce-setup` to install dependencies. ```bash agent-browser is not installed. Run /ce-setup to install required dependencies. ``` -------------------------------- ### Setup Tutorials Repository Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/coding-tutor/skills/coding-tutor/SKILL.md Run this script to ensure the central tutorials repository exists. It creates the necessary directory for storing tutorials and learner profiles. ```bash python3 ${CLAUDE_PLUGIN_ROOT}/skills/coding-tutor/scripts/setup_tutorials.py ``` -------------------------------- ### Intent Summary Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-code-review/SKILL.md An example of a concise intent summary used to guide reviewer focus. ```text Intent: Simplify tax calculation by replacing the multi-tier rate lookup with a flat-rate computation. Must not regress edge cases in tax-exempt handling. ``` -------------------------------- ### Create New Tutorial Script Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/coding-tutor/skills/coding-tutor/SKILL.md Use this script to generate a new tutorial file with a predefined template. Specify the topic name and related concepts. ```bash python3 ${CLAUDE_PLUGIN_ROOT}/skills/coding-tutor/scripts/create_tutorial.py "Topic Name" --concepts "Concept1,Concept2" ``` -------------------------------- ### Navigate to Tutorials Repository Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/coding-tutor/commands/sync-tutorials.md Change the current directory to the local repository for coding tutor tutorials. ```bash cd ~/coding-tutor-tutorials ``` -------------------------------- ### Start dev server with Overmind Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-polish-beta/references/dev-server-procfile.md Use this command to start the development server when `overmind` is installed. It reads process definitions from `Procfile.dev`. ```bash overmind start -f Procfile.dev ``` -------------------------------- ### Install and Test Plugin Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/AGENTS.md Install dependencies, run the full test suite, and validate plugin/marketplace consistency using Bun. ```bash bun install bun test # full test suite bun run release:validate # check plugin/marketplace consistency ``` -------------------------------- ### Commit Workflow Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-work/SKILL.md Demonstrates the recommended command-line steps for staging and committing code changes related to a logical unit. ```bash # 1. Verify tests pass (use project's test command) # Examples: bin/rails test, npm test, pytest, go test, etc. # 2. Stage only files related to this logical unit (not `git add .`) git add # 3. Commit with conventional message git commit -m "feat(scope): description of this unit" ``` -------------------------------- ### Start dev server with Foreman fallback Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-polish-beta/references/dev-server-procfile.md Use this command as a fallback if `overmind` is not installed. It also reads process definitions from `Procfile.dev`. ```bash foreman start -f Procfile.dev ``` -------------------------------- ### Example Appended Content - Before Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-doc-review/references/open-questions-defer.md Illustrates the starting state of a document before new findings are appended, showing the 'Deferred / Open Questions' section. ```markdown ## Risks ...existing content... ## Deferred / Open Questions ### From 2026-04-10 review - **Alias compatibility-theater concern** — Risks (P1, scope-guardian, confidence 75) The alias exists without documented external consumers... ``` -------------------------------- ### Get iCloud Documents URL in Swift Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-agent-native-architecture/references/shared-workspace-architecture.md Retrieves the URL for the iCloud Documents directory. This is the starting point for using iCloud for shared workspace synchronization. ```swift func iCloudDocumentsURL() -> URL? { FileManager.default.url(forUbiquityContainerIdentifier: nil)? .appendingPathComponent("Documents") } ``` -------------------------------- ### Dependency Installation Offer Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-setup/SKILL.md This prompt lists missing tools and skills, with all items pre-selected for installation. It groups items under 'Tools:' and 'Skills:' for clarity. ```text The following items are missing. Select which to install: (All items are pre-selected) Tools: [x] agent-browser - Browser automation for testing and screenshots [x] gh - GitHub CLI for issues and PRs [x] jq - JSON processor [x] vhs (charmbracelet/vhs) - Create GIFs from CLI output [x] silicon (Aloxaf/silicon) - Generate code screenshots [x] ffmpeg - Video processing for feature demos [x] ast-grep - Structural code search using AST patterns Skills: [x] ast-grep - Agent skill for structural code search with ast-grep ``` -------------------------------- ### System Prompt Guidance for User Content Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-agent-native-architecture/references/files-universal-interface.md Provides an example of system prompt instructions for an agent, guiding it on how to interact with user-editable content and handle potential modifications. ```markdown ## Working with User Content When you create content, the user may edit it afterward. Always read existing files before modifying them—the user may have made improvements you should preserve. If a file has been modified since you last wrote it, ask before overwriting. ``` -------------------------------- ### Duplicate Skill Discovery Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/solutions/integrations/native-plugin-install-strategy-2026-04-19.md Installing skills with the same name in both `~/.agents/skills` and `~/.codex/skills` can lead to duplicate entries in the Codex picker. Cleanup should address stale skills in both locations. ```text ~/.agents/skills/ce-duplicate-discovery-smoke/SKILL.md ``` ```text ~/.codex/skills/ce-duplicate-discovery-smoke/SKILL.md ``` -------------------------------- ### Install Coding Tutor Plugin Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/coding-tutor/README.md Use this command to install the Coding Tutor plugin. Ensure you are in the correct project directory. ```bash /plugin install coding-tutor@claude-code-essentials ``` -------------------------------- ### Start Agent with Configuration Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-agent-native-architecture/references/architecture-patterns.md Initiates an agent using the shared orchestrator. Configuration, tools, and context are specific to the agent type. ```swift let session = try await AgentOrchestrator.shared.startAgent( config: ResearchAgent.create(book: book), // Config varies tools: ResearchAgent.tools, // Tools vary context: ResearchAgent.context(for: book) // Context varies ) ``` -------------------------------- ### Open Browser in Headed Mode Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/agents/ce-design-iterator.agent.md Use this command to open the browser in headed mode for visual inspection and resizing before starting design iterations. Ensure you have the agent-browser tool installed. ```bash agent-browser --headed open [url] ``` -------------------------------- ### YAML Array Item - Unquoted (Breaks Strict YAML) Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-compound/references/yaml-schema.md This example demonstrates an unquoted YAML array item that starts with a reserved indicator character, which will cause parsing errors in strict YAML 1.2 parsers. ```yaml symptoms: - `sudo dscacheutil -flushcache` does not restore in-container mDNS ``` -------------------------------- ### Example Agent Configuration Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/specs/kiro.md Defines a custom agent with its name, description, prompt file, available tools, resources, and welcome message. Ensure the prompt file and skill URIs are correctly formatted. ```json { "name": "security-reviewer", "description": "Reviews code for security vulnerabilities", "prompt": "file://./prompts/security-reviewer.md", "tools": ["*"], "resources": [ "file://.kiro/steering/**/*.md", "skill://.kiro/skills/**/SKILL.md" ], "includeMcpJson": true, "welcomeMessage": "Switching to security-reviewer. Reviews code for security vulnerabilities" } ``` -------------------------------- ### Generate .tape File for VHS Recording Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-demo-reel/references/tier-terminal-recording.md Example of a VHS tape file used to record a terminal session. It includes setup for secrets and the visible demo commands. Use this to define the recording's content, timing, and appearance. ```tape Output [RUN_DIR]/demo.gif Set FontSize 16 Set Width 800 Set Height 500 Set Theme "Catppuccin Mocha" Set TypingSpeed 40ms # Hidden prelude: clean HOME, set real secrets, any setup that would leak. # These commands execute for real but never appear in the GIF. # `clear` at the end flushes the buffer so Show starts on a clean screen. Hide Type "export HOME=$(mktemp -d)" Enter Type "export API_KEY='real-secret-value'" Enter Type "cd /path/to/project" Enter Type "clear" Enter Show # Visible demo: commands consume the env set above, but never re-export, # echo, or print it. Show the feature working -- not the auth mechanism. Type "your-cli-command --flag value" Enter Sleep 3s # Let viewer read the output Sleep 2s ``` -------------------------------- ### Changelog Entry Examples Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/plans/2026-03-17-001-feat-release-automation-migration-beta-plan.md Examples demonstrating the changelog entry format for different components, including versioning and release dates. ```markdown ## coding-tutor v1.2.2 - 2026-04-18 ### Fixes - ... ``` ```markdown ## marketplace v1.3.0 - 2026-04-18 ### Changed - Added `new-plugin` to the marketplace catalog. ``` ```markdown ## cli v2.43.1 - 2026-04-21 ### Fixes - Correct OpenClaw install path handling. ``` -------------------------------- ### YAML Array Item - Double Quoted (Parses Cleanly) Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-compound/references/yaml-schema.md This example shows the corrected YAML array item, where the value starting with a reserved indicator character is properly enclosed in double quotes, ensuring clean parsing with strict YAML 1.2 parsers. ```yaml symptoms: - "`sudo dscacheutil -flushcache` does not restore in-container mDNS" ``` -------------------------------- ### Create New Private GitHub Repository Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/coding-tutor/commands/sync-tutorials.md Create a new private GitHub repository for the coding tutor tutorials, initializing it from the current directory and pushing the initial commit. ```bash gh repo create coding-tutor-tutorials --private --source=. --push ``` -------------------------------- ### Check agent-browser Installation Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/plugins/compound-engineering/skills/ce-test-browser/SKILL.md Verify if the `agent-browser` CLI is installed on the system. If not, prompt the user to install it. ```bash command -v agent-browser >/dev/null 2>&1 && echo "Installed" || echo "NOT INSTALLED" ``` -------------------------------- ### Convert to Copilot Target Example Source: https://github.com/everyinc/compound-engineering-plugin/blob/main/docs/plans/2026-02-14-feat-add-copilot-converter-target-plan.md Example command to convert a local plugin directory to the Copilot target format. ```bash compound convert --to copilot ./plugins/compound-engineering ```