@gobing-ai/superskill 0.2.19 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,104 +0,0 @@
1
- ---
2
- name: <!-- NAME -->
3
- # Description rules: front-load the leading identity phrase; one trigger per genuine
4
- # branch (collapse synonym triggers into one); never restate the body's identity line.
5
- description: <!-- DESCRIPTION -->
6
- license: Apache-2.0
7
- metadata:
8
- author: "[author]"
9
- version: "1.0"
10
- platforms: "claude-code,codex,openclaw,opencode,antigravity"
11
- ---
12
-
13
- # <!-- NAME -->
14
-
15
- <!-- DESCRIPTION -->
16
-
17
- ## Overview
18
-
19
- This skill provides a reference lookup for API details, configuration keys, command flags, and technical specifications. Use it to verify facts before generating code or making claims.
20
-
21
- ## When to use
22
-
23
- Use this skill when you need to:
24
-
25
- - Look up an API signature, flag, or configuration key before using it
26
- - Verify version-specific behavior of a library or tool
27
- - Cross-check a claim against authoritative documentation
28
- - Find the correct syntax for a command or configuration
29
- - Validate that a field, option, or path exists before referencing it
30
-
31
- ## Quick reference
32
-
33
- | Category | Item | Description |
34
- |----------|------|-------------|
35
- | Commands | `scaffold <name>` | Create new content from a template |
36
- | Commands | `evaluate <name>` | Score content quality (0.0–1.0) |
37
- | Commands | `validate <name>` | Structural + schema validation |
38
- | Flags | `--template <tier>` | Select a template tier |
39
- | Flags | `--target <agent>` | Target agent platform |
40
- | Flags | `--force` | Overwrite existing files |
41
- | Flags | `--json` | Machine-readable output |
42
-
43
- ## Detailed reference
44
-
45
- ### Commands
46
-
47
- #### scaffold
48
-
49
- Creates a new content file from a resolved template. For the skill type, writes `<name>/SKILL.md` inside a directory; all other types write flat `<name>.md`.
50
-
51
- ```bash
52
- superskill skill scaffold my-skill --description "A test skill"
53
- ```
54
-
55
- #### evaluate
56
-
57
- Scores content quality across 5 dimensions: completeness, clarity, trigger-accuracy, anti-hallucination, and conciseness. Returns an aggregate score (0.0–1.0) with per-dimension findings.
58
-
59
- ```bash
60
- superskill skill evaluate my-skill
61
- ```
62
-
63
- #### validate
64
-
65
- Structural and schema validation. Checks frontmatter fields, body structure, link integrity, and format compliance. Use `--strict` for all optional checks.
66
-
67
- ```bash
68
- superskill skill validate my-skill --strict
69
- ```
70
-
71
- ### Template tiers
72
-
73
- | Tier | Purpose | Body shape |
74
- |------|---------|------------|
75
- | `technique` | Step-by-step workflows | Workflow + steps + verification |
76
- | `pattern` | Decision frameworks | Trade-offs + principles + when-to-use |
77
- | `reference` | Lookup tables | Quick-reference + detailed docs |
78
-
79
- A freshly scaffolded skill PASSes the project's own evaluator out of the box.
80
-
81
- ## Behavior
82
-
83
- This skill acts as a **reference**: a lookup table and documentation source. When invoked, it provides authoritative information — it does not execute workflows or make decisions. Always cite this reference when answering factual questions about the system.
84
-
85
- ## Gotchas
86
-
87
- 1. **Don't guess API behavior**: Always verify against this reference before claiming how a command or flag behaves. Version-specific behavior must be cited with the version.
88
- 2. **Don't confuse template tiers**: Each tier produces a different body structure. Choose the tier that matches the skill's purpose — technique for workflows, pattern for decisions, reference for lookups.
89
- 3. **Don't skip the quick-reference table**: The table is the fastest path to an answer. If the item isn't in the table, check the detailed reference section before concluding it doesn't exist.
90
-
91
- ## Platform Notes
92
-
93
- ### Claude Code
94
-
95
- Use `$ARGUMENTS` for parameter references. Use `Skill()` for skill delegation.
96
-
97
- ### Codex / OpenClaw / OpenCode / Antigravity
98
-
99
- Run commands via Bash tool. Arguments provided in chat.
100
-
101
- ---
102
-
103
- **Template type**: reference
104
- **Purpose**: Lookup tables and documentation for quick factual reference
@@ -1,109 +0,0 @@
1
- ---
2
- name: <!-- NAME -->
3
- # Description rules: front-load the leading identity phrase; one trigger per genuine
4
- # branch (collapse synonym triggers into one); never restate the body's identity line.
5
- description: <!-- DESCRIPTION -->
6
- license: Apache-2.0
7
- metadata:
8
- author: "[author]"
9
- version: "1.0"
10
- platforms: "claude-code,codex,openclaw,opencode,antigravity"
11
- ---
12
-
13
- # <!-- NAME -->
14
-
15
- <!-- DESCRIPTION -->
16
-
17
- ## When to use
18
-
19
- Use this skill when you need to:
20
-
21
- - Execute a multi-step workflow that must produce a verified, reproducible output
22
- - Apply a project-specific procedure that should never be re-derived from scratch
23
- - Validate work against acceptance criteria before reporting completion
24
- - Cross-check intermediate results against authoritative documentation
25
- - Ensure deterministic steps across sessions, agents, and CI runs
26
-
27
- ## Workflow
28
-
29
- Follow these steps to complete the workflow. Each step must be verified before proceeding to the next.
30
-
31
- ### Step 1: Gather context
32
-
33
- Read the relevant files, configuration, and reference material. Never assume structure — verify paths exist before acting.
34
-
35
- ```bash
36
- # Example: inspect the target before modifying
37
- ls -la <target>
38
- ```
39
-
40
- ### Step 2: Plan the change
41
-
42
- Identify the files to read and modify, dependencies, and edge cases. State assumptions explicitly.
43
-
44
- ### Step 3: Execute the change
45
-
46
- Apply the change with surgical precision. Touch only what the task requires — no drive-by refactors.
47
-
48
- ### Step 4: Verify the result
49
-
50
- Validate the output against the acceptance criteria. Cite the evidence (test output, command result, or document reference) before reporting done.
51
-
52
- ## Behavior
53
-
54
- This skill acts as a **technique**: a step-by-step workflow with concrete instructions. When invoked, it executes the workflow end-to-end, verifying each step before proceeding.
55
-
56
- **Key invariants:**
57
-
58
- - Always verify before claiming completion — never report done without evidence
59
- - Cite sources for any external claim or API behavior
60
- - Validate inputs at system boundaries; trust internal code
61
-
62
- ## Code Examples
63
-
64
- ### Basic Usage
65
-
66
- ```bash
67
- # Example command showing basic usage
68
- superskill <!-- NAME --> <target>
69
- ```
70
-
71
- ### Advanced Usage
72
-
73
- ```bash
74
- # Example command with options
75
- superskill <!-- NAME --> <target> --strict --json
76
- ```
77
-
78
- ## Gotchas
79
-
80
- 1. **Don't skip verification**: Reporting done without running the verification step is the most common failure mode. Always cite the test or command output.
81
- 2. **Don't assume file structure**: Verify paths exist before reading or writing. A missing file is a blocking error, not a silent skip.
82
- 3. **Don't drift from conventions**: Match existing project patterns. If a convention seems wrong, surface it — do not silently fork the style.
83
-
84
- ## Resources (optional)
85
-
86
- Create only the resource directories this skill actually needs.
87
-
88
- ### scripts/
89
-
90
- Executable code (TypeScript/Bash) for tasks that require deterministic reliability.
91
-
92
- ### references/
93
-
94
- Documentation intended to be loaded into context as needed.
95
-
96
- ## Platform Notes
97
-
98
- ### Claude Code
99
-
100
- Use `$ARGUMENTS` for parameter references. Use `Skill()` for skill delegation.
101
-
102
- ### Codex / OpenClaw / OpenCode / Antigravity
103
-
104
- Run commands via Bash tool. Arguments provided in chat.
105
-
106
- ---
107
-
108
- **Template type**: technique
109
- **Purpose**: Step-by-step workflows with concrete instructions and verification gates