@harshitj183/ai-skills 1.0.2 → 2.0.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.
Files changed (2) hide show
  1. package/README.md +84 -11
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -65,24 +65,97 @@ Give your AI absolute technical dominance over specific frameworks.
65
65
 
66
66
  ## <img src="https://cdn.simpleicons.org/github" width="24" align="center" /> Usage Across AI Platforms
67
67
 
68
- You can natively feed this library into major LLM workspace interfaces:
68
+ Run the installer once in your project root, then configure your preferred AI tool:
69
+
70
+ ```bash
71
+ npx @harshitj183/ai-skills init
72
+ ```
73
+
74
+ This places all files inside `smart-instructions/` in your project. Your `.gitignore` is automatically updated.
75
+
76
+ ---
69
77
 
70
78
  ### <img src="https://cdn.simpleicons.org/visualstudiocode" width="18" align="center" /> 1. Cursor IDE
71
- - **Globally:** Run the `npx` command, then rename `SKILL.md` to `.cursorrules`.
72
- - **Surgically:** Type `@` in chat and select what you need.
73
- Example Prompt: *"@frontend_expert.md @react_best_practices.md implement a new dashboard navigation."*
79
+ Rename `smart-instructions/SKILL.md` to `.cursorrules` at your project root. Every Cursor chat will automatically follow the rules.
80
+ ```
81
+ mv smart-instructions/SKILL.md .cursorrules
82
+ ```
83
+ Or reference individual skills surgically:
84
+ > *"@react_best_practices.md implement a new dashboard."*
74
85
 
75
- ### <img src="https://cdn.simpleicons.org/anthropic" width="18" align="center" /> 2. Claude Code (Anthropic CLI)
76
- - Put this library in your root folder. Tell Claude Code: *"Load `SKILL.md` as your core directive."*
86
+ ---
77
87
 
78
- ### <img src="https://cdn.simpleicons.org/google" width="18" align="center" /> 3. Gemini CLI / Antigravity
79
- - Instruct the Antigravity agent: *"Read `SKILL.md` and act according to the Roles inside."*
88
+ ### <img src="https://cdn.simpleicons.org/anthropic" width="18" align="center" /> 2. Claude Code (CLI)
89
+ Claude Code auto-reads `CLAUDE.md` from your root. Copy the contents:
90
+ ```bash
91
+ cp smart-instructions/SKILL.md CLAUDE.md
92
+ ```
93
+ Or tell Claude directly: *"Read `smart-instructions/SKILL.md` as your core directive."*
94
+
95
+ ---
96
+
97
+ ### <img src="https://cdn.simpleicons.org/openai" width="18" align="center" /> 3. ChatGPT (Web / Custom GPT)
98
+ **Option A — Custom Instructions:**
99
+ - Go to Settings → Custom Instructions → paste contents of `SKILL.md`
100
+
101
+ **Option B — Project Knowledge (ChatGPT Plus):**
102
+ - Create a new Project → Upload `SKILL.md` and any skill files you need
103
+
104
+ **Option C — Chat Upload:**
105
+ - Attach `SKILL.md` directly to your conversation as a file
106
+
107
+ ---
80
108
 
81
109
  ### <img src="https://cdn.simpleicons.org/githubcopilot" width="18" align="center" /> 4. GitHub Copilot (VS Code)
82
- - Copilot chat utilizes active tabs. Keep `azure_graph_integrator.md` open in a read-only tab, and ask: *"#file:azure_graph_integrator.md build a new AD token script."*
110
+ Copy instructions to the Copilot-specific file:
111
+ ```bash
112
+ cp smart-instructions/SKILL.md .github/copilot-instructions.md
113
+ ```
114
+ Or reference in chat: *"#file:smart-instructions/react_best_practices.md refactor this component."*
115
+
116
+ ---
83
117
 
84
- ### <img src="https://cdn.simpleicons.org/openai" width="18" align="center" /> 5. ChatGPT / Claude Web (Pro)
85
- - Upload `SKILL.md` into standard "Custom Instructions" / "Project Knowledge", and attach individual mega-skill files alongside your main prompt.
118
+ ### <img src="https://cdn.simpleicons.org/google" width="18" align="center" /> 5. Gemini / Antigravity (Google)
119
+ Tell Antigravity: *"Read `smart-instructions/SKILL.md` and act according to the Roles inside."*
120
+ Antigravity automatically detects skill files in your workspace.
121
+
122
+ ---
123
+
124
+ ### <img src="https://cdn.simpleicons.org/codium" width="18" align="center" /> 6. Windsurf IDE (Codeium)
125
+ Windsurf supports `.windsurfrules` file:
126
+ ```bash
127
+ cp smart-instructions/SKILL.md .windsurfrules
128
+ ```
129
+
130
+ ---
131
+
132
+ ### <img src="https://cdn.simpleicons.org/zedindustries" width="18" align="center" /> 7. Zed Editor
133
+ Add to Zed's AI assistant context:
134
+ - Settings → Assistant → System Prompt → paste `SKILL.md` contents
135
+
136
+ ---
137
+
138
+ ### 8. Cline / Continue.dev (VS Code Extensions)
139
+ Place the skill files in `.clinerules` or `.continuerules`:
140
+ ```bash
141
+ cp smart-instructions/SKILL.md .clinerules
142
+ ```
143
+ For Continue.dev, add to `config.json` under `systemMessage`.
144
+
145
+ ---
146
+
147
+ ### 9. Aider (Terminal AI)
148
+ ```bash
149
+ aider --read smart-instructions/SKILL.md
150
+ ```
151
+
152
+ ---
153
+
154
+ ### 10. Any LLM API (OpenAI, Groq, Mistral, Llama)
155
+ Paste `SKILL.md` content as your `system` message in the API call:
156
+ ```javascript
157
+ { role: "system", content: fs.readFileSync("smart-instructions/SKILL.md", "utf8") }
158
+ ```
86
159
 
87
160
  ---
88
161
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harshitj183/ai-skills",
3
- "version": "1.0.2",
3
+ "version": "2.0.1",
4
4
  "description": "The Ultimate 17 Mega-Skills & 8 Roles Library for AI Agents (Cursor, Claude Code, Copilot, Antigravity)",
5
5
  "main": "bin/cli.js",
6
6
  "bin": {
@@ -34,9 +34,9 @@
34
34
  },
35
35
  "repository": {
36
36
  "type": "git",
37
- "url": "https://github.com/harshitj183/ai-skill.git"
37
+ "url": "https://github.com/harshitj183/ai-skills.git"
38
38
  },
39
39
  "bugs": {
40
- "url": "https://github.com/harshitj183/ai-skill/issues"
40
+ "url": "https://github.com/harshitj183/ai-skills/issues"
41
41
  }
42
- }
42
+ }