oh-my-codex-cli 0.1.0

package/.agent/skills/skill-development/references/skill-creator-original.md

@@ -0,0 +1,209 @@
+---
+name: skill-creator
+description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
+license: Complete terms in LICENSE.txt
+---
+
+# Skill Creator
+
+This skill provides guidance for creating effective skills.
+
+## About Skills
+
+Skills are modular, self-contained packages that extend Claude's capabilities by providing
+specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
+domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
+equipped with procedural knowledge that no model can fully possess.
+
+### What Skills Provide
+
+1. Specialized workflows - Multi-step procedures for specific domains
+2. Tool integrations - Instructions for working with specific file formats or APIs
+3. Domain expertise - Company-specific knowledge, schemas, business logic
+4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
+
+### Anatomy of a Skill
+
+Every skill consists of a required SKILL.md file and optional bundled resources:
+
+```
+skill-name/
+├── SKILL.md (required)
+│   ├── YAML frontmatter metadata (required)
+│   │   ├── name: (required)
+│   │   └── description: (required)
+│   └── Markdown instructions (required)
+└── Bundled Resources (optional)
+    ├── scripts/          - Executable code (Python/Bash/etc.)
+    ├── references/       - Documentation intended to be loaded into context as needed
+    └── assets/           - Files used in output (templates, icons, fonts, etc.)
+```
+
+#### SKILL.md (required)
+
+**Metadata Quality:** The `name` and `description` in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
+
+#### Bundled Resources (optional)
+
+##### Scripts (`scripts/`)
+
+Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
+
+- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
+- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
+- **Benefits**: Token efficient, deterministic, may be executed without loading into context
+- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
+
+##### References (`references/`)
+
+Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
+
+- **When to include**: For documentation that Claude should reference while working
+- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
+- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
+- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
+- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
+- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
+
+##### Assets (`assets/`)
+
+Files not intended to be loaded into context, but rather used within the output Claude produces.
+
+- **When to include**: When the skill needs files that will be used in the final output
+- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
+- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
+- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
+
+### Progressive Disclosure Design Principle
+
+Skills use a three-level loading system to manage context efficiently:
+
+1. **Metadata (name + description)** - Always in context (~100 words)
+2. **SKILL.md body** - When skill triggers (<5k words)
+3. **Bundled resources** - As needed by Claude (Unlimited*)
+
+*Unlimited because scripts can be executed without reading into context window.
+
+## Skill Creation Process
+
+To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
+
+### Step 1: Understanding the Skill with Concrete Examples
+
+Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
+
+To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
+
+For example, when building an image-editor skill, relevant questions include:
+
+- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
+- "Can you give some examples of how this skill would be used?"
+- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
+- "What would a user say that should trigger this skill?"
+
+To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
+
+Conclude this step when there is a clear sense of the functionality the skill should support.
+
+### Step 2: Planning the Reusable Skill Contents
+
+To turn concrete examples into an effective skill, analyze each example by:
+
+1. Considering how to execute on the example from scratch
+2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
+
+Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
+
+1. Rotating a PDF requires re-writing the same code each time
+2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
+
+Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
+
+1. Writing a frontend webapp requires the same boilerplate HTML/React each time
+2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
+
+Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
+
+1. Querying BigQuery requires re-discovering the table schemas and relationships each time
+2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
+
+To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
+
+### Step 3: Initializing the Skill
+
+At this point, it is time to actually create the skill.
+
+Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
+
+When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
+
+Usage:
+
+```bash
+scripts/init_skill.py <skill-name> --path <output-directory>
+```
+
+The script:
+
+- Creates the skill directory at the specified path
+- Generates a SKILL.md template with proper frontmatter and TODO placeholders
+- Creates example resource directories: `scripts/`, `references/`, and `assets/`
+- Adds example files in each directory that can be customized or deleted
+
+After initialization, customize or remove the generated SKILL.md and example files as needed.
+
+### Step 4: Edit the Skill
+
+When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
+
+#### Start with Reusable Skill Contents
+
+To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
+
+Also, delete any example files and directories not needed for the skill. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
+
+#### Update SKILL.md
+
+**Writing Style:** Write the entire skill using **imperative/infinitive form** (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
+
+To complete SKILL.md, answer the following questions:
+
+1. What is the purpose of the skill, in a few sentences?
+2. When should the skill be used?
+3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
+
+### Step 5: Packaging a Skill
+
+Once the skill is ready, it should be packaged into a distributable zip file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
+
+```bash
+scripts/package_skill.py <path/to/skill-folder>
+```
+
+Optional output directory specification:
+
+```bash
+scripts/package_skill.py <path/to/skill-folder> ./dist
+```
+
+The packaging script will:
+
+1. **Validate** the skill automatically, checking:
+   - YAML frontmatter format and required fields
+   - Skill naming conventions and directory structure
+   - Description completeness and quality
+   - File organization and resource references
+
+2. **Package** the skill if validation passes, creating a zip file named after the skill (e.g., `my-skill.zip`) that includes all files and maintains the proper directory structure for distribution.
+
+If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
+
+### Step 6: Iterate
+
+After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
+
+**Iteration workflow:**
+1. Use the skill on real tasks
+2. Notice struggles or inefficiencies
+3. Identify how SKILL.md or bundled resources should be updated
+4. Implement changes and test again

package/.agent/skills/skill-doc-generator/README.md

@@ -0,0 +1,37 @@
+# Skill Documentation Generator
+
+Auto-generates professional documentation for Codex skills.
+
+## Quick Install
+
+```bash
+cp -r skill-doc-generator ~/.codex/skills/
+```
+
+## Usage
+
+```
+"Generate documentation for my financial-analyzer skill"
+"Create README and HOW_TO_USE for code-review"
+"Auto-generate docs for all my skills"
+```
+
+## What It Generates
+
+- ✅ README.md - Quick start guide
+- ✅ HOW_TO_USE.md - Comprehensive usage guide
+- ✅ sample_input.json - Example input data
+- ✅ expected_output.json - Example output
+- ✅ CHANGELOG.md (optional) - Version history
+
+## Files
+
+- `SKILL.md` - Documentation generation methodology
+- `README.md` - This file
+
+## Best Use Cases
+
+- New skills that need documentation
+- Updating docs when SKILL.md changes
+- Ensuring consistent documentation style
+- Preparing skills for distribution

package/.agent/skills/skill-doc-generator/SKILL.md

@@ -0,0 +1,331 @@
+---
+name: skill-doc-generator
+description: Automatically generates comprehensive documentation for Codex skills including README, HOW_TO_USE, and usage examples from SKILL.md
+---
+
+# Skill Documentation Generator
+
+Automated documentation generation for Codex skills. Creates professional README.md, HOW_TO_USE.md, and example files from your SKILL.md definition.
+
+## Capabilities
+
+- **README Generation**: Creates installation-focused README.md with quick start
+- **Usage Guide Creation**: Generates detailed HOW_TO_USE.md with examples
+- **Example Extraction**: Pulls usage examples from SKILL.md into standalone files
+- **Sample Data Generation**: Creates sample_input/output JSON from skill description
+- **Documentation Templates**: Uses Codex best practices for structure
+- **Multi-Format Support**: Markdown, JSON, YAML outputs
+- **Auto-Update**: Regenerates docs when SKILL.md changes
+- **Quality Validation**: Ensures generated docs meet standards
+
+## Input Requirements
+
+**Minimal**:
+- SKILL.md file with valid YAML frontmatter
+- Basic capabilities and usage sections
+
+**Optimal**:
+- Complete SKILL.md with all recommended sections
+- Existing usage examples in "How to Use" section
+- Python files (if applicable) for code documentation
+
+## Output Files
+
+### 1. README.md
+**Purpose**: Quick start and installation guide
+
+**Content**:
+- Brief skill description
+- Quick install command
+- Usage teaser (2-3 examples)
+- File listing
+- Related skills links
+
+**Length**: ~20-30 lines (scannable)
+
+### 2. HOW_TO_USE.md
+**Purpose**: Comprehensive usage guide
+
+**Content**:
+- Detailed usage examples (organized by use case)
+- Input/output format explanations
+- Advanced usage patterns
+- Troubleshooting guide
+- Integration examples
+- Real-world scenarios
+
+**Length**: ~100-200 lines (thorough)
+
+### 3. sample_input.json
+**Purpose**: Example input data
+
+**Content**:
+- Realistic input example
+- All required fields
+- Optional fields shown
+- Comments explaining structure
+
+### 4. expected_output.json
+**Purpose**: Expected output example
+
+**Content**:
+- Corresponding output for sample input
+- Complete structure shown
+- Annotations for clarity
+
+### 5. CHANGELOG.md (Optional)
+**Purpose**: Version history
+
+**Content**:
+- Version numbers
+- Change descriptions
+- Breaking changes highlighted
+- Migration guides
+
+## How to Use
+
+**Quick Generation**:
+```
+"Generate documentation for my financial-analyzer skill"
+"Create README and HOW_TO_USE for code-review"
+"Auto-generate docs for all my skills"
+```
+
+**Selective Generation**:
+```
+"Just create README.md for aws-solution-architect"
+"Generate HOW_TO_USE only for prompt-factory"
+"Create sample input/output files for skill-tester"
+```
+
+**Update Existing Docs**:
+```
+"Update documentation for financial-analyzer (SKILL.md changed)"
+"Regenerate all docs for code-review"
+```
+
+**Custom Templates**:
+```
+"Generate README using minimal template"
+"Create comprehensive HOW_TO_USE with troubleshooting"
+```
+
+## Documentation Templates
+
+### Template 1: Minimal (Simple Skills)
+**README**: 15-20 lines, quick install + 2 examples
+**HOW_TO_USE**: 50-75 lines, basic usage patterns
+**Use for**: Utility skills, simple tools
+
+### Template 2: Standard (Most Skills)
+**README**: 25-35 lines, install + features + 3-4 examples
+**HOW_TO_USE**: 100-150 lines, organized sections, real-world examples
+**Use for**: Production skills, general purpose
+
+### Template 3: Comprehensive (Complex Skills)
+**README**: 40-50 lines, detailed overview, file structure
+**HOW_TO_USE**: 200+ lines, advanced patterns, integration guide, troubleshooting
+**Use for**: Complex skills, API integrations, multi-feature
+
+## Generation Process
+
+### Step 1: Analyze SKILL.md
+```
+- Extract YAML frontmatter (name, description)
+- Identify sections (Capabilities, Input/Output, How to Use)
+- Parse usage examples
+- Detect Python files (if present)
+```
+
+### Step 2: Select Template
+```
+- Count capabilities (< 3 = minimal, 3-6 = standard, > 6 = comprehensive)
+- Check skill complexity (simple = minimal, medium = standard, complex = comprehensive)
+- Consider Python files (present = more detailed docs)
+```
+
+### Step 3: Generate Content
+```
+- README: Skill overview + quick start
+- HOW_TO_USE: Detailed guide + examples
+- sample_input: Realistic example data
+- expected_output: Corresponding output
+```
+
+### Step 4: Validate
+```
+- Check all required sections present
+- Verify examples are clear
+- Ensure links work
+- Validate JSON/YAML syntax
+```
+
+### Step 5: Write Files
+```
+- Create README.md
+- Create HOW_TO_USE.md
+- Create sample_input.json
+- Create expected_output.json
+- (Optional) Create CHANGELOG.md
+```
+
+## Documentation Best Practices
+
+### README.md Principles
+1. **Scannable**: User should understand in 10 seconds
+2. **Actionable**: Clear install command
+3. **Enticing**: Best 2-3 examples shown
+4. **Linked**: References to detailed docs
+
+### HOW_TO_USE.md Principles
+1. **Progressive**: Simple examples first, complex later
+2. **Organized**: Group by use case or scenario
+3. **Real-world**: Actual usage patterns, not theory
+4. **Complete**: Cover all major capabilities
+5. **Helpful**: Include troubleshooting and tips
+
+### Sample Data Principles
+1. **Realistic**: Use actual use case data
+2. **Complete**: Show all required fields
+3. **Annotated**: Comments explain structure
+4. **Valid**: JSON/YAML syntax correct
+
+## Example Generation Session
+
+```
+User: "Generate docs for financial-analyzer"
+
+Codex: "Analyzing financial-analyzer skill...
+
+Found:
+- 5 capabilities
+- 3 input types
+- 4 output formats
+- 6 usage examples
+- 2 Python files
+
+Selecting: Standard template (good fit for medium complexity)
+
+Generating:
+✅ README.md (28 lines) - Quick start guide
+✅ HOW_TO_USE.md (145 lines) - Comprehensive usage guide
+   - 6 usage examples organized by scenario
+   - Input/output format details
+   - Integration with other skills
+   - Troubleshooting section
+✅ sample_input.json - P/E ratio calculation example
+✅ expected_output.json - Corresponding output with metrics
+
+All files created in ~/.codex/skills/financial-analyzer/
+
+Would you like me to review the generated docs?"
+```
+
+## Customization Options
+
+### Content Options
+- **Include examples**: true/false (extract from SKILL.md)
+- **Include sample data**: true/false (generate JSON examples)
+- **Include changelog**: true/false (version history)
+- **Include troubleshooting**: true/false (common issues section)
+
+### Style Options
+- **Template**: minimal/standard/comprehensive
+- **Tone**: technical/friendly/professional
+- **Length**: concise/detailed/exhaustive
+- **Format**: markdown/text/html
+
+### Advanced Options
+- **Extract from code**: Parse Python docstrings for additional content
+- **Generate diagrams**: Create workflow/architecture diagrams (ASCII art)
+- **API docs**: Generate API reference from code
+- **Multilingual**: Create docs in multiple languages
+
+## Integration with Development Workflow
+
+### Initial Skill Creation
+```
+1. Write SKILL.md with capabilities
+2. Run skill-doc-generator
+3. Review generated docs
+4. Adjust SKILL.md if needed
+5. Regenerate docs
+```
+
+### Ongoing Maintenance
+```
+1. Update SKILL.md with new features
+2. Run skill-doc-generator (auto-update)
+3. Generated docs stay in sync
+```
+
+### Pre-Distribution
+```
+1. Complete SKILL.md
+2. Generate all docs
+3. Review for quality (use skill-quality-analyzer)
+4. Package skill with full documentation
+```
+
+## Quality Checks
+
+Generated docs are validated for:
+- [ ] README exists and is scannable (< 50 lines)
+- [ ] HOW_TO_USE exists and is comprehensive
+- [ ] All code blocks have proper syntax
+- [ ] Examples are clear and realistic
+- [ ] Links are valid (no broken references)
+- [ ] JSON/YAML files are valid
+- [ ] File structure matches Codex guidelines
+- [ ] No spelling/grammar errors
+
+## Common Documentation Issues (Auto-Fixed)
+
+### Issue 1: Vague Examples
+**Before**: "Use this skill to analyze data"
+**After**: "Calculate P/E ratio: 'Analyze stock with price $100 and EPS $6.45'"
+
+### Issue 2: Missing Installation
+**Before**: No install instructions
+**After**: "cp -r financial-analyzer ~/.codex/skills/"
+
+### Issue 3: No Input/Output Clarification
+**Before**: "Takes data and returns results"
+**After**: Shows JSON structure with field explanations
+
+### Issue 4: No Troubleshooting
+**Before**: Examples only
+**After**: "If skill doesn't trigger, check description keywords"
+
+## Limitations
+
+- **Quality Depends on SKILL.md**: Generated docs only as good as source
+- **No Code Analysis**: Doesn't parse complex Python logic (basic docstrings only)
+- **Template-Based**: Uses predefined structures (not fully custom)
+- **English-Only**: Currently supports English documentation only
+- **No Diagrams**: Can't generate complex visual diagrams (ASCII only)
+
+## When NOT to Use This Skill
+
+- **Custom Documentation Needed**: Highly specialized format
+- **Code Documentation**: Use language-specific tools (Sphinx, JSDoc)
+- **API References**: Use dedicated API doc generators
+- **Quick Notes**: Manual README is faster for simple skills
+
+## Success Criteria
+
+Well-generated documentation should:
+- ✅ README scannable in < 10 seconds
+- ✅ HOW_TO_USE answers "how do I use this?" completely
+- ✅ Examples are copy-paste ready
+- ✅ Sample data is realistic
+- ✅ No user questions left unanswered
+- ✅ Passes quality validation
+- ✅ Follows Codex best practices
+
+## Related Skills
+
+- Use **skill-quality-analyzer** after generation to validate docs
+- Use **skill-debugger** if generated examples don't trigger correctly
+- Use **skill-tester** to verify examples work as documented
+- Complements **Skill Factory** for initial skill creation