chore: unify codex skills under agents
This commit is contained in:
@@ -0,0 +1 @@
|
|||||||
|
d9c5b31d2059f436
|
||||||
368
dotfiles/agents/skills/.system/skill-creator/SKILL.md
Normal file
368
dotfiles/agents/skills/.system/skill-creator/SKILL.md
Normal file
@@ -0,0 +1,368 @@
|
|||||||
|
---
|
||||||
|
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 Codex's capabilities with specialized knowledge, workflows, or tool integrations.
|
||||||
|
metadata:
|
||||||
|
short-description: Create or update a skill
|
||||||
|
---
|
||||||
|
|
||||||
|
# Skill Creator
|
||||||
|
|
||||||
|
This skill provides guidance for creating effective skills.
|
||||||
|
|
||||||
|
## About Skills
|
||||||
|
|
||||||
|
Skills are modular, self-contained folders that extend Codex's capabilities by providing
|
||||||
|
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
||||||
|
domains or tasks—they transform Codex 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
|
||||||
|
|
||||||
|
## Core Principles
|
||||||
|
|
||||||
|
### Concise is Key
|
||||||
|
|
||||||
|
The context window is a public good. Skills share the context window with everything else Codex needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
|
||||||
|
|
||||||
|
**Default assumption: Codex is already very smart.** Only add context Codex doesn't already have. Challenge each piece of information: "Does Codex really need this explanation?" and "Does this paragraph justify its token cost?"
|
||||||
|
|
||||||
|
Prefer concise examples over verbose explanations.
|
||||||
|
|
||||||
|
### Set Appropriate Degrees of Freedom
|
||||||
|
|
||||||
|
Match the level of specificity to the task's fragility and variability:
|
||||||
|
|
||||||
|
**High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
|
||||||
|
|
||||||
|
**Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
|
||||||
|
|
||||||
|
**Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
|
||||||
|
|
||||||
|
Think of Codex as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
|
||||||
|
|
||||||
|
### 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)
|
||||||
|
├── agents/ (recommended)
|
||||||
|
│ └── openai.yaml - UI metadata for skill lists and chips
|
||||||
|
└── 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)
|
||||||
|
|
||||||
|
Every SKILL.md consists of:
|
||||||
|
|
||||||
|
- **Frontmatter** (YAML): Contains `name` and `description` fields. These are the only fields that Codex reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
|
||||||
|
- **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
|
||||||
|
|
||||||
|
#### Agents metadata (recommended)
|
||||||
|
|
||||||
|
- UI-facing metadata for skill lists and chips
|
||||||
|
- Read references/openai_yaml.md before generating values and follow its descriptions and constraints
|
||||||
|
- Create: human-facing `display_name`, `short_description`, and `default_prompt` by reading the skill
|
||||||
|
- Generate deterministically by passing the values as `--interface key=value` to `scripts/generate_openai_yaml.py` or `scripts/init_skill.py`
|
||||||
|
- On updates: validate `agents/openai.yaml` still matches SKILL.md; regenerate if stale
|
||||||
|
- Only include other optional interface fields (icons, brand color) if explicitly provided
|
||||||
|
- See references/openai_yaml.md for field definitions and examples
|
||||||
|
|
||||||
|
#### 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 Codex for patching or environment-specific adjustments
|
||||||
|
|
||||||
|
##### References (`references/`)
|
||||||
|
|
||||||
|
Documentation and reference material intended to be loaded as needed into context to inform Codex's process and thinking.
|
||||||
|
|
||||||
|
- **When to include**: For documentation that Codex 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 Codex 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 Codex 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 Codex to use files without loading them into context
|
||||||
|
|
||||||
|
#### What to Not Include in a Skill
|
||||||
|
|
||||||
|
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
|
||||||
|
|
||||||
|
- README.md
|
||||||
|
- INSTALLATION_GUIDE.md
|
||||||
|
- QUICK_REFERENCE.md
|
||||||
|
- CHANGELOG.md
|
||||||
|
- etc.
|
||||||
|
|
||||||
|
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxiliary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
|
||||||
|
|
||||||
|
### 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 Codex (Unlimited because scripts can be executed without reading into context window)
|
||||||
|
|
||||||
|
#### Progressive Disclosure Patterns
|
||||||
|
|
||||||
|
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
|
||||||
|
|
||||||
|
**Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
|
||||||
|
|
||||||
|
**Pattern 1: High-level guide with references**
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# PDF Processing
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
Extract text with pdfplumber:
|
||||||
|
[code example]
|
||||||
|
|
||||||
|
## Advanced features
|
||||||
|
|
||||||
|
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
|
||||||
|
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
|
||||||
|
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
|
||||||
|
```
|
||||||
|
|
||||||
|
Codex loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
|
||||||
|
|
||||||
|
**Pattern 2: Domain-specific organization**
|
||||||
|
|
||||||
|
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
|
||||||
|
|
||||||
|
```
|
||||||
|
bigquery-skill/
|
||||||
|
├── SKILL.md (overview and navigation)
|
||||||
|
└── reference/
|
||||||
|
├── finance.md (revenue, billing metrics)
|
||||||
|
├── sales.md (opportunities, pipeline)
|
||||||
|
├── product.md (API usage, features)
|
||||||
|
└── marketing.md (campaigns, attribution)
|
||||||
|
```
|
||||||
|
|
||||||
|
When a user asks about sales metrics, Codex only reads sales.md.
|
||||||
|
|
||||||
|
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
|
||||||
|
|
||||||
|
```
|
||||||
|
cloud-deploy/
|
||||||
|
├── SKILL.md (workflow + provider selection)
|
||||||
|
└── references/
|
||||||
|
├── aws.md (AWS deployment patterns)
|
||||||
|
├── gcp.md (GCP deployment patterns)
|
||||||
|
└── azure.md (Azure deployment patterns)
|
||||||
|
```
|
||||||
|
|
||||||
|
When the user chooses AWS, Codex only reads aws.md.
|
||||||
|
|
||||||
|
**Pattern 3: Conditional details**
|
||||||
|
|
||||||
|
Show basic content, link to advanced content:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# DOCX Processing
|
||||||
|
|
||||||
|
## Creating documents
|
||||||
|
|
||||||
|
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
|
||||||
|
|
||||||
|
## Editing documents
|
||||||
|
|
||||||
|
For simple edits, modify the XML directly.
|
||||||
|
|
||||||
|
**For tracked changes**: See [REDLINING.md](REDLINING.md)
|
||||||
|
**For OOXML details**: See [OOXML.md](OOXML.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
Codex reads REDLINING.md or OOXML.md only when the user needs those features.
|
||||||
|
|
||||||
|
**Important guidelines:**
|
||||||
|
|
||||||
|
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
|
||||||
|
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Codex can see the full scope when previewing.
|
||||||
|
|
||||||
|
## Skill Creation Process
|
||||||
|
|
||||||
|
Skill creation involves these steps:
|
||||||
|
|
||||||
|
1. Understand the skill with concrete examples
|
||||||
|
2. Plan reusable skill contents (scripts, references, assets)
|
||||||
|
3. Initialize the skill (run init_skill.py)
|
||||||
|
4. Edit the skill (implement resources and write SKILL.md)
|
||||||
|
5. Validate the skill (run quick_validate.py)
|
||||||
|
6. Iterate based on real usage
|
||||||
|
|
||||||
|
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
|
||||||
|
|
||||||
|
### Skill Naming
|
||||||
|
|
||||||
|
- Use lowercase letters, digits, and hyphens only; normalize user-provided titles to hyphen-case (e.g., "Plan Mode" -> `plan-mode`).
|
||||||
|
- When generating names, generate a name under 64 characters (letters, digits, hyphens).
|
||||||
|
- Prefer short, verb-led phrases that describe the action.
|
||||||
|
- Namespace by tool when it improves clarity or triggering (e.g., `gh-address-comments`, `linear-address-issue`).
|
||||||
|
- Name the skill folder exactly after the skill name.
|
||||||
|
|
||||||
|
### 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. 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> [--resources scripts,references,assets] [--examples]
|
||||||
|
```
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scripts/init_skill.py my-skill --path skills/public
|
||||||
|
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
|
||||||
|
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples
|
||||||
|
```
|
||||||
|
|
||||||
|
The script:
|
||||||
|
|
||||||
|
- Creates the skill directory at the specified path
|
||||||
|
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
||||||
|
- Creates `agents/openai.yaml` using agent-generated `display_name`, `short_description`, and `default_prompt` passed via `--interface key=value`
|
||||||
|
- Optionally creates resource directories based on `--resources`
|
||||||
|
- Optionally adds example files when `--examples` is set
|
||||||
|
|
||||||
|
After initialization, customize the SKILL.md and add resources as needed. If you used `--examples`, replace or delete placeholder files.
|
||||||
|
|
||||||
|
Generate `display_name`, `short_description`, and `default_prompt` by reading the skill, then pass them as `--interface key=value` to `init_skill.py` or regenerate with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scripts/generate_openai_yaml.py <path/to/skill-folder> --interface key=value
|
||||||
|
```
|
||||||
|
|
||||||
|
Only include other optional interface fields when the user explicitly provides them. For full field descriptions and examples, see references/openai_yaml.md.
|
||||||
|
|
||||||
|
### Step 4: Edit the Skill
|
||||||
|
|
||||||
|
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Codex to use. Include information that would be beneficial and non-obvious to Codex. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Codex 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/`.
|
||||||
|
|
||||||
|
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
|
||||||
|
|
||||||
|
If you used `--examples`, delete any placeholder files that are not needed for the skill. Only create resource directories that are actually required.
|
||||||
|
|
||||||
|
#### Update SKILL.md
|
||||||
|
|
||||||
|
**Writing Guidelines:** Always use imperative/infinitive form.
|
||||||
|
|
||||||
|
##### Frontmatter
|
||||||
|
|
||||||
|
Write the YAML frontmatter with `name` and `description`:
|
||||||
|
|
||||||
|
- `name`: The skill name
|
||||||
|
- `description`: This is the primary triggering mechanism for your skill, and helps Codex understand when to use the skill.
|
||||||
|
- Include both what the Skill does and specific triggers/contexts for when to use it.
|
||||||
|
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Codex.
|
||||||
|
- Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Codex needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
|
||||||
|
|
||||||
|
Do not include any other fields in YAML frontmatter.
|
||||||
|
|
||||||
|
##### Body
|
||||||
|
|
||||||
|
Write instructions for using the skill and its bundled resources.
|
||||||
|
|
||||||
|
### Step 5: Validate the Skill
|
||||||
|
|
||||||
|
Once development of the skill is complete, validate the skill folder to catch basic issues early:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scripts/quick_validate.py <path/to/skill-folder>
|
||||||
|
```
|
||||||
|
|
||||||
|
The validation script checks YAML frontmatter format, required fields, and naming rules. If validation fails, fix the reported issues and run the 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
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
interface:
|
||||||
|
display_name: "Skill Creator"
|
||||||
|
short_description: "Create or update a skill"
|
||||||
|
icon_small: "./assets/skill-creator-small.svg"
|
||||||
|
icon_large: "./assets/skill-creator.png"
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" viewBox="0 0 20 20">
|
||||||
|
<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"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.5 KiB |
202
dotfiles/agents/skills/.system/skill-creator/license.txt
Normal file
202
dotfiles/agents/skills/.system/skill-creator/license.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# openai.yaml fields (full example + descriptions)
|
||||||
|
|
||||||
|
`agents/openai.yaml` is an extended, product-specific config intended for the machine/harness to read, not the agent. Other product-specific config can also live in the `agents/` folder.
|
||||||
|
|
||||||
|
## Full example
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
interface:
|
||||||
|
display_name: "Optional user-facing name"
|
||||||
|
short_description: "Optional user-facing description"
|
||||||
|
icon_small: "./assets/small-400px.png"
|
||||||
|
icon_large: "./assets/large-logo.svg"
|
||||||
|
brand_color: "#3B82F6"
|
||||||
|
default_prompt: "Optional surrounding prompt to use the skill with"
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
tools:
|
||||||
|
- type: "mcp"
|
||||||
|
value: "github"
|
||||||
|
description: "GitHub MCP server"
|
||||||
|
transport: "streamable_http"
|
||||||
|
url: "https://api.githubcopilot.com/mcp/"
|
||||||
|
|
||||||
|
policy:
|
||||||
|
allow_implicit_invocation: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Field descriptions and constraints
|
||||||
|
|
||||||
|
Top-level constraints:
|
||||||
|
|
||||||
|
- Quote all string values.
|
||||||
|
- Keep keys unquoted.
|
||||||
|
- For `interface.default_prompt`: generate a helpful, short (typically 1 sentence) example starting prompt based on the skill. It must explicitly mention the skill as `$skill-name` (e.g., "Use $skill-name-here to draft a concise weekly status update.").
|
||||||
|
|
||||||
|
- `interface.display_name`: Human-facing title shown in UI skill lists and chips.
|
||||||
|
- `interface.short_description`: Human-facing short UI blurb (25–64 chars) for quick scanning.
|
||||||
|
- `interface.icon_small`: Path to a small icon asset (relative to skill dir). Default to `./assets/` and place icons in the skill's `assets/` folder.
|
||||||
|
- `interface.icon_large`: Path to a larger logo asset (relative to skill dir). Default to `./assets/` and place icons in the skill's `assets/` folder.
|
||||||
|
- `interface.brand_color`: Hex color used for UI accents (e.g., badges).
|
||||||
|
- `interface.default_prompt`: Default prompt snippet inserted when invoking the skill.
|
||||||
|
- `dependencies.tools[].type`: Dependency category. Only `mcp` is supported for now.
|
||||||
|
- `dependencies.tools[].value`: Identifier of the tool or dependency.
|
||||||
|
- `dependencies.tools[].description`: Human-readable explanation of the dependency.
|
||||||
|
- `dependencies.tools[].transport`: Connection type when `type` is `mcp`.
|
||||||
|
- `dependencies.tools[].url`: MCP server URL when `type` is `mcp`.
|
||||||
|
- `policy.allow_implicit_invocation`: When false, the skill is not injected into
|
||||||
|
the model context by default, but can still be invoked explicitly via `$skill`.
|
||||||
|
Defaults to true.
|
||||||
@@ -0,0 +1,225 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
OpenAI YAML Generator - Creates agents/openai.yaml for a skill folder.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
generate_openai_yaml.py <skill_dir> [--name <skill_name>] [--interface key=value]
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
ACRONYMS = {
|
||||||
|
"GH",
|
||||||
|
"MCP",
|
||||||
|
"API",
|
||||||
|
"CI",
|
||||||
|
"CLI",
|
||||||
|
"LLM",
|
||||||
|
"PDF",
|
||||||
|
"PR",
|
||||||
|
"UI",
|
||||||
|
"URL",
|
||||||
|
"SQL",
|
||||||
|
}
|
||||||
|
|
||||||
|
BRANDS = {
|
||||||
|
"openai": "OpenAI",
|
||||||
|
"openapi": "OpenAPI",
|
||||||
|
"github": "GitHub",
|
||||||
|
"pagerduty": "PagerDuty",
|
||||||
|
"datadog": "DataDog",
|
||||||
|
"sqlite": "SQLite",
|
||||||
|
"fastapi": "FastAPI",
|
||||||
|
}
|
||||||
|
|
||||||
|
SMALL_WORDS = {"and", "or", "to", "up", "with"}
|
||||||
|
|
||||||
|
ALLOWED_INTERFACE_KEYS = {
|
||||||
|
"display_name",
|
||||||
|
"short_description",
|
||||||
|
"icon_small",
|
||||||
|
"icon_large",
|
||||||
|
"brand_color",
|
||||||
|
"default_prompt",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def yaml_quote(value):
|
||||||
|
escaped = value.replace("\\", "\\\\").replace('"', '\\"').replace("\n", "\\n")
|
||||||
|
return f'"{escaped}"'
|
||||||
|
|
||||||
|
|
||||||
|
def format_display_name(skill_name):
|
||||||
|
words = [word for word in skill_name.split("-") if word]
|
||||||
|
formatted = []
|
||||||
|
for index, word in enumerate(words):
|
||||||
|
lower = word.lower()
|
||||||
|
upper = word.upper()
|
||||||
|
if upper in ACRONYMS:
|
||||||
|
formatted.append(upper)
|
||||||
|
continue
|
||||||
|
if lower in BRANDS:
|
||||||
|
formatted.append(BRANDS[lower])
|
||||||
|
continue
|
||||||
|
if index > 0 and lower in SMALL_WORDS:
|
||||||
|
formatted.append(lower)
|
||||||
|
continue
|
||||||
|
formatted.append(word.capitalize())
|
||||||
|
return " ".join(formatted)
|
||||||
|
|
||||||
|
|
||||||
|
def generate_short_description(display_name):
|
||||||
|
description = f"Help with {display_name} tasks"
|
||||||
|
|
||||||
|
if len(description) < 25:
|
||||||
|
description = f"Help with {display_name} tasks and workflows"
|
||||||
|
if len(description) < 25:
|
||||||
|
description = f"Help with {display_name} tasks with guidance"
|
||||||
|
|
||||||
|
if len(description) > 64:
|
||||||
|
description = f"Help with {display_name}"
|
||||||
|
if len(description) > 64:
|
||||||
|
description = f"{display_name} helper"
|
||||||
|
if len(description) > 64:
|
||||||
|
description = f"{display_name} tools"
|
||||||
|
if len(description) > 64:
|
||||||
|
suffix = " helper"
|
||||||
|
max_name_length = 64 - len(suffix)
|
||||||
|
trimmed = display_name[:max_name_length].rstrip()
|
||||||
|
description = f"{trimmed}{suffix}"
|
||||||
|
if len(description) > 64:
|
||||||
|
description = description[:64].rstrip()
|
||||||
|
|
||||||
|
if len(description) < 25:
|
||||||
|
description = f"{description} workflows"
|
||||||
|
if len(description) > 64:
|
||||||
|
description = description[:64].rstrip()
|
||||||
|
|
||||||
|
return description
|
||||||
|
|
||||||
|
|
||||||
|
def read_frontmatter_name(skill_dir):
|
||||||
|
skill_md = Path(skill_dir) / "SKILL.md"
|
||||||
|
if not skill_md.exists():
|
||||||
|
print(f"[ERROR] SKILL.md not found in {skill_dir}")
|
||||||
|
return None
|
||||||
|
content = skill_md.read_text()
|
||||||
|
match = re.match(r"^---\n(.*?)\n---", content, re.DOTALL)
|
||||||
|
if not match:
|
||||||
|
print("[ERROR] Invalid SKILL.md frontmatter format.")
|
||||||
|
return None
|
||||||
|
frontmatter_text = match.group(1)
|
||||||
|
try:
|
||||||
|
frontmatter = yaml.safe_load(frontmatter_text)
|
||||||
|
except yaml.YAMLError as exc:
|
||||||
|
print(f"[ERROR] Invalid YAML frontmatter: {exc}")
|
||||||
|
return None
|
||||||
|
if not isinstance(frontmatter, dict):
|
||||||
|
print("[ERROR] Frontmatter must be a YAML dictionary.")
|
||||||
|
return None
|
||||||
|
name = frontmatter.get("name", "")
|
||||||
|
if not isinstance(name, str) or not name.strip():
|
||||||
|
print("[ERROR] Frontmatter 'name' is missing or invalid.")
|
||||||
|
return None
|
||||||
|
return name.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def parse_interface_overrides(raw_overrides):
|
||||||
|
overrides = {}
|
||||||
|
optional_order = []
|
||||||
|
for item in raw_overrides:
|
||||||
|
if "=" not in item:
|
||||||
|
print(f"[ERROR] Invalid interface override '{item}'. Use key=value.")
|
||||||
|
return None, None
|
||||||
|
key, value = item.split("=", 1)
|
||||||
|
key = key.strip()
|
||||||
|
value = value.strip()
|
||||||
|
if not key:
|
||||||
|
print(f"[ERROR] Invalid interface override '{item}'. Key is empty.")
|
||||||
|
return None, None
|
||||||
|
if key not in ALLOWED_INTERFACE_KEYS:
|
||||||
|
allowed = ", ".join(sorted(ALLOWED_INTERFACE_KEYS))
|
||||||
|
print(f"[ERROR] Unknown interface field '{key}'. Allowed: {allowed}")
|
||||||
|
return None, None
|
||||||
|
overrides[key] = value
|
||||||
|
if key not in ("display_name", "short_description") and key not in optional_order:
|
||||||
|
optional_order.append(key)
|
||||||
|
return overrides, optional_order
|
||||||
|
|
||||||
|
|
||||||
|
def write_openai_yaml(skill_dir, skill_name, raw_overrides):
|
||||||
|
overrides, optional_order = parse_interface_overrides(raw_overrides)
|
||||||
|
if overrides is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
display_name = overrides.get("display_name") or format_display_name(skill_name)
|
||||||
|
short_description = overrides.get("short_description") or generate_short_description(display_name)
|
||||||
|
|
||||||
|
if not (25 <= len(short_description) <= 64):
|
||||||
|
print(
|
||||||
|
"[ERROR] short_description must be 25-64 characters "
|
||||||
|
f"(got {len(short_description)})."
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
interface_lines = [
|
||||||
|
"interface:",
|
||||||
|
f" display_name: {yaml_quote(display_name)}",
|
||||||
|
f" short_description: {yaml_quote(short_description)}",
|
||||||
|
]
|
||||||
|
|
||||||
|
for key in optional_order:
|
||||||
|
value = overrides.get(key)
|
||||||
|
if value is not None:
|
||||||
|
interface_lines.append(f" {key}: {yaml_quote(value)}")
|
||||||
|
|
||||||
|
agents_dir = Path(skill_dir) / "agents"
|
||||||
|
agents_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
output_path = agents_dir / "openai.yaml"
|
||||||
|
output_path.write_text("\n".join(interface_lines) + "\n")
|
||||||
|
print(f"[OK] Created agents/openai.yaml")
|
||||||
|
return output_path
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
description="Create agents/openai.yaml for a skill directory.",
|
||||||
|
)
|
||||||
|
parser.add_argument("skill_dir", help="Path to the skill directory")
|
||||||
|
parser.add_argument(
|
||||||
|
"--name",
|
||||||
|
help="Skill name override (defaults to SKILL.md frontmatter)",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--interface",
|
||||||
|
action="append",
|
||||||
|
default=[],
|
||||||
|
help="Interface override in key=value format (repeatable)",
|
||||||
|
)
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
skill_dir = Path(args.skill_dir).resolve()
|
||||||
|
if not skill_dir.exists():
|
||||||
|
print(f"[ERROR] Skill directory not found: {skill_dir}")
|
||||||
|
sys.exit(1)
|
||||||
|
if not skill_dir.is_dir():
|
||||||
|
print(f"[ERROR] Path is not a directory: {skill_dir}")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
skill_name = args.name or read_frontmatter_name(skill_dir)
|
||||||
|
if not skill_name:
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
result = write_openai_yaml(skill_dir, skill_name, args.interface)
|
||||||
|
if result:
|
||||||
|
sys.exit(0)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,397 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Skill Initializer - Creates a new skill from template
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
init_skill.py <skill-name> --path <path> [--resources scripts,references,assets] [--examples] [--interface key=value]
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
init_skill.py my-new-skill --path skills/public
|
||||||
|
init_skill.py my-new-skill --path skills/public --resources scripts,references
|
||||||
|
init_skill.py my-api-helper --path skills/private --resources scripts --examples
|
||||||
|
init_skill.py custom-skill --path /custom/location
|
||||||
|
init_skill.py my-skill --path skills/public --interface short_description="Short UI label"
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from generate_openai_yaml import write_openai_yaml
|
||||||
|
|
||||||
|
MAX_SKILL_NAME_LENGTH = 64
|
||||||
|
ALLOWED_RESOURCES = {"scripts", "references", "assets"}
|
||||||
|
|
||||||
|
SKILL_TEMPLATE = """---
|
||||||
|
name: {skill_name}
|
||||||
|
description: [TODO: Complete and informative explanation of what the skill does and when to use it. Include WHEN to use this skill - specific scenarios, file types, or tasks that trigger it.]
|
||||||
|
---
|
||||||
|
|
||||||
|
# {skill_title}
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
[TODO: 1-2 sentences explaining what this skill enables]
|
||||||
|
|
||||||
|
## Structuring This Skill
|
||||||
|
|
||||||
|
[TODO: Choose the structure that best fits this skill's purpose. Common patterns:
|
||||||
|
|
||||||
|
**1. Workflow-Based** (best for sequential processes)
|
||||||
|
- Works well when there are clear step-by-step procedures
|
||||||
|
- Example: DOCX skill with "Workflow Decision Tree" -> "Reading" -> "Creating" -> "Editing"
|
||||||
|
- Structure: ## Overview -> ## Workflow Decision Tree -> ## Step 1 -> ## Step 2...
|
||||||
|
|
||||||
|
**2. Task-Based** (best for tool collections)
|
||||||
|
- Works well when the skill offers different operations/capabilities
|
||||||
|
- Example: PDF skill with "Quick Start" -> "Merge PDFs" -> "Split PDFs" -> "Extract Text"
|
||||||
|
- Structure: ## Overview -> ## Quick Start -> ## Task Category 1 -> ## Task Category 2...
|
||||||
|
|
||||||
|
**3. Reference/Guidelines** (best for standards or specifications)
|
||||||
|
- Works well for brand guidelines, coding standards, or requirements
|
||||||
|
- Example: Brand styling with "Brand Guidelines" -> "Colors" -> "Typography" -> "Features"
|
||||||
|
- Structure: ## Overview -> ## Guidelines -> ## Specifications -> ## Usage...
|
||||||
|
|
||||||
|
**4. Capabilities-Based** (best for integrated systems)
|
||||||
|
- Works well when the skill provides multiple interrelated features
|
||||||
|
- Example: Product Management with "Core Capabilities" -> numbered capability list
|
||||||
|
- Structure: ## Overview -> ## Core Capabilities -> ### 1. Feature -> ### 2. Feature...
|
||||||
|
|
||||||
|
Patterns can be mixed and matched as needed. Most skills combine patterns (e.g., start with task-based, add workflow for complex operations).
|
||||||
|
|
||||||
|
Delete this entire "Structuring This Skill" section when done - it's just guidance.]
|
||||||
|
|
||||||
|
## [TODO: Replace with the first main section based on chosen structure]
|
||||||
|
|
||||||
|
[TODO: Add content here. See examples in existing skills:
|
||||||
|
- Code samples for technical skills
|
||||||
|
- Decision trees for complex workflows
|
||||||
|
- Concrete examples with realistic user requests
|
||||||
|
- References to scripts/templates/references as needed]
|
||||||
|
|
||||||
|
## Resources (optional)
|
||||||
|
|
||||||
|
Create only the resource directories this skill actually needs. Delete this section if no resources are required.
|
||||||
|
|
||||||
|
### scripts/
|
||||||
|
Executable code (Python/Bash/etc.) that can be run directly to perform specific operations.
|
||||||
|
|
||||||
|
**Examples from other skills:**
|
||||||
|
- PDF skill: `fill_fillable_fields.py`, `extract_form_field_info.py` - utilities for PDF manipulation
|
||||||
|
- DOCX skill: `document.py`, `utilities.py` - Python modules for document processing
|
||||||
|
|
||||||
|
**Appropriate for:** Python scripts, shell scripts, or any executable code that performs automation, data processing, or specific operations.
|
||||||
|
|
||||||
|
**Note:** Scripts may be executed without loading into context, but can still be read by Codex for patching or environment adjustments.
|
||||||
|
|
||||||
|
### references/
|
||||||
|
Documentation and reference material intended to be loaded into context to inform Codex's process and thinking.
|
||||||
|
|
||||||
|
**Examples from other skills:**
|
||||||
|
- Product management: `communication.md`, `context_building.md` - detailed workflow guides
|
||||||
|
- BigQuery: API reference documentation and query examples
|
||||||
|
- Finance: Schema documentation, company policies
|
||||||
|
|
||||||
|
**Appropriate for:** In-depth documentation, API references, database schemas, comprehensive guides, or any detailed information that Codex should reference while working.
|
||||||
|
|
||||||
|
### assets/
|
||||||
|
Files not intended to be loaded into context, but rather used within the output Codex produces.
|
||||||
|
|
||||||
|
**Examples from other skills:**
|
||||||
|
- Brand styling: PowerPoint template files (.pptx), logo files
|
||||||
|
- Frontend builder: HTML/React boilerplate project directories
|
||||||
|
- Typography: Font files (.ttf, .woff2)
|
||||||
|
|
||||||
|
**Appropriate for:** Templates, boilerplate code, document templates, images, icons, fonts, or any files meant to be copied or used in the final output.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Not every skill requires all three types of resources.**
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLE_SCRIPT = '''#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Example helper script for {skill_name}
|
||||||
|
|
||||||
|
This is a placeholder script that can be executed directly.
|
||||||
|
Replace with actual implementation or delete if not needed.
|
||||||
|
|
||||||
|
Example real scripts from other skills:
|
||||||
|
- pdf/scripts/fill_fillable_fields.py - Fills PDF form fields
|
||||||
|
- pdf/scripts/convert_pdf_to_images.py - Converts PDF pages to images
|
||||||
|
"""
|
||||||
|
|
||||||
|
def main():
|
||||||
|
print("This is an example script for {skill_name}")
|
||||||
|
# TODO: Add actual script logic here
|
||||||
|
# This could be data processing, file conversion, API calls, etc.
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLE_REFERENCE = """# Reference Documentation for {skill_title}
|
||||||
|
|
||||||
|
This is a placeholder for detailed reference documentation.
|
||||||
|
Replace with actual reference content or delete if not needed.
|
||||||
|
|
||||||
|
Example real reference docs from other skills:
|
||||||
|
- product-management/references/communication.md - Comprehensive guide for status updates
|
||||||
|
- product-management/references/context_building.md - Deep-dive on gathering context
|
||||||
|
- bigquery/references/ - API references and query examples
|
||||||
|
|
||||||
|
## When Reference Docs Are Useful
|
||||||
|
|
||||||
|
Reference docs are ideal for:
|
||||||
|
- Comprehensive API documentation
|
||||||
|
- Detailed workflow guides
|
||||||
|
- Complex multi-step processes
|
||||||
|
- Information too lengthy for main SKILL.md
|
||||||
|
- Content that's only needed for specific use cases
|
||||||
|
|
||||||
|
## Structure Suggestions
|
||||||
|
|
||||||
|
### API Reference Example
|
||||||
|
- Overview
|
||||||
|
- Authentication
|
||||||
|
- Endpoints with examples
|
||||||
|
- Error codes
|
||||||
|
- Rate limits
|
||||||
|
|
||||||
|
### Workflow Guide Example
|
||||||
|
- Prerequisites
|
||||||
|
- Step-by-step instructions
|
||||||
|
- Common patterns
|
||||||
|
- Troubleshooting
|
||||||
|
- Best practices
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLE_ASSET = """# Example Asset File
|
||||||
|
|
||||||
|
This placeholder represents where asset files would be stored.
|
||||||
|
Replace with actual asset files (templates, images, fonts, etc.) or delete if not needed.
|
||||||
|
|
||||||
|
Asset files are NOT intended to be loaded into context, but rather used within
|
||||||
|
the output Codex produces.
|
||||||
|
|
||||||
|
Example asset files from other skills:
|
||||||
|
- Brand guidelines: logo.png, slides_template.pptx
|
||||||
|
- Frontend builder: hello-world/ directory with HTML/React boilerplate
|
||||||
|
- Typography: custom-font.ttf, font-family.woff2
|
||||||
|
- Data: sample_data.csv, test_dataset.json
|
||||||
|
|
||||||
|
## Common Asset Types
|
||||||
|
|
||||||
|
- Templates: .pptx, .docx, boilerplate directories
|
||||||
|
- Images: .png, .jpg, .svg, .gif
|
||||||
|
- Fonts: .ttf, .otf, .woff, .woff2
|
||||||
|
- Boilerplate code: Project directories, starter files
|
||||||
|
- Icons: .ico, .svg
|
||||||
|
- Data files: .csv, .json, .xml, .yaml
|
||||||
|
|
||||||
|
Note: This is a text placeholder. Actual assets can be any file type.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_skill_name(skill_name):
|
||||||
|
"""Normalize a skill name to lowercase hyphen-case."""
|
||||||
|
normalized = skill_name.strip().lower()
|
||||||
|
normalized = re.sub(r"[^a-z0-9]+", "-", normalized)
|
||||||
|
normalized = normalized.strip("-")
|
||||||
|
normalized = re.sub(r"-{2,}", "-", normalized)
|
||||||
|
return normalized
|
||||||
|
|
||||||
|
|
||||||
|
def title_case_skill_name(skill_name):
|
||||||
|
"""Convert hyphenated skill name to Title Case for display."""
|
||||||
|
return " ".join(word.capitalize() for word in skill_name.split("-"))
|
||||||
|
|
||||||
|
|
||||||
|
def parse_resources(raw_resources):
|
||||||
|
if not raw_resources:
|
||||||
|
return []
|
||||||
|
resources = [item.strip() for item in raw_resources.split(",") if item.strip()]
|
||||||
|
invalid = sorted({item for item in resources if item not in ALLOWED_RESOURCES})
|
||||||
|
if invalid:
|
||||||
|
allowed = ", ".join(sorted(ALLOWED_RESOURCES))
|
||||||
|
print(f"[ERROR] Unknown resource type(s): {', '.join(invalid)}")
|
||||||
|
print(f" Allowed: {allowed}")
|
||||||
|
sys.exit(1)
|
||||||
|
deduped = []
|
||||||
|
seen = set()
|
||||||
|
for resource in resources:
|
||||||
|
if resource not in seen:
|
||||||
|
deduped.append(resource)
|
||||||
|
seen.add(resource)
|
||||||
|
return deduped
|
||||||
|
|
||||||
|
|
||||||
|
def create_resource_dirs(skill_dir, skill_name, skill_title, resources, include_examples):
|
||||||
|
for resource in resources:
|
||||||
|
resource_dir = skill_dir / resource
|
||||||
|
resource_dir.mkdir(exist_ok=True)
|
||||||
|
if resource == "scripts":
|
||||||
|
if include_examples:
|
||||||
|
example_script = resource_dir / "example.py"
|
||||||
|
example_script.write_text(EXAMPLE_SCRIPT.format(skill_name=skill_name))
|
||||||
|
example_script.chmod(0o755)
|
||||||
|
print("[OK] Created scripts/example.py")
|
||||||
|
else:
|
||||||
|
print("[OK] Created scripts/")
|
||||||
|
elif resource == "references":
|
||||||
|
if include_examples:
|
||||||
|
example_reference = resource_dir / "api_reference.md"
|
||||||
|
example_reference.write_text(EXAMPLE_REFERENCE.format(skill_title=skill_title))
|
||||||
|
print("[OK] Created references/api_reference.md")
|
||||||
|
else:
|
||||||
|
print("[OK] Created references/")
|
||||||
|
elif resource == "assets":
|
||||||
|
if include_examples:
|
||||||
|
example_asset = resource_dir / "example_asset.txt"
|
||||||
|
example_asset.write_text(EXAMPLE_ASSET)
|
||||||
|
print("[OK] Created assets/example_asset.txt")
|
||||||
|
else:
|
||||||
|
print("[OK] Created assets/")
|
||||||
|
|
||||||
|
|
||||||
|
def init_skill(skill_name, path, resources, include_examples, interface_overrides):
|
||||||
|
"""
|
||||||
|
Initialize a new skill directory with template SKILL.md.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
skill_name: Name of the skill
|
||||||
|
path: Path where the skill directory should be created
|
||||||
|
resources: Resource directories to create
|
||||||
|
include_examples: Whether to create example files in resource directories
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Path to created skill directory, or None if error
|
||||||
|
"""
|
||||||
|
# Determine skill directory path
|
||||||
|
skill_dir = Path(path).resolve() / skill_name
|
||||||
|
|
||||||
|
# Check if directory already exists
|
||||||
|
if skill_dir.exists():
|
||||||
|
print(f"[ERROR] Skill directory already exists: {skill_dir}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Create skill directory
|
||||||
|
try:
|
||||||
|
skill_dir.mkdir(parents=True, exist_ok=False)
|
||||||
|
print(f"[OK] Created skill directory: {skill_dir}")
|
||||||
|
except Exception as e:
|
||||||
|
print(f"[ERROR] Error creating directory: {e}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Create SKILL.md from template
|
||||||
|
skill_title = title_case_skill_name(skill_name)
|
||||||
|
skill_content = SKILL_TEMPLATE.format(skill_name=skill_name, skill_title=skill_title)
|
||||||
|
|
||||||
|
skill_md_path = skill_dir / "SKILL.md"
|
||||||
|
try:
|
||||||
|
skill_md_path.write_text(skill_content)
|
||||||
|
print("[OK] Created SKILL.md")
|
||||||
|
except Exception as e:
|
||||||
|
print(f"[ERROR] Error creating SKILL.md: {e}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Create agents/openai.yaml
|
||||||
|
try:
|
||||||
|
result = write_openai_yaml(skill_dir, skill_name, interface_overrides)
|
||||||
|
if not result:
|
||||||
|
return None
|
||||||
|
except Exception as e:
|
||||||
|
print(f"[ERROR] Error creating agents/openai.yaml: {e}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Create resource directories if requested
|
||||||
|
if resources:
|
||||||
|
try:
|
||||||
|
create_resource_dirs(skill_dir, skill_name, skill_title, resources, include_examples)
|
||||||
|
except Exception as e:
|
||||||
|
print(f"[ERROR] Error creating resource directories: {e}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Print next steps
|
||||||
|
print(f"\n[OK] Skill '{skill_name}' initialized successfully at {skill_dir}")
|
||||||
|
print("\nNext steps:")
|
||||||
|
print("1. Edit SKILL.md to complete the TODO items and update the description")
|
||||||
|
if resources:
|
||||||
|
if include_examples:
|
||||||
|
print("2. Customize or delete the example files in scripts/, references/, and assets/")
|
||||||
|
else:
|
||||||
|
print("2. Add resources to scripts/, references/, and assets/ as needed")
|
||||||
|
else:
|
||||||
|
print("2. Create resource directories only if needed (scripts/, references/, assets/)")
|
||||||
|
print("3. Update agents/openai.yaml if the UI metadata should differ")
|
||||||
|
print("4. Run the validator when ready to check the skill structure")
|
||||||
|
|
||||||
|
return skill_dir
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
description="Create a new skill directory with a SKILL.md template.",
|
||||||
|
)
|
||||||
|
parser.add_argument("skill_name", help="Skill name (normalized to hyphen-case)")
|
||||||
|
parser.add_argument("--path", required=True, help="Output directory for the skill")
|
||||||
|
parser.add_argument(
|
||||||
|
"--resources",
|
||||||
|
default="",
|
||||||
|
help="Comma-separated list: scripts,references,assets",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--examples",
|
||||||
|
action="store_true",
|
||||||
|
help="Create example files inside the selected resource directories",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--interface",
|
||||||
|
action="append",
|
||||||
|
default=[],
|
||||||
|
help="Interface override in key=value format (repeatable)",
|
||||||
|
)
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
raw_skill_name = args.skill_name
|
||||||
|
skill_name = normalize_skill_name(raw_skill_name)
|
||||||
|
if not skill_name:
|
||||||
|
print("[ERROR] Skill name must include at least one letter or digit.")
|
||||||
|
sys.exit(1)
|
||||||
|
if len(skill_name) > MAX_SKILL_NAME_LENGTH:
|
||||||
|
print(
|
||||||
|
f"[ERROR] Skill name '{skill_name}' is too long ({len(skill_name)} characters). "
|
||||||
|
f"Maximum is {MAX_SKILL_NAME_LENGTH} characters."
|
||||||
|
)
|
||||||
|
sys.exit(1)
|
||||||
|
if skill_name != raw_skill_name:
|
||||||
|
print(f"Note: Normalized skill name from '{raw_skill_name}' to '{skill_name}'.")
|
||||||
|
|
||||||
|
resources = parse_resources(args.resources)
|
||||||
|
if args.examples and not resources:
|
||||||
|
print("[ERROR] --examples requires --resources to be set.")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
path = args.path
|
||||||
|
|
||||||
|
print(f"Initializing skill: {skill_name}")
|
||||||
|
print(f" Location: {path}")
|
||||||
|
if resources:
|
||||||
|
print(f" Resources: {', '.join(resources)}")
|
||||||
|
if args.examples:
|
||||||
|
print(" Examples: enabled")
|
||||||
|
else:
|
||||||
|
print(" Resources: none (create as needed)")
|
||||||
|
print()
|
||||||
|
|
||||||
|
result = init_skill(skill_name, path, resources, args.examples, args.interface)
|
||||||
|
|
||||||
|
if result:
|
||||||
|
sys.exit(0)
|
||||||
|
else:
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Quick validation script for skills - minimal version
|
||||||
|
"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
MAX_SKILL_NAME_LENGTH = 64
|
||||||
|
|
||||||
|
|
||||||
|
def validate_skill(skill_path):
|
||||||
|
"""Basic validation of a skill"""
|
||||||
|
skill_path = Path(skill_path)
|
||||||
|
|
||||||
|
skill_md = skill_path / "SKILL.md"
|
||||||
|
if not skill_md.exists():
|
||||||
|
return False, "SKILL.md not found"
|
||||||
|
|
||||||
|
content = skill_md.read_text()
|
||||||
|
if not content.startswith("---"):
|
||||||
|
return False, "No YAML frontmatter found"
|
||||||
|
|
||||||
|
match = re.match(r"^---\n(.*?)\n---", content, re.DOTALL)
|
||||||
|
if not match:
|
||||||
|
return False, "Invalid frontmatter format"
|
||||||
|
|
||||||
|
frontmatter_text = match.group(1)
|
||||||
|
|
||||||
|
try:
|
||||||
|
frontmatter = yaml.safe_load(frontmatter_text)
|
||||||
|
if not isinstance(frontmatter, dict):
|
||||||
|
return False, "Frontmatter must be a YAML dictionary"
|
||||||
|
except yaml.YAMLError as e:
|
||||||
|
return False, f"Invalid YAML in frontmatter: {e}"
|
||||||
|
|
||||||
|
allowed_properties = {"name", "description", "license", "allowed-tools", "metadata"}
|
||||||
|
|
||||||
|
unexpected_keys = set(frontmatter.keys()) - allowed_properties
|
||||||
|
if unexpected_keys:
|
||||||
|
allowed = ", ".join(sorted(allowed_properties))
|
||||||
|
unexpected = ", ".join(sorted(unexpected_keys))
|
||||||
|
return (
|
||||||
|
False,
|
||||||
|
f"Unexpected key(s) in SKILL.md frontmatter: {unexpected}. Allowed properties are: {allowed}",
|
||||||
|
)
|
||||||
|
|
||||||
|
if "name" not in frontmatter:
|
||||||
|
return False, "Missing 'name' in frontmatter"
|
||||||
|
if "description" not in frontmatter:
|
||||||
|
return False, "Missing 'description' in frontmatter"
|
||||||
|
|
||||||
|
name = frontmatter.get("name", "")
|
||||||
|
if not isinstance(name, str):
|
||||||
|
return False, f"Name must be a string, got {type(name).__name__}"
|
||||||
|
name = name.strip()
|
||||||
|
if name:
|
||||||
|
if not re.match(r"^[a-z0-9-]+$", name):
|
||||||
|
return (
|
||||||
|
False,
|
||||||
|
f"Name '{name}' should be hyphen-case (lowercase letters, digits, and hyphens only)",
|
||||||
|
)
|
||||||
|
if name.startswith("-") or name.endswith("-") or "--" in name:
|
||||||
|
return (
|
||||||
|
False,
|
||||||
|
f"Name '{name}' cannot start/end with hyphen or contain consecutive hyphens",
|
||||||
|
)
|
||||||
|
if len(name) > MAX_SKILL_NAME_LENGTH:
|
||||||
|
return (
|
||||||
|
False,
|
||||||
|
f"Name is too long ({len(name)} characters). "
|
||||||
|
f"Maximum is {MAX_SKILL_NAME_LENGTH} characters.",
|
||||||
|
)
|
||||||
|
|
||||||
|
description = frontmatter.get("description", "")
|
||||||
|
if not isinstance(description, str):
|
||||||
|
return False, f"Description must be a string, got {type(description).__name__}"
|
||||||
|
description = description.strip()
|
||||||
|
if description:
|
||||||
|
if "<" in description or ">" in description:
|
||||||
|
return False, "Description cannot contain angle brackets (< or >)"
|
||||||
|
if len(description) > 1024:
|
||||||
|
return (
|
||||||
|
False,
|
||||||
|
f"Description is too long ({len(description)} characters). Maximum is 1024 characters.",
|
||||||
|
)
|
||||||
|
|
||||||
|
return True, "Skill is valid!"
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
if len(sys.argv) != 2:
|
||||||
|
print("Usage: python quick_validate.py <skill_directory>")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
valid, message = validate_skill(sys.argv[1])
|
||||||
|
print(message)
|
||||||
|
sys.exit(0 if valid else 1)
|
||||||
202
dotfiles/agents/skills/.system/skill-installer/LICENSE.txt
Normal file
202
dotfiles/agents/skills/.system/skill-installer/LICENSE.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
58
dotfiles/agents/skills/.system/skill-installer/SKILL.md
Normal file
58
dotfiles/agents/skills/.system/skill-installer/SKILL.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
---
|
||||||
|
name: skill-installer
|
||||||
|
description: Install Codex skills into $CODEX_HOME/skills from a curated list or a GitHub repo path. Use when a user asks to list installable skills, install a curated skill, or install a skill from another repo (including private repos).
|
||||||
|
metadata:
|
||||||
|
short-description: Install curated skills from openai/skills or other repos
|
||||||
|
---
|
||||||
|
|
||||||
|
# Skill Installer
|
||||||
|
|
||||||
|
Helps install skills. By default these are from https://github.com/openai/skills/tree/main/skills/.curated, but users can also provide other locations. Experimental skills live in https://github.com/openai/skills/tree/main/skills/.experimental and can be installed the same way.
|
||||||
|
|
||||||
|
Use the helper scripts based on the task:
|
||||||
|
- List skills when the user asks what is available, or if the user uses this skill without specifying what to do. Default listing is `.curated`, but you can pass `--path skills/.experimental` when they ask about experimental skills.
|
||||||
|
- Install from the curated list when the user provides a skill name.
|
||||||
|
- Install from another repo when the user provides a GitHub repo/path (including private repos).
|
||||||
|
|
||||||
|
Install skills with the helper scripts.
|
||||||
|
|
||||||
|
## Communication
|
||||||
|
|
||||||
|
When listing skills, output approximately as follows, depending on the context of the user's request. If they ask about experimental skills, list from `.experimental` instead of `.curated` and label the source accordingly:
|
||||||
|
"""
|
||||||
|
Skills from {repo}:
|
||||||
|
1. skill-1
|
||||||
|
2. skill-2 (already installed)
|
||||||
|
3. ...
|
||||||
|
Which ones would you like installed?
|
||||||
|
"""
|
||||||
|
|
||||||
|
After installing a skill, tell the user: "Restart Codex to pick up new skills."
|
||||||
|
|
||||||
|
## Scripts
|
||||||
|
|
||||||
|
All of these scripts use network, so when running in the sandbox, request escalation when running them.
|
||||||
|
|
||||||
|
- `scripts/list-skills.py` (prints skills list with installed annotations)
|
||||||
|
- `scripts/list-skills.py --format json`
|
||||||
|
- Example (experimental list): `scripts/list-skills.py --path skills/.experimental`
|
||||||
|
- `scripts/install-skill-from-github.py --repo <owner>/<repo> --path <path/to/skill> [<path/to/skill> ...]`
|
||||||
|
- `scripts/install-skill-from-github.py --url https://github.com/<owner>/<repo>/tree/<ref>/<path>`
|
||||||
|
- Example (experimental skill): `scripts/install-skill-from-github.py --repo openai/skills --path skills/.experimental/<skill-name>`
|
||||||
|
|
||||||
|
## Behavior and Options
|
||||||
|
|
||||||
|
- Defaults to direct download for public GitHub repos.
|
||||||
|
- If download fails with auth/permission errors, falls back to git sparse checkout.
|
||||||
|
- Aborts if the destination skill directory already exists.
|
||||||
|
- Installs into `$CODEX_HOME/skills/<skill-name>` (defaults to `~/.codex/skills`).
|
||||||
|
- Multiple `--path` values install multiple skills in one run, each named from the path basename unless `--name` is supplied.
|
||||||
|
- Options: `--ref <ref>` (default `main`), `--dest <path>`, `--method auto|download|git`.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Curated listing is fetched from `https://github.com/openai/skills/tree/main/skills/.curated` via the GitHub API. If it is unavailable, explain the error and exit.
|
||||||
|
- Private GitHub repos can be accessed via existing git credentials or optional `GITHUB_TOKEN`/`GH_TOKEN` for download.
|
||||||
|
- Git fallback tries HTTPS first, then SSH.
|
||||||
|
- The skills at https://github.com/openai/skills/tree/main/skills/.system are preinstalled, so no need to help users install those. If they ask, just explain this. If they insist, you can download and overwrite.
|
||||||
|
- Installed annotations come from `$CODEX_HOME/skills`.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
interface:
|
||||||
|
display_name: "Skill Installer"
|
||||||
|
short_description: "Install curated skills from openai/skills or other repos"
|
||||||
|
icon_small: "./assets/skill-installer-small.svg"
|
||||||
|
icon_large: "./assets/skill-installer.png"
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" viewBox="0 0 16 16">
|
||||||
|
<path fill="#0D0D0D" d="M2.145 3.959a2.033 2.033 0 0 1 2.022-1.824h5.966c.551 0 .997 0 1.357.029.367.03.692.093.993.246l.174.098c.397.243.72.593.932 1.01l.053.114c.116.269.168.557.194.878.03.36.03.805.03 1.357v4.3a2.365 2.365 0 0 1-2.366 2.365h-1.312a2.198 2.198 0 0 1-4.377 0H4.167A2.032 2.032 0 0 1 2.135 10.5V9.333l.004-.088A.865.865 0 0 1 3 8.468l.116-.006A1.135 1.135 0 0 0 3 6.199a.865.865 0 0 1-.865-.864V4.167l.01-.208Zm1.054 1.186a2.198 2.198 0 0 1 0 4.376v.98c0 .534.433.967.968.967H6l.089.004a.866.866 0 0 1 .776.861 1.135 1.135 0 0 0 2.27 0c0-.478.387-.865.865-.865h1.5c.719 0 1.301-.583 1.301-1.301v-4.3c0-.57 0-.964-.025-1.27a1.933 1.933 0 0 0-.09-.493L12.642 4a1.47 1.47 0 0 0-.541-.585l-.102-.056c-.126-.065-.295-.11-.596-.135a17.31 17.31 0 0 0-1.27-.025H4.167a.968.968 0 0 0-.968.968v.978Z"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 923 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
@@ -0,0 +1,21 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Shared GitHub helpers for skill install scripts."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
|
||||||
|
def github_request(url: str, user_agent: str) -> bytes:
|
||||||
|
headers = {"User-Agent": user_agent}
|
||||||
|
token = os.environ.get("GITHUB_TOKEN") or os.environ.get("GH_TOKEN")
|
||||||
|
if token:
|
||||||
|
headers["Authorization"] = f"token {token}"
|
||||||
|
req = urllib.request.Request(url, headers=headers)
|
||||||
|
with urllib.request.urlopen(req) as resp:
|
||||||
|
return resp.read()
|
||||||
|
|
||||||
|
|
||||||
|
def github_api_contents_url(repo: str, path: str, ref: str) -> str:
|
||||||
|
return f"https://api.github.com/repos/{repo}/contents/{path}?ref={ref}"
|
||||||
@@ -0,0 +1,308 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Install a skill from a GitHub repo path into $CODEX_HOME/skills."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
from dataclasses import dataclass
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import urllib.error
|
||||||
|
import urllib.parse
|
||||||
|
import zipfile
|
||||||
|
|
||||||
|
from github_utils import github_request
|
||||||
|
DEFAULT_REF = "main"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Args:
|
||||||
|
url: str | None = None
|
||||||
|
repo: str | None = None
|
||||||
|
path: list[str] | None = None
|
||||||
|
ref: str = DEFAULT_REF
|
||||||
|
dest: str | None = None
|
||||||
|
name: str | None = None
|
||||||
|
method: str = "auto"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Source:
|
||||||
|
owner: str
|
||||||
|
repo: str
|
||||||
|
ref: str
|
||||||
|
paths: list[str]
|
||||||
|
repo_url: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class InstallError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _codex_home() -> str:
|
||||||
|
return os.environ.get("CODEX_HOME", os.path.expanduser("~/.codex"))
|
||||||
|
|
||||||
|
|
||||||
|
def _tmp_root() -> str:
|
||||||
|
base = os.path.join(tempfile.gettempdir(), "codex")
|
||||||
|
os.makedirs(base, exist_ok=True)
|
||||||
|
return base
|
||||||
|
|
||||||
|
|
||||||
|
def _request(url: str) -> bytes:
|
||||||
|
return github_request(url, "codex-skill-install")
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_github_url(url: str, default_ref: str) -> tuple[str, str, str, str | None]:
|
||||||
|
parsed = urllib.parse.urlparse(url)
|
||||||
|
if parsed.netloc != "github.com":
|
||||||
|
raise InstallError("Only GitHub URLs are supported for download mode.")
|
||||||
|
parts = [p for p in parsed.path.split("/") if p]
|
||||||
|
if len(parts) < 2:
|
||||||
|
raise InstallError("Invalid GitHub URL.")
|
||||||
|
owner, repo = parts[0], parts[1]
|
||||||
|
ref = default_ref
|
||||||
|
subpath = ""
|
||||||
|
if len(parts) > 2:
|
||||||
|
if parts[2] in ("tree", "blob"):
|
||||||
|
if len(parts) < 4:
|
||||||
|
raise InstallError("GitHub URL missing ref or path.")
|
||||||
|
ref = parts[3]
|
||||||
|
subpath = "/".join(parts[4:])
|
||||||
|
else:
|
||||||
|
subpath = "/".join(parts[2:])
|
||||||
|
return owner, repo, ref, subpath or None
|
||||||
|
|
||||||
|
|
||||||
|
def _download_repo_zip(owner: str, repo: str, ref: str, dest_dir: str) -> str:
|
||||||
|
zip_url = f"https://codeload.github.com/{owner}/{repo}/zip/{ref}"
|
||||||
|
zip_path = os.path.join(dest_dir, "repo.zip")
|
||||||
|
try:
|
||||||
|
payload = _request(zip_url)
|
||||||
|
except urllib.error.HTTPError as exc:
|
||||||
|
raise InstallError(f"Download failed: HTTP {exc.code}") from exc
|
||||||
|
with open(zip_path, "wb") as file_handle:
|
||||||
|
file_handle.write(payload)
|
||||||
|
with zipfile.ZipFile(zip_path, "r") as zip_file:
|
||||||
|
_safe_extract_zip(zip_file, dest_dir)
|
||||||
|
top_levels = {name.split("/")[0] for name in zip_file.namelist() if name}
|
||||||
|
if not top_levels:
|
||||||
|
raise InstallError("Downloaded archive was empty.")
|
||||||
|
if len(top_levels) != 1:
|
||||||
|
raise InstallError("Unexpected archive layout.")
|
||||||
|
return os.path.join(dest_dir, next(iter(top_levels)))
|
||||||
|
|
||||||
|
|
||||||
|
def _run_git(args: list[str]) -> None:
|
||||||
|
result = subprocess.run(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise InstallError(result.stderr.strip() or "Git command failed.")
|
||||||
|
|
||||||
|
|
||||||
|
def _safe_extract_zip(zip_file: zipfile.ZipFile, dest_dir: str) -> None:
|
||||||
|
dest_root = os.path.realpath(dest_dir)
|
||||||
|
for info in zip_file.infolist():
|
||||||
|
extracted_path = os.path.realpath(os.path.join(dest_dir, info.filename))
|
||||||
|
if extracted_path == dest_root or extracted_path.startswith(dest_root + os.sep):
|
||||||
|
continue
|
||||||
|
raise InstallError("Archive contains files outside the destination.")
|
||||||
|
zip_file.extractall(dest_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_relative_path(path: str) -> None:
|
||||||
|
if os.path.isabs(path) or os.path.normpath(path).startswith(".."):
|
||||||
|
raise InstallError("Skill path must be a relative path inside the repo.")
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_skill_name(name: str) -> None:
|
||||||
|
altsep = os.path.altsep
|
||||||
|
if not name or os.path.sep in name or (altsep and altsep in name):
|
||||||
|
raise InstallError("Skill name must be a single path segment.")
|
||||||
|
if name in (".", ".."):
|
||||||
|
raise InstallError("Invalid skill name.")
|
||||||
|
|
||||||
|
|
||||||
|
def _git_sparse_checkout(repo_url: str, ref: str, paths: list[str], dest_dir: str) -> str:
|
||||||
|
repo_dir = os.path.join(dest_dir, "repo")
|
||||||
|
clone_cmd = [
|
||||||
|
"git",
|
||||||
|
"clone",
|
||||||
|
"--filter=blob:none",
|
||||||
|
"--depth",
|
||||||
|
"1",
|
||||||
|
"--sparse",
|
||||||
|
"--single-branch",
|
||||||
|
"--branch",
|
||||||
|
ref,
|
||||||
|
repo_url,
|
||||||
|
repo_dir,
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
_run_git(clone_cmd)
|
||||||
|
except InstallError:
|
||||||
|
_run_git(
|
||||||
|
[
|
||||||
|
"git",
|
||||||
|
"clone",
|
||||||
|
"--filter=blob:none",
|
||||||
|
"--depth",
|
||||||
|
"1",
|
||||||
|
"--sparse",
|
||||||
|
"--single-branch",
|
||||||
|
repo_url,
|
||||||
|
repo_dir,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
_run_git(["git", "-C", repo_dir, "sparse-checkout", "set", *paths])
|
||||||
|
_run_git(["git", "-C", repo_dir, "checkout", ref])
|
||||||
|
return repo_dir
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_skill(path: str) -> None:
|
||||||
|
if not os.path.isdir(path):
|
||||||
|
raise InstallError(f"Skill path not found: {path}")
|
||||||
|
skill_md = os.path.join(path, "SKILL.md")
|
||||||
|
if not os.path.isfile(skill_md):
|
||||||
|
raise InstallError("SKILL.md not found in selected skill directory.")
|
||||||
|
|
||||||
|
|
||||||
|
def _copy_skill(src: str, dest_dir: str) -> None:
|
||||||
|
os.makedirs(os.path.dirname(dest_dir), exist_ok=True)
|
||||||
|
if os.path.exists(dest_dir):
|
||||||
|
raise InstallError(f"Destination already exists: {dest_dir}")
|
||||||
|
shutil.copytree(src, dest_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def _build_repo_url(owner: str, repo: str) -> str:
|
||||||
|
return f"https://github.com/{owner}/{repo}.git"
|
||||||
|
|
||||||
|
|
||||||
|
def _build_repo_ssh(owner: str, repo: str) -> str:
|
||||||
|
return f"git@github.com:{owner}/{repo}.git"
|
||||||
|
|
||||||
|
|
||||||
|
def _prepare_repo(source: Source, method: str, tmp_dir: str) -> str:
|
||||||
|
if method in ("download", "auto"):
|
||||||
|
try:
|
||||||
|
return _download_repo_zip(source.owner, source.repo, source.ref, tmp_dir)
|
||||||
|
except InstallError as exc:
|
||||||
|
if method == "download":
|
||||||
|
raise
|
||||||
|
err_msg = str(exc)
|
||||||
|
if "HTTP 401" in err_msg or "HTTP 403" in err_msg or "HTTP 404" in err_msg:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
if method in ("git", "auto"):
|
||||||
|
repo_url = source.repo_url or _build_repo_url(source.owner, source.repo)
|
||||||
|
try:
|
||||||
|
return _git_sparse_checkout(repo_url, source.ref, source.paths, tmp_dir)
|
||||||
|
except InstallError:
|
||||||
|
repo_url = _build_repo_ssh(source.owner, source.repo)
|
||||||
|
return _git_sparse_checkout(repo_url, source.ref, source.paths, tmp_dir)
|
||||||
|
raise InstallError("Unsupported method.")
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_source(args: Args) -> Source:
|
||||||
|
if args.url:
|
||||||
|
owner, repo, ref, url_path = _parse_github_url(args.url, args.ref)
|
||||||
|
if args.path is not None:
|
||||||
|
paths = list(args.path)
|
||||||
|
elif url_path:
|
||||||
|
paths = [url_path]
|
||||||
|
else:
|
||||||
|
paths = []
|
||||||
|
if not paths:
|
||||||
|
raise InstallError("Missing --path for GitHub URL.")
|
||||||
|
return Source(owner=owner, repo=repo, ref=ref, paths=paths)
|
||||||
|
|
||||||
|
if not args.repo:
|
||||||
|
raise InstallError("Provide --repo or --url.")
|
||||||
|
if "://" in args.repo:
|
||||||
|
return _resolve_source(
|
||||||
|
Args(url=args.repo, repo=None, path=args.path, ref=args.ref)
|
||||||
|
)
|
||||||
|
|
||||||
|
repo_parts = [p for p in args.repo.split("/") if p]
|
||||||
|
if len(repo_parts) != 2:
|
||||||
|
raise InstallError("--repo must be in owner/repo format.")
|
||||||
|
if not args.path:
|
||||||
|
raise InstallError("Missing --path for --repo.")
|
||||||
|
paths = list(args.path)
|
||||||
|
return Source(
|
||||||
|
owner=repo_parts[0],
|
||||||
|
repo=repo_parts[1],
|
||||||
|
ref=args.ref,
|
||||||
|
paths=paths,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _default_dest() -> str:
|
||||||
|
return os.path.join(_codex_home(), "skills")
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_args(argv: list[str]) -> Args:
|
||||||
|
parser = argparse.ArgumentParser(description="Install a skill from GitHub.")
|
||||||
|
parser.add_argument("--repo", help="owner/repo")
|
||||||
|
parser.add_argument("--url", help="https://github.com/owner/repo[/tree/ref/path]")
|
||||||
|
parser.add_argument(
|
||||||
|
"--path",
|
||||||
|
nargs="+",
|
||||||
|
help="Path(s) to skill(s) inside repo",
|
||||||
|
)
|
||||||
|
parser.add_argument("--ref", default=DEFAULT_REF)
|
||||||
|
parser.add_argument("--dest", help="Destination skills directory")
|
||||||
|
parser.add_argument(
|
||||||
|
"--name", help="Destination skill name (defaults to basename of path)"
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--method",
|
||||||
|
choices=["auto", "download", "git"],
|
||||||
|
default="auto",
|
||||||
|
)
|
||||||
|
return parser.parse_args(argv, namespace=Args())
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str]) -> int:
|
||||||
|
args = _parse_args(argv)
|
||||||
|
try:
|
||||||
|
source = _resolve_source(args)
|
||||||
|
source.ref = source.ref or args.ref
|
||||||
|
if not source.paths:
|
||||||
|
raise InstallError("No skill paths provided.")
|
||||||
|
for path in source.paths:
|
||||||
|
_validate_relative_path(path)
|
||||||
|
dest_root = args.dest or _default_dest()
|
||||||
|
tmp_dir = tempfile.mkdtemp(prefix="skill-install-", dir=_tmp_root())
|
||||||
|
try:
|
||||||
|
repo_root = _prepare_repo(source, args.method, tmp_dir)
|
||||||
|
installed = []
|
||||||
|
for path in source.paths:
|
||||||
|
skill_name = args.name if len(source.paths) == 1 else None
|
||||||
|
skill_name = skill_name or os.path.basename(path.rstrip("/"))
|
||||||
|
_validate_skill_name(skill_name)
|
||||||
|
if not skill_name:
|
||||||
|
raise InstallError("Unable to derive skill name.")
|
||||||
|
dest_dir = os.path.join(dest_root, skill_name)
|
||||||
|
if os.path.exists(dest_dir):
|
||||||
|
raise InstallError(f"Destination already exists: {dest_dir}")
|
||||||
|
skill_src = os.path.join(repo_root, path)
|
||||||
|
_validate_skill(skill_src)
|
||||||
|
_copy_skill(skill_src, dest_dir)
|
||||||
|
installed.append((skill_name, dest_dir))
|
||||||
|
finally:
|
||||||
|
if os.path.isdir(tmp_dir):
|
||||||
|
shutil.rmtree(tmp_dir, ignore_errors=True)
|
||||||
|
for skill_name, dest_dir in installed:
|
||||||
|
print(f"Installed {skill_name} to {dest_dir}")
|
||||||
|
return 0
|
||||||
|
except InstallError as exc:
|
||||||
|
print(f"Error: {exc}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main(sys.argv[1:]))
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""List skills from a GitHub repo path."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import urllib.error
|
||||||
|
|
||||||
|
from github_utils import github_api_contents_url, github_request
|
||||||
|
|
||||||
|
DEFAULT_REPO = "openai/skills"
|
||||||
|
DEFAULT_PATH = "skills/.curated"
|
||||||
|
DEFAULT_REF = "main"
|
||||||
|
|
||||||
|
|
||||||
|
class ListError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class Args(argparse.Namespace):
|
||||||
|
repo: str
|
||||||
|
path: str
|
||||||
|
ref: str
|
||||||
|
format: str
|
||||||
|
|
||||||
|
|
||||||
|
def _request(url: str) -> bytes:
|
||||||
|
return github_request(url, "codex-skill-list")
|
||||||
|
|
||||||
|
|
||||||
|
def _codex_home() -> str:
|
||||||
|
return os.environ.get("CODEX_HOME", os.path.expanduser("~/.codex"))
|
||||||
|
|
||||||
|
|
||||||
|
def _installed_skills() -> set[str]:
|
||||||
|
root = os.path.join(_codex_home(), "skills")
|
||||||
|
if not os.path.isdir(root):
|
||||||
|
return set()
|
||||||
|
entries = set()
|
||||||
|
for name in os.listdir(root):
|
||||||
|
path = os.path.join(root, name)
|
||||||
|
if os.path.isdir(path):
|
||||||
|
entries.add(name)
|
||||||
|
return entries
|
||||||
|
|
||||||
|
|
||||||
|
def _list_skills(repo: str, path: str, ref: str) -> list[str]:
|
||||||
|
api_url = github_api_contents_url(repo, path, ref)
|
||||||
|
try:
|
||||||
|
payload = _request(api_url)
|
||||||
|
except urllib.error.HTTPError as exc:
|
||||||
|
if exc.code == 404:
|
||||||
|
raise ListError(
|
||||||
|
"Skills path not found: "
|
||||||
|
f"https://github.com/{repo}/tree/{ref}/{path}"
|
||||||
|
) from exc
|
||||||
|
raise ListError(f"Failed to fetch skills: HTTP {exc.code}") from exc
|
||||||
|
data = json.loads(payload.decode("utf-8"))
|
||||||
|
if not isinstance(data, list):
|
||||||
|
raise ListError("Unexpected skills listing response.")
|
||||||
|
skills = [item["name"] for item in data if item.get("type") == "dir"]
|
||||||
|
return sorted(skills)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_args(argv: list[str]) -> Args:
|
||||||
|
parser = argparse.ArgumentParser(description="List skills.")
|
||||||
|
parser.add_argument("--repo", default=DEFAULT_REPO)
|
||||||
|
parser.add_argument(
|
||||||
|
"--path",
|
||||||
|
default=DEFAULT_PATH,
|
||||||
|
help="Repo path to list (default: skills/.curated)",
|
||||||
|
)
|
||||||
|
parser.add_argument("--ref", default=DEFAULT_REF)
|
||||||
|
parser.add_argument(
|
||||||
|
"--format",
|
||||||
|
choices=["text", "json"],
|
||||||
|
default="text",
|
||||||
|
help="Output format",
|
||||||
|
)
|
||||||
|
return parser.parse_args(argv, namespace=Args())
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str]) -> int:
|
||||||
|
args = _parse_args(argv)
|
||||||
|
try:
|
||||||
|
skills = _list_skills(args.repo, args.path, args.ref)
|
||||||
|
installed = _installed_skills()
|
||||||
|
if args.format == "json":
|
||||||
|
payload = [
|
||||||
|
{"name": name, "installed": name in installed} for name in skills
|
||||||
|
]
|
||||||
|
print(json.dumps(payload))
|
||||||
|
else:
|
||||||
|
for idx, name in enumerate(skills, start=1):
|
||||||
|
suffix = " (already installed)" if name in installed else ""
|
||||||
|
print(f"{idx}. {name}{suffix}")
|
||||||
|
return 0
|
||||||
|
except ListError as exc:
|
||||||
|
print(f"Error: {exc}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main(sys.argv[1:]))
|
||||||
202
dotfiles/agents/skills/gh-address-comments/LICENSE.txt
Normal file
202
dotfiles/agents/skills/gh-address-comments/LICENSE.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
25
dotfiles/agents/skills/gh-address-comments/SKILL.md
Normal file
25
dotfiles/agents/skills/gh-address-comments/SKILL.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
name: gh-address-comments
|
||||||
|
description: Help address review/issue comments on the open GitHub PR for the current branch using gh CLI; verify gh auth first and prompt the user to authenticate if not logged in.
|
||||||
|
metadata:
|
||||||
|
short-description: Address comments in a GitHub PR review
|
||||||
|
---
|
||||||
|
|
||||||
|
# PR Comment Handler
|
||||||
|
|
||||||
|
Guide to find the open PR for the current branch and address its comments with gh CLI. Run all `gh` commands with elevated network access.
|
||||||
|
|
||||||
|
Prereq: ensure `gh` is authenticated (for example, run `gh auth login` once), then run `gh auth status` with escalated permissions (include workflow/repo scopes) so `gh` commands succeed. If sandboxing blocks `gh auth status`, rerun it with `sandbox_permissions=require_escalated`.
|
||||||
|
|
||||||
|
## 1) Inspect comments needing attention
|
||||||
|
- Run scripts/fetch_comments.py which will print out all the comments and review threads on the PR
|
||||||
|
|
||||||
|
## 2) Ask the user for clarification
|
||||||
|
- Number all the review threads and comments and provide a short summary of what would be required to apply a fix for it
|
||||||
|
- Ask the user which numbered comments should be addressed
|
||||||
|
|
||||||
|
## 3) If user chooses comments
|
||||||
|
- Apply fixes for the selected comments
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- If gh hits auth/rate issues mid-run, prompt the user to re-authenticate with `gh auth login`, then retry.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
interface:
|
||||||
|
display_name: "GitHub Address Comments"
|
||||||
|
short_description: Address comments in a GitHub PR review"
|
||||||
|
icon_small: "./assets/github-small.svg"
|
||||||
|
icon_large: "./assets/github.png"
|
||||||
|
default_prompt: "Address all actionable GitHub PR review comments in this branch and summarize the updates."
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" viewBox="0 0 16 16">
|
||||||
|
<path fill="currentColor" d="M8 1.3a6.665 6.665 0 0 1 5.413 10.56 6.677 6.677 0 0 1-3.288 2.432c-.333.067-.458-.142-.458-.316 0-.226.008-.942.008-1.834 0-.625-.208-1.025-.45-1.233 1.483-.167 3.042-.734 3.042-3.292a2.58 2.58 0 0 0-.684-1.792c.067-.166.3-.85-.066-1.766 0 0-.559-.184-1.834.683a6.186 6.186 0 0 0-1.666-.225c-.567 0-1.134.075-1.667.225-1.275-.858-1.833-.683-1.833-.683-.367.916-.134 1.6-.067 1.766a2.594 2.594 0 0 0-.683 1.792c0 2.55 1.55 3.125 3.033 3.292-.192.166-.367.458-.425.891-.383.175-1.342.459-1.942-.55-.125-.2-.5-.691-1.025-.683-.558.008-.225.317.009.442.283.158.608.75.683.941.133.376.567 1.092 2.242.784 0 .558.008 1.083.008 1.242 0 .174-.125.374-.458.316a6.662 6.662 0 0 1-4.559-6.325A6.665 6.665 0 0 1 8 1.3Z"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 853 B |
BIN
dotfiles/agents/skills/gh-address-comments/assets/github.png
Normal file
BIN
dotfiles/agents/skills/gh-address-comments/assets/github.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
@@ -0,0 +1,237 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Fetch all PR conversation comments + reviews + review threads (inline threads)
|
||||||
|
for the PR associated with the current git branch, by shelling out to:
|
||||||
|
|
||||||
|
gh api graphql
|
||||||
|
|
||||||
|
Requires:
|
||||||
|
- `gh auth login` already set up
|
||||||
|
- current branch has an associated (open) PR
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
python fetch_comments.py > pr_comments.json
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
QUERY = """\
|
||||||
|
query(
|
||||||
|
$owner: String!,
|
||||||
|
$repo: String!,
|
||||||
|
$number: Int!,
|
||||||
|
$commentsCursor: String,
|
||||||
|
$reviewsCursor: String,
|
||||||
|
$threadsCursor: String
|
||||||
|
) {
|
||||||
|
repository(owner: $owner, name: $repo) {
|
||||||
|
pullRequest(number: $number) {
|
||||||
|
number
|
||||||
|
url
|
||||||
|
title
|
||||||
|
state
|
||||||
|
|
||||||
|
# Top-level "Conversation" comments (issue comments on the PR)
|
||||||
|
comments(first: 100, after: $commentsCursor) {
|
||||||
|
pageInfo { hasNextPage endCursor }
|
||||||
|
nodes {
|
||||||
|
id
|
||||||
|
body
|
||||||
|
createdAt
|
||||||
|
updatedAt
|
||||||
|
author { login }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Review submissions (Approve / Request changes / Comment), with body if present
|
||||||
|
reviews(first: 100, after: $reviewsCursor) {
|
||||||
|
pageInfo { hasNextPage endCursor }
|
||||||
|
nodes {
|
||||||
|
id
|
||||||
|
state
|
||||||
|
body
|
||||||
|
submittedAt
|
||||||
|
author { login }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Inline review threads (grouped), includes resolved state
|
||||||
|
reviewThreads(first: 100, after: $threadsCursor) {
|
||||||
|
pageInfo { hasNextPage endCursor }
|
||||||
|
nodes {
|
||||||
|
id
|
||||||
|
isResolved
|
||||||
|
isOutdated
|
||||||
|
path
|
||||||
|
line
|
||||||
|
diffSide
|
||||||
|
startLine
|
||||||
|
startDiffSide
|
||||||
|
originalLine
|
||||||
|
originalStartLine
|
||||||
|
resolvedBy { login }
|
||||||
|
comments(first: 100) {
|
||||||
|
nodes {
|
||||||
|
id
|
||||||
|
body
|
||||||
|
createdAt
|
||||||
|
updatedAt
|
||||||
|
author { login }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def _run(cmd: list[str], stdin: str | None = None) -> str:
|
||||||
|
p = subprocess.run(cmd, input=stdin, capture_output=True, text=True)
|
||||||
|
if p.returncode != 0:
|
||||||
|
raise RuntimeError(f"Command failed: {' '.join(cmd)}\n{p.stderr}")
|
||||||
|
return p.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def _run_json(cmd: list[str], stdin: str | None = None) -> dict[str, Any]:
|
||||||
|
out = _run(cmd, stdin=stdin)
|
||||||
|
try:
|
||||||
|
return json.loads(out)
|
||||||
|
except json.JSONDecodeError as e:
|
||||||
|
raise RuntimeError(f"Failed to parse JSON from command output: {e}\nRaw:\n{out}") from e
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_gh_authenticated() -> None:
|
||||||
|
try:
|
||||||
|
_run(["gh", "auth", "status"])
|
||||||
|
except RuntimeError:
|
||||||
|
print("run `gh auth login` to authenticate the GitHub CLI", file=sys.stderr)
|
||||||
|
raise RuntimeError("gh auth status failed; run `gh auth login` to authenticate the GitHub CLI") from None
|
||||||
|
|
||||||
|
|
||||||
|
def gh_pr_view_json(fields: str) -> dict[str, Any]:
|
||||||
|
# fields is a comma-separated list like: "number,headRepositoryOwner,headRepository"
|
||||||
|
return _run_json(["gh", "pr", "view", "--json", fields])
|
||||||
|
|
||||||
|
|
||||||
|
def get_current_pr_ref() -> tuple[str, str, int]:
|
||||||
|
"""
|
||||||
|
Resolve the PR for the current branch (whatever gh considers associated).
|
||||||
|
Works for cross-repo PRs too, by reading head repository owner/name.
|
||||||
|
"""
|
||||||
|
pr = gh_pr_view_json("number,headRepositoryOwner,headRepository")
|
||||||
|
owner = pr["headRepositoryOwner"]["login"]
|
||||||
|
repo = pr["headRepository"]["name"]
|
||||||
|
number = int(pr["number"])
|
||||||
|
return owner, repo, number
|
||||||
|
|
||||||
|
|
||||||
|
def gh_api_graphql(
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
number: int,
|
||||||
|
comments_cursor: str | None = None,
|
||||||
|
reviews_cursor: str | None = None,
|
||||||
|
threads_cursor: str | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""
|
||||||
|
Call `gh api graphql` using -F variables, avoiding JSON blobs with nulls.
|
||||||
|
Query is passed via stdin using query=@- to avoid shell newline/quoting issues.
|
||||||
|
"""
|
||||||
|
cmd = [
|
||||||
|
"gh",
|
||||||
|
"api",
|
||||||
|
"graphql",
|
||||||
|
"-F",
|
||||||
|
"query=@-",
|
||||||
|
"-F",
|
||||||
|
f"owner={owner}",
|
||||||
|
"-F",
|
||||||
|
f"repo={repo}",
|
||||||
|
"-F",
|
||||||
|
f"number={number}",
|
||||||
|
]
|
||||||
|
if comments_cursor:
|
||||||
|
cmd += ["-F", f"commentsCursor={comments_cursor}"]
|
||||||
|
if reviews_cursor:
|
||||||
|
cmd += ["-F", f"reviewsCursor={reviews_cursor}"]
|
||||||
|
if threads_cursor:
|
||||||
|
cmd += ["-F", f"threadsCursor={threads_cursor}"]
|
||||||
|
|
||||||
|
return _run_json(cmd, stdin=QUERY)
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_all(owner: str, repo: str, number: int) -> dict[str, Any]:
|
||||||
|
conversation_comments: list[dict[str, Any]] = []
|
||||||
|
reviews: list[dict[str, Any]] = []
|
||||||
|
review_threads: list[dict[str, Any]] = []
|
||||||
|
|
||||||
|
comments_cursor: str | None = None
|
||||||
|
reviews_cursor: str | None = None
|
||||||
|
threads_cursor: str | None = None
|
||||||
|
|
||||||
|
pr_meta: dict[str, Any] | None = None
|
||||||
|
|
||||||
|
while True:
|
||||||
|
payload = gh_api_graphql(
|
||||||
|
owner=owner,
|
||||||
|
repo=repo,
|
||||||
|
number=number,
|
||||||
|
comments_cursor=comments_cursor,
|
||||||
|
reviews_cursor=reviews_cursor,
|
||||||
|
threads_cursor=threads_cursor,
|
||||||
|
)
|
||||||
|
|
||||||
|
if "errors" in payload and payload["errors"]:
|
||||||
|
raise RuntimeError(f"GitHub GraphQL errors:\n{json.dumps(payload['errors'], indent=2)}")
|
||||||
|
|
||||||
|
pr = payload["data"]["repository"]["pullRequest"]
|
||||||
|
if pr_meta is None:
|
||||||
|
pr_meta = {
|
||||||
|
"number": pr["number"],
|
||||||
|
"url": pr["url"],
|
||||||
|
"title": pr["title"],
|
||||||
|
"state": pr["state"],
|
||||||
|
"owner": owner,
|
||||||
|
"repo": repo,
|
||||||
|
}
|
||||||
|
|
||||||
|
c = pr["comments"]
|
||||||
|
r = pr["reviews"]
|
||||||
|
t = pr["reviewThreads"]
|
||||||
|
|
||||||
|
conversation_comments.extend(c.get("nodes") or [])
|
||||||
|
reviews.extend(r.get("nodes") or [])
|
||||||
|
review_threads.extend(t.get("nodes") or [])
|
||||||
|
|
||||||
|
comments_cursor = c["pageInfo"]["endCursor"] if c["pageInfo"]["hasNextPage"] else None
|
||||||
|
reviews_cursor = r["pageInfo"]["endCursor"] if r["pageInfo"]["hasNextPage"] else None
|
||||||
|
threads_cursor = t["pageInfo"]["endCursor"] if t["pageInfo"]["hasNextPage"] else None
|
||||||
|
|
||||||
|
if not (comments_cursor or reviews_cursor or threads_cursor):
|
||||||
|
break
|
||||||
|
|
||||||
|
assert pr_meta is not None
|
||||||
|
return {
|
||||||
|
"pull_request": pr_meta,
|
||||||
|
"conversation_comments": conversation_comments,
|
||||||
|
"reviews": reviews,
|
||||||
|
"review_threads": review_threads,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
_ensure_gh_authenticated()
|
||||||
|
owner, repo, number = get_current_pr_ref()
|
||||||
|
result = fetch_all(owner, repo, number)
|
||||||
|
print(json.dumps(result, indent=2))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
312
dotfiles/agents/skills/org-agenda-api/SKILL.md
Normal file
312
dotfiles/agents/skills/org-agenda-api/SKILL.md
Normal file
@@ -0,0 +1,312 @@
|
|||||||
|
---
|
||||||
|
name: org-agenda-api
|
||||||
|
description: Use when interacting with the org-agenda-api HTTP server to read/write org-mode agenda data
|
||||||
|
---
|
||||||
|
|
||||||
|
# Org Agenda API Reference
|
||||||
|
|
||||||
|
HTTP API for org-mode agenda data. Use this skill when you need to query or modify org agenda entries programmatically.
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
Get credentials from pass:
|
||||||
|
```bash
|
||||||
|
pass show colonelpanic-org-agenda.fly.dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns: password on first line, then `user:` and `url:` fields.
|
||||||
|
|
||||||
|
**Note:** The `url` field in pass may be outdated. Use the base URL below.
|
||||||
|
|
||||||
|
## Base URL
|
||||||
|
|
||||||
|
`https://colonelpanic-org-agenda.fly.dev`
|
||||||
|
|
||||||
|
All requests use Basic Auth with the credentials from pass.
|
||||||
|
|
||||||
|
## Read Endpoints
|
||||||
|
|
||||||
|
### GET /agenda
|
||||||
|
Get agenda entries for a day or week.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
- `span`: `day` (default) or `week`
|
||||||
|
- `date`: `YYYY-MM-DD` (default: today)
|
||||||
|
- `include_overdue`: `true` to include overdue items from previous days
|
||||||
|
- `include_completed`: `true` to include items completed on the queried date
|
||||||
|
- `refresh`: `true` to git pull repos first
|
||||||
|
|
||||||
|
Response includes `span`, `date`, `entries` array, and optionally `gitRefresh` results.
|
||||||
|
|
||||||
|
### GET /get-all-todos
|
||||||
|
Get all TODO items from agenda files.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
- `refresh`: `true` to git pull first
|
||||||
|
|
||||||
|
Response includes `defaults` (with `notifyBefore`), `todos` array, and optionally `gitRefresh`.
|
||||||
|
|
||||||
|
### GET /metadata
|
||||||
|
Get all app metadata in a single request. Returns:
|
||||||
|
- `templates`: capture templates
|
||||||
|
- `filterOptions`: tags, categories, priorities, todoStates
|
||||||
|
- `todoStates`: active and done states
|
||||||
|
- `customViews`: available custom agenda views
|
||||||
|
- `errors`: any errors encountered fetching above
|
||||||
|
|
||||||
|
### GET /todo-states
|
||||||
|
Get configured TODO states. Returns:
|
||||||
|
- `active`: array of not-done states (TODO, NEXT, etc.)
|
||||||
|
- `done`: array of done states (DONE, CANCELLED, etc.)
|
||||||
|
|
||||||
|
### GET /filter-options
|
||||||
|
Get available filter options. Returns:
|
||||||
|
- `todoStates`: all states
|
||||||
|
- `priorities`: available priorities (A, B, C)
|
||||||
|
- `tags`: all tags from agenda files
|
||||||
|
- `categories`: all categories
|
||||||
|
|
||||||
|
### GET /custom-views
|
||||||
|
List available custom agenda views. Returns array of `{key, name}` objects.
|
||||||
|
|
||||||
|
### GET /custom-view
|
||||||
|
Run a custom agenda view.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
- `key` (required): custom agenda command key
|
||||||
|
- `refresh`: `true` to git pull first
|
||||||
|
|
||||||
|
### GET /agenda-files
|
||||||
|
Get list of org-agenda-files with existence and readability status.
|
||||||
|
|
||||||
|
### GET /capture-templates (alias: /templates)
|
||||||
|
List available capture templates with their prompts.
|
||||||
|
|
||||||
|
### GET /health
|
||||||
|
Health check. Returns `status`, `uptime`, `requests`, and `captureStatus` if unhealthy.
|
||||||
|
|
||||||
|
### GET /version
|
||||||
|
Version info. Returns `version` and `gitCommit`.
|
||||||
|
|
||||||
|
### GET /debug-config
|
||||||
|
Current org configuration for debugging.
|
||||||
|
|
||||||
|
## Write Endpoints
|
||||||
|
|
||||||
|
### POST /capture
|
||||||
|
Create a new entry using a capture template.
|
||||||
|
|
||||||
|
**Important:** Use `capture-g` (GTD Todo) for most tasks - it properly records creation time and logbook history. Only use `default` when you specifically don't want GTD tracking.
|
||||||
|
|
||||||
|
Body:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"template": "capture-g",
|
||||||
|
"values": {
|
||||||
|
"Title": "Task title",
|
||||||
|
"scheduled": "2026-01-20",
|
||||||
|
"deadline": "2026-01-25",
|
||||||
|
"priority": "A",
|
||||||
|
"tags": ["work", "urgent"],
|
||||||
|
"todo": "TODO"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### POST /complete
|
||||||
|
Mark a TODO as complete.
|
||||||
|
|
||||||
|
Body (use any combination to identify the item):
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "org-id-if-available",
|
||||||
|
"file": "/path/to/file.org",
|
||||||
|
"pos": 12345,
|
||||||
|
"title": "Task title",
|
||||||
|
"state": "DONE"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Lookup order: id -> file+pos+title -> file+title -> title only
|
||||||
|
|
||||||
|
### POST /update
|
||||||
|
Update a TODO's scheduled date, deadline, priority, tags, or properties.
|
||||||
|
|
||||||
|
Body:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "org-id",
|
||||||
|
"file": "/path/to/file.org",
|
||||||
|
"pos": 12345,
|
||||||
|
"title": "Task title",
|
||||||
|
"scheduled": "2026-01-20T10:00:00",
|
||||||
|
"deadline": "2026-01-25",
|
||||||
|
"priority": "B",
|
||||||
|
"tags": ["updated", "tags"],
|
||||||
|
"properties": {
|
||||||
|
"CUSTOM_PROP": "value"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Set value to `null` or empty string to clear. Response includes new `pos` for cache updates.
|
||||||
|
|
||||||
|
### POST /delete
|
||||||
|
Delete an org item permanently.
|
||||||
|
|
||||||
|
Body:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "org-id",
|
||||||
|
"file": "/path/to/file.org",
|
||||||
|
"position": 12345,
|
||||||
|
"include_children": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Requires `include_children: true` if item has children, otherwise returns error.
|
||||||
|
|
||||||
|
### POST /restart
|
||||||
|
Restart the Emacs server (exits gracefully, supervisord restarts).
|
||||||
|
|
||||||
|
## Category Strategy Endpoints
|
||||||
|
|
||||||
|
These require org-category-capture to be configured.
|
||||||
|
|
||||||
|
### GET /category-types
|
||||||
|
List registered category strategy types. Returns array with:
|
||||||
|
- `name`: strategy type name
|
||||||
|
- `hasCategories`: boolean
|
||||||
|
- `captureTemplate`: template string
|
||||||
|
- `prompts`: array of prompt definitions
|
||||||
|
|
||||||
|
### GET /categories
|
||||||
|
Get categories for a strategy type.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
- `type` (required): strategy type name (e.g., "projects")
|
||||||
|
- `existing_only`: `true` to only return categories with capture locations
|
||||||
|
|
||||||
|
Returns `type`, `categories` array, `todoFiles` array.
|
||||||
|
|
||||||
|
### GET /category-tasks
|
||||||
|
Get tasks for a specific category.
|
||||||
|
|
||||||
|
Query params:
|
||||||
|
- `type` (required): strategy type name
|
||||||
|
- `category` (required): category name
|
||||||
|
|
||||||
|
### POST /category-capture
|
||||||
|
Capture a new entry to a category.
|
||||||
|
|
||||||
|
Body:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "projects",
|
||||||
|
"category": "my-project",
|
||||||
|
"title": "Task title",
|
||||||
|
"todo": "TODO",
|
||||||
|
"scheduled": "2026-01-20",
|
||||||
|
"deadline": "2026-01-25",
|
||||||
|
"priority": "A",
|
||||||
|
"tags": ["work"],
|
||||||
|
"properties": {"EFFORT": "1h"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Response Format
|
||||||
|
|
||||||
|
Agenda/todo entries include:
|
||||||
|
- `todo`: TODO state (TODO, NEXT, DONE, etc.)
|
||||||
|
- `title`: Heading text
|
||||||
|
- `scheduled`: ISO date or datetime
|
||||||
|
- `deadline`: ISO date or datetime
|
||||||
|
- `priority`: A, B, or C (only if explicitly set)
|
||||||
|
- `tags`: Array of tags
|
||||||
|
- `file`: Source file path
|
||||||
|
- `pos`: Position in file (may change after edits)
|
||||||
|
- `id`: Org ID if set (stable identifier)
|
||||||
|
- `olpath`: Outline path array
|
||||||
|
- `level`: Heading level
|
||||||
|
- `category`: Category of the item
|
||||||
|
- `properties`: All properties from the property drawer
|
||||||
|
- `completedAt`: ISO timestamp when completed (if applicable)
|
||||||
|
- `agendaLine`: Raw agenda display text (agenda endpoint only)
|
||||||
|
- `notifyBefore`: Array of minutes for notifications
|
||||||
|
- `isWindowHabit`: Boolean for window habits
|
||||||
|
- `habitSummary`: Summary object for habits (if applicable)
|
||||||
|
|
||||||
|
## Common Workflows
|
||||||
|
|
||||||
|
**View today's agenda:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" "$URL/agenda?span=day" | jq '.entries[] | {todo, title, scheduled}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**View this week:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" "$URL/agenda?span=week" | jq .
|
||||||
|
```
|
||||||
|
|
||||||
|
**View completed tasks for a specific date:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" "$URL/agenda?date=2026-01-17&include_completed=true" | jq '.entries[] | select(.completedAt != null) | {title, completedAt}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Get all metadata at once:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" "$URL/metadata" | jq .
|
||||||
|
```
|
||||||
|
|
||||||
|
**Create a task:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" -X POST "$URL/capture" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"template":"capture-g","values":{"Title":"New task","scheduled":"2026-01-20"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Complete a task by title:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" -X POST "$URL/complete" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"title":"Task title"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Update a task's schedule:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" -X POST "$URL/update" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"title":"Task title","scheduled":"2026-01-21T14:00:00"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Clear a deadline:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" -X POST "$URL/update" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"title":"Task title","deadline":null}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Delete a task:**
|
||||||
|
```bash
|
||||||
|
curl -s -u "$USER:$PASS" -X POST "$URL/delete" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"title":"Task to delete","file":"/path/to/file.org","position":12345}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
All endpoints return JSON. Errors include:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"status": "error",
|
||||||
|
"message": "Error description"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Success responses include:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"status": "created" | "completed" | "updated",
|
||||||
|
...additional fields
|
||||||
|
}
|
||||||
|
```
|
||||||
402
dotfiles/agents/skills/planning-coaching/SKILL.md
Normal file
402
dotfiles/agents/skills/planning-coaching/SKILL.md
Normal file
@@ -0,0 +1,402 @@
|
|||||||
|
---
|
||||||
|
name: planning-coaching
|
||||||
|
description: Use when helping with daily planning, task prioritization, reviewing agenda, or when user seems stuck on what to do next
|
||||||
|
---
|
||||||
|
|
||||||
|
# Planning Coaching
|
||||||
|
|
||||||
|
Help Ivan with planning through question-driven coaching, honest feedback, and data-informed accountability.
|
||||||
|
|
||||||
|
## Persistent Files
|
||||||
|
|
||||||
|
**IMPORTANT:** Always read these at the start of planning sessions.
|
||||||
|
|
||||||
|
### Context File: `/home/imalison/org/planning/context.org`
|
||||||
|
Persistent context about Ivan's life, goals, struggles, and current focus. Claude maintains this file - update it when:
|
||||||
|
- Goals or priorities shift
|
||||||
|
- New patterns emerge
|
||||||
|
- Life circumstances change
|
||||||
|
- We learn something about what helps/doesn't help
|
||||||
|
|
||||||
|
Read this first. It's the "state of Ivan" that persists across sessions.
|
||||||
|
|
||||||
|
### Daily Journals: `/home/imalison/org/planning/dailies/YYYY-MM-DD.org`
|
||||||
|
One file per day we do planning. Contains:
|
||||||
|
- That day's plan (short list, focus areas)
|
||||||
|
- Stats table from the previous day review (inline)
|
||||||
|
- Notes from the session
|
||||||
|
- End-of-day reflection (if we do one)
|
||||||
|
|
||||||
|
Create a new file for each planning session day. Reference past dailies to see patterns.
|
||||||
|
|
||||||
|
### Stats File: `/home/imalison/org/planning/stats.org`
|
||||||
|
Running tables for trend analysis:
|
||||||
|
- **Daily Log**: One row per planning day with all metrics
|
||||||
|
- **Weekly Summary**: Aggregated weekly totals with notes
|
||||||
|
|
||||||
|
### Raw Logs: `/home/imalison/org/planning/logs.jsonl`
|
||||||
|
Detailed machine-readable log (one JSON object per line, per day). Captures full task data so we can calculate new metrics retroactively.
|
||||||
|
|
||||||
|
Each line contains:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"date": "2026-01-20",
|
||||||
|
"planned": [{"title": "...", "friction": 3, "effort": 2, "id": "...", "file": "...", ...}],
|
||||||
|
"completed": [{"title": "...", "friction": 3, "effort": 2, "completedAt": "...", ...}],
|
||||||
|
"rescheduled": [{"title": "...", "from": "2026-01-20", "to": "2026-01-21", ...}],
|
||||||
|
"context": {"energy": "medium", "available_time": "full day", "notes": "..."}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
When recording stats:
|
||||||
|
1. Append full JSON object to logs.jsonl
|
||||||
|
2. Add summary row to stats.org Daily Log table
|
||||||
|
3. Include inline stats table in that day's journal
|
||||||
|
4. Update Weekly Summary when a week ends
|
||||||
|
|
||||||
|
## Core Principles
|
||||||
|
|
||||||
|
1. **Question-driven**: Ask questions to help think through priorities rather than dictating
|
||||||
|
2. **Direct and honest**: Call out avoidance patterns directly - this is wanted
|
||||||
|
3. **Data-informed**: Use org-agenda-api to look at patterns, velocity, scheduling history
|
||||||
|
4. **Balance pressure**: Push on procrastination but don't overwhelm on decision-heavy tasks
|
||||||
|
5. **Lightweight and flexible**: Always offer option to skip parts if not feeling it
|
||||||
|
6. **No guilt**: If we fall off the wagon, make it easy and encouraging to get back on
|
||||||
|
|
||||||
|
## Planning Session Flow
|
||||||
|
|
||||||
|
```dot
|
||||||
|
digraph planning_session {
|
||||||
|
rankdir=TB;
|
||||||
|
|
||||||
|
"Read context.org" [shape=box];
|
||||||
|
"Yesterday review (skippable)" [shape=box];
|
||||||
|
"Capture new items" [shape=box];
|
||||||
|
"Check current state" [shape=box];
|
||||||
|
"Inbox processing (skippable)" [shape=box];
|
||||||
|
"Pick focus areas" [shape=box];
|
||||||
|
"Create short list" [shape=box];
|
||||||
|
"Meta check (optional)" [shape=box];
|
||||||
|
"Write daily journal" [shape=box];
|
||||||
|
|
||||||
|
"Read context.org" -> "Yesterday review (skippable)";
|
||||||
|
"Yesterday review (skippable)" -> "Capture new items";
|
||||||
|
"Capture new items" -> "Check current state";
|
||||||
|
"Check current state" -> "Inbox processing (skippable)";
|
||||||
|
"Inbox processing (skippable)" -> "Pick focus areas";
|
||||||
|
"Pick focus areas" -> "Create short list";
|
||||||
|
"Create short list" -> "Meta check (optional)";
|
||||||
|
"Meta check (optional)" -> "Write daily journal";
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Every step marked "skippable" - offer it, but accept "let's skip that today" without question.
|
||||||
|
|
||||||
|
### 0. Read Context (Always)
|
||||||
|
Read `/home/imalison/org/planning/context.org` first. This grounds the session in what's currently going on.
|
||||||
|
|
||||||
|
### 1. Yesterday Review (Skippable)
|
||||||
|
|
||||||
|
Quick look back at the previous day. Keep it lightweight - a minute or two, not an interrogation.
|
||||||
|
|
||||||
|
**Subjective check-in:**
|
||||||
|
- "How do you feel about yesterday?" (open-ended, not demanding)
|
||||||
|
- "Anything you want to talk about - productivity or otherwise?"
|
||||||
|
|
||||||
|
**Objective stats (if wanted):**
|
||||||
|
- Completion rate: X of Y planned tasks done
|
||||||
|
- Friction conquered: total/average friction of completed tasks
|
||||||
|
- Rescheduled: N tasks bumped to today
|
||||||
|
- Effort accuracy: any tasks that took way more/less than estimated?
|
||||||
|
|
||||||
|
**Keep it encouraging:**
|
||||||
|
- Celebrate wins, especially high-friction completions
|
||||||
|
- If it was a rough day, acknowledge it without judgment
|
||||||
|
- "Yesterday was yesterday. What do we want today to look like?"
|
||||||
|
|
||||||
|
**If we haven't done this in a while:**
|
||||||
|
- "Hey, we haven't done a planning session in [X days]. No big deal - want to ease back in?"
|
||||||
|
- Don't guilt trip. Just pick up where we are.
|
||||||
|
|
||||||
|
### 2. Capture New Items
|
||||||
|
|
||||||
|
Before diving into today's state, ask: "Anything new come up that needs to be captured?"
|
||||||
|
|
||||||
|
- New tasks, ideas, commitments that surfaced since last session
|
||||||
|
- Things remembered overnight or during the day
|
||||||
|
- Add these to org before continuing
|
||||||
|
|
||||||
|
**Which capture command to use:**
|
||||||
|
- `just inbox "Task title"` - Default for new todos. Quick capture without setting properties. Items go to inbox for later triage (setting effort, friction, priority, category).
|
||||||
|
- `just capture "Task title"` - Only when we're setting effort, friction, priority, or category upfront during the planning session.
|
||||||
|
|
||||||
|
This prevents things from falling through the cracks and clears mental load before planning.
|
||||||
|
|
||||||
|
### 3. Check Current State
|
||||||
|
Ask about:
|
||||||
|
- Energy level right now (low/medium/high)
|
||||||
|
- Time available and structure of the day
|
||||||
|
- Any hard deadlines or commitments
|
||||||
|
- Mental state (scattered? focused? anxious?)
|
||||||
|
|
||||||
|
### 4. Inbox Processing (Skippable)
|
||||||
|
Process items captured to inbox since last session. These are quick captures (`just inbox`) that need triage.
|
||||||
|
|
||||||
|
**For each inbox item, decide:**
|
||||||
|
1. Is this actually actionable? (If not: delete, or convert to reference/someday)
|
||||||
|
2. Assign FRICTION and EFFORT estimates
|
||||||
|
3. Set priority if obvious
|
||||||
|
4. Schedule if it has a natural date, otherwise leave unscheduled for later prioritization
|
||||||
|
5. **IMPORTANT: Transition state from INBOX to NEXT** using `just set-state "Task title" "NEXT"`
|
||||||
|
|
||||||
|
**Process for property assignment:**
|
||||||
|
1. Both of us estimate FRICTION and EFFORT
|
||||||
|
2. Use Ivan's values unless we differ by 2+ points
|
||||||
|
3. If discrepancy >= 2, discuss: "I estimated this as [X] because [reason] - what makes you see it as [Y]?"
|
||||||
|
|
||||||
|
**Why this matters:** Items sitting in inbox create mental overhead. Regular processing keeps the system trustworthy.
|
||||||
|
|
||||||
|
### 5. Pick Focus Areas
|
||||||
|
Based on energy and context, choose what *types* of work to tackle:
|
||||||
|
- High friction tasks (if energy supports it)
|
||||||
|
- Quick wins (if need momentum)
|
||||||
|
- Deep work (if have focus time)
|
||||||
|
- Admin/shallow work (if low energy)
|
||||||
|
|
||||||
|
### 6. Create Short List
|
||||||
|
Curate 3-5 tasks that match the day's reality. Not a full dump - a focused list.
|
||||||
|
|
||||||
|
### 7. Meta Check (Optional)
|
||||||
|
Occasionally (weekly-ish, or when it feels right), ask:
|
||||||
|
- "Is this planning process working for you?"
|
||||||
|
- "Anything we should change about how we do this?"
|
||||||
|
- "Are the FRICTION/EFFORT scales making sense?"
|
||||||
|
|
||||||
|
This is how we iterate on the system itself.
|
||||||
|
|
||||||
|
## Task Properties
|
||||||
|
|
||||||
|
Store in org properties drawer via `just update` with a `properties` field in the JSON body.
|
||||||
|
|
||||||
|
### FRICTION (0-5)
|
||||||
|
Psychological resistance / avoidance tendency / decision paralysis factor.
|
||||||
|
|
||||||
|
| Value | Meaning |
|
||||||
|
|-------|---------|
|
||||||
|
| 0 | No friction - could start right now |
|
||||||
|
| 1 | Minimal - minor reluctance |
|
||||||
|
| 2 | Some - need to push a bit |
|
||||||
|
| 3 | Moderate - will procrastinate without intention |
|
||||||
|
| 4 | High - significant avoidance |
|
||||||
|
| 5 | Maximum - dread/paralysis |
|
||||||
|
|
||||||
|
### EFFORT (Fibonacci: 1, 2, 3, 5, 8)
|
||||||
|
Time/energy investment. Store as number, discuss as t-shirt size.
|
||||||
|
|
||||||
|
| Number | T-shirt | Meaning |
|
||||||
|
|--------|---------|---------|
|
||||||
|
| 1 | XS | Trivial, <30min |
|
||||||
|
| 2 | S | Small, ~1-2h |
|
||||||
|
| 3 | M | Medium, half-day |
|
||||||
|
| 5 | L | Large, full day |
|
||||||
|
| 8 | XL | Multi-day effort |
|
||||||
|
|
||||||
|
### Setting Properties
|
||||||
|
```bash
|
||||||
|
just update '{"title": "Task name", "properties": {"FRICTION": "3", "EFFORT": "5"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Priority Framework
|
||||||
|
|
||||||
|
When helping decide what to work on, weigh these factors:
|
||||||
|
|
||||||
|
1. **Energy/context match**: Does current energy support this task's friction level?
|
||||||
|
2. **Deadlines**: What's due soon or has external pressure?
|
||||||
|
3. **Impact**: What moves the needle most?
|
||||||
|
|
||||||
|
High-friction + high-impact tasks need the right conditions. Don't push these when energy is low.
|
||||||
|
|
||||||
|
## Handling Avoidance
|
||||||
|
|
||||||
|
**Be direct.** Ivan wants honest feedback.
|
||||||
|
|
||||||
|
When noticing avoidance patterns:
|
||||||
|
- "You've rescheduled X three times now. What's making this hard?"
|
||||||
|
- "This has been on your list for two weeks. Let's talk about what's blocking it."
|
||||||
|
- "I notice you keep picking small tasks over [big important thing]. What would make that more approachable?"
|
||||||
|
|
||||||
|
**Use data:**
|
||||||
|
- Look at scheduling history via `just agenda-day YYYY-MM-DD`
|
||||||
|
- Track how long tasks have been scheduled
|
||||||
|
- Notice patterns in what gets done vs. avoided
|
||||||
|
|
||||||
|
## Coaching Stance
|
||||||
|
|
||||||
|
**Do:**
|
||||||
|
- Ask "what's making this hard?" not "why haven't you done this?"
|
||||||
|
- Offer to break down high-friction tasks into smaller steps
|
||||||
|
- Notice and celebrate progress, especially on hard things
|
||||||
|
- Be honest about patterns you see
|
||||||
|
|
||||||
|
**Don't:**
|
||||||
|
- Overwhelm with too many decisions at once
|
||||||
|
- Push high-friction tasks when energy is clearly low
|
||||||
|
- Judge - observe and inquire instead
|
||||||
|
- Let things slide without comment (directness is wanted)
|
||||||
|
|
||||||
|
## Red Flags to Watch For
|
||||||
|
|
||||||
|
- Same task rescheduled 3+ times
|
||||||
|
- Consistently avoiding a category of work
|
||||||
|
- Taking on new commitments while existing ones slip
|
||||||
|
- Only doing low-friction tasks day after day
|
||||||
|
- Overcommitting (too many items scheduled for one day)
|
||||||
|
|
||||||
|
When you see these: name it directly and explore what's going on.
|
||||||
|
|
||||||
|
## Mid-Day Check-ins
|
||||||
|
|
||||||
|
These can happen impromptu - not every day, just when useful.
|
||||||
|
|
||||||
|
**When to offer:**
|
||||||
|
- If morning plan isn't working out
|
||||||
|
- Energy shifted significantly
|
||||||
|
- Got stuck or derailed
|
||||||
|
- Finished the short list early
|
||||||
|
|
||||||
|
**Keep it brief:**
|
||||||
|
- "How's it going with [today's focus]?"
|
||||||
|
- "Want to adjust the plan for the afternoon?"
|
||||||
|
- "Anything blocking you right now?"
|
||||||
|
|
||||||
|
## Metrics We Track
|
||||||
|
|
||||||
|
For the daily review, pull these from the API:
|
||||||
|
|
||||||
|
| Metric | How to calculate | Why it matters |
|
||||||
|
|--------|------------------|----------------|
|
||||||
|
| Completion rate | completed / planned for day | Overall follow-through |
|
||||||
|
| Friction conquered | sum of FRICTION on completed tasks | Are we tackling hard things? |
|
||||||
|
| Rescheduling count | tasks that moved from yesterday to today | Chronic rescheduling = avoidance |
|
||||||
|
| Effort accuracy | compare EFFORT estimate vs actual | Calibrate future estimates |
|
||||||
|
|
||||||
|
**Don't obsess over numbers.** They're conversation starters, not report cards.
|
||||||
|
|
||||||
|
## Queries for Planning
|
||||||
|
|
||||||
|
Use the `just` commands in `/home/imalison/org/justfile` for all API interactions.
|
||||||
|
|
||||||
|
**Tasks needing property assignment:**
|
||||||
|
```bash
|
||||||
|
just todos # Get all todos, filter for missing FRICTION or EFFORT in properties
|
||||||
|
```
|
||||||
|
|
||||||
|
**Today's agenda (including overdue):**
|
||||||
|
```bash
|
||||||
|
just agenda-overdue # Use this for planning - shows today + all overdue items
|
||||||
|
just agenda # Only today's scheduled items (misses overdue tasks)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** Always use `agenda-overdue` during planning sessions to see the full picture of what needs attention.
|
||||||
|
|
||||||
|
**Agenda for specific date:**
|
||||||
|
```bash
|
||||||
|
just agenda-day 2026-01-20
|
||||||
|
```
|
||||||
|
|
||||||
|
**Completed items for a specific date:**
|
||||||
|
```bash
|
||||||
|
just completed 2026-01-22 # Get items completed on a specific date
|
||||||
|
just completed-today # Get items completed today
|
||||||
|
```
|
||||||
|
|
||||||
|
**This week's agenda:**
|
||||||
|
```bash
|
||||||
|
just agenda-week
|
||||||
|
```
|
||||||
|
|
||||||
|
**Overdue/rescheduled items:**
|
||||||
|
```bash
|
||||||
|
just agenda-overdue
|
||||||
|
```
|
||||||
|
|
||||||
|
**Capture new items:**
|
||||||
|
```bash
|
||||||
|
just inbox "New task title" # Quick capture to inbox (default)
|
||||||
|
just capture "Task title" "2026-01-22" # With scheduling
|
||||||
|
```
|
||||||
|
|
||||||
|
**Update task properties:**
|
||||||
|
```bash
|
||||||
|
just update '{"title": "Task name", "properties": {"FRICTION": "3", "EFFORT": "5"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Reschedule a task:**
|
||||||
|
```bash
|
||||||
|
just reschedule "Task title" "2026-01-25"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Complete a task:**
|
||||||
|
```bash
|
||||||
|
just complete "Task title"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Change task state (e.g., INBOX -> NEXT):**
|
||||||
|
```bash
|
||||||
|
just set-state "Task title" "NEXT"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Daily Journal Template
|
||||||
|
|
||||||
|
Create `/home/imalison/org/planning/dailies/YYYY-MM-DD.org` for each session:
|
||||||
|
|
||||||
|
```org
|
||||||
|
#+TITLE: Planning - YYYY-MM-DD
|
||||||
|
#+DATE: [YYYY-MM-DD Day]
|
||||||
|
|
||||||
|
* Yesterday Review
|
||||||
|
** Stats
|
||||||
|
| Metric | Value |
|
||||||
|
|-------------+-------|
|
||||||
|
| Planned | N |
|
||||||
|
| Completed | N |
|
||||||
|
| Rate | N% |
|
||||||
|
| Friction | N |
|
||||||
|
| Rescheduled | N |
|
||||||
|
|
||||||
|
** Reflection
|
||||||
|
[How Ivan felt about yesterday, anything discussed]
|
||||||
|
|
||||||
|
* Today's Context
|
||||||
|
- Energy: [low/medium/high]
|
||||||
|
- Available time: [description]
|
||||||
|
- Mental state: [notes]
|
||||||
|
|
||||||
|
* Focus Areas
|
||||||
|
- [What types of work we're tackling today]
|
||||||
|
|
||||||
|
* Today's Short List
|
||||||
|
Use org ID links to reference tasks - don't duplicate task definitions here.
|
||||||
|
- [[id:uuid-here][Task 1 title]]
|
||||||
|
- [[id:uuid-here][Task 2 title]]
|
||||||
|
- [[id:uuid-here][Task 3 title]]
|
||||||
|
|
||||||
|
* Notes
|
||||||
|
[Anything else from the session]
|
||||||
|
|
||||||
|
* End of Day (optional)
|
||||||
|
[If we do an evening check-in]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Also add row to** `/home/imalison/org/planning/stats.org` Daily Log table.
|
||||||
|
|
||||||
|
## Updating Context File
|
||||||
|
|
||||||
|
Update `/home/imalison/org/planning/context.org` when:
|
||||||
|
- Ivan mentions a new goal or project
|
||||||
|
- We notice a recurring pattern
|
||||||
|
- Something significant changes in life/work
|
||||||
|
- We discover what helps or doesn't help
|
||||||
|
- The meta check reveals process adjustments
|
||||||
|
|
||||||
|
Don't ask permission to update it - just do it and mention what changed.
|
||||||
1
dotfiles/codex/skills
Symbolic link
1
dotfiles/codex/skills
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../agents/skills
|
||||||
Reference in New Issue
Block a user