@ianyian/myskills 0.2.0 → 0.2.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.
- package/README.md +23 -61
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,35 +1,18 @@
|
|
|
1
1
|
# @ianyian/myskills
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Portable AI skills for VS Code Copilot Agent mode:
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
-
|
|
7
|
-
-
|
|
5
|
+
- **repo-explorer** - creates a repository architecture and onboarding guide.
|
|
6
|
+
- **research-brief** - creates a concise research brief with citations.
|
|
7
|
+
- **idea-to-execution** - turns an idea into an implementation plan.
|
|
8
8
|
|
|
9
9
|
Repository: <https://github.com/ianyian/mySKILLs>
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Use in a project
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
- VS Code with GitHub Copilot Agent mode, or another agent that supports `.github/skills/*/SKILL.md`
|
|
13
|
+
Requirements: Node.js 18+ and VS Code with GitHub Copilot Agent mode.
|
|
15
14
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
## Install and configure
|
|
19
|
-
|
|
20
|
-
Run without installing:
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
npx @ianyian/myskills --help
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Or install globally:
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm install --global @ianyian/myskills
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Install the skills into the project you have open in VS Code:
|
|
15
|
+
From the project folder, run:
|
|
33
16
|
|
|
34
17
|
```bash
|
|
35
18
|
npx @ianyian/myskills@latest init
|
|
@@ -44,41 +27,23 @@ This creates:
|
|
|
44
27
|
└── idea-to-execution/SKILL.md
|
|
45
28
|
```
|
|
46
29
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
npx @ianyian/myskills@latest init --force
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Use the skills with VS Code Agent mode
|
|
54
|
-
|
|
55
|
-
Open the project in VS Code, start GitHub Copilot Chat in Agent mode, and ask naturally:
|
|
30
|
+
Then open Copilot Chat in Agent mode and ask:
|
|
56
31
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
Create a repository onboarding guide using the repo-explorer skill.
|
|
32
|
+
```text
|
|
33
|
+
Use the repo-explorer skill to create an onboarding guide for this repository.
|
|
61
34
|
```
|
|
62
35
|
|
|
63
|
-
|
|
36
|
+
The other skills can be used with requests such as:
|
|
64
37
|
|
|
65
|
-
```
|
|
38
|
+
```text
|
|
66
39
|
Use the research-brief skill to compare PostgreSQL and MongoDB, with citations.
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
40
|
Use the idea-to-execution skill to plan dark mode for this web application.
|
|
71
41
|
```
|
|
72
42
|
|
|
73
|
-
The agent
|
|
74
|
-
|
|
75
|
-
## Optional standalone CLI mode
|
|
76
|
-
|
|
77
|
-
The original commands remain available for users who want this package to call an OpenAI-compatible model directly. This mode requires `OPENAI_API_KEY`:
|
|
43
|
+
The agent creates the requested Markdown artifacts in your project. Use `--force` to replace existing skill files:
|
|
78
44
|
|
|
79
45
|
```bash
|
|
80
|
-
|
|
81
|
-
npx @ianyian/myskills repo-explorer .
|
|
46
|
+
npx @ianyian/myskills@latest init --force
|
|
82
47
|
```
|
|
83
48
|
|
|
84
49
|
## Development
|
|
@@ -89,19 +54,16 @@ npm test
|
|
|
89
54
|
npm pack --dry-run
|
|
90
55
|
```
|
|
91
56
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
## Publish
|
|
57
|
+
## Automated npm publishing
|
|
95
58
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
npm login
|
|
100
|
-
npm publish --access public
|
|
101
|
-
```
|
|
59
|
+
Publishing runs automatically after a pull request is merged into `main`.
|
|
102
60
|
|
|
103
|
-
|
|
61
|
+
1. In npm package settings, configure a **Trusted Publisher** for GitHub Actions with owner `ianyian`, repository `mySKILLs`, workflow filename `publish.yml`, and no environment. The filename is case-sensitive and must be the filename only, not the `.github/workflows/` path.
|
|
62
|
+
2. Merge a pull request into `main`.
|
|
63
|
+
3. GitHub Actions runs `npm test`.
|
|
64
|
+
4. If the version already exists on npm, the workflow increments the patch version.
|
|
65
|
+
5. GitHub publishes the package with OIDC provenance, then commits the new version to `main`.
|
|
104
66
|
|
|
105
|
-
|
|
67
|
+
The workflow uses npm 11.5.1 for Trusted Publishing, ignores its own release commit, and creates one npm release per merge. Published npm versions are immutable. Manual releases require a version bump before `npm publish`.
|
|
106
68
|
|
|
107
|
-
The
|
|
69
|
+
The normal Agent Skills workflow does not require an API key. The package also retains an optional standalone CLI mode for OpenAI-compatible providers, which requires `OPENAI_API_KEY`.
|