askill-cli 0.1.0

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 (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +254 -0
  3. package/dist/cli.mjs +2816 -0
  4. package/package.json +59 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 askill
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,254 @@
1
+ # askill
2
+
3
+ > The package manager for AI agent skills.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@askill/cli.svg)](https://www.npmjs.com/package/@askill/cli)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
7
+
8
+ askill is a universal package manager for AI agent skills. It enables agents to discover, install, and use skills across Claude Code, Cursor, Windsurf, and 40+ other AI coding assistants.
9
+
10
+ ## Quick Start
11
+
12
+ ```bash
13
+ # Install
14
+ npm install -g @askill/cli
15
+
16
+ # Install a skill from GitHub
17
+ askill add gh:owner/repo@skill-name
18
+
19
+ # Search for skills
20
+ askill find code review
21
+
22
+ # List installed skills
23
+ askill list
24
+ ```
25
+
26
+ ## Table of Contents
27
+
28
+ - [Installation](#installation)
29
+ - [Usage](#usage)
30
+ - [Documentation](#documentation)
31
+ - [Skills](#skills)
32
+ - [For Developers](#for-developers)
33
+ - [Project Structure](#project-structure)
34
+ - [Contributing](#contributing)
35
+ - [License](#license)
36
+
37
+ ## Installation
38
+
39
+ ### npm (recommended)
40
+
41
+ ```bash
42
+ npm install -g @askill/cli
43
+ ```
44
+
45
+ ### npx (no install)
46
+
47
+ ```bash
48
+ npx @askill/cli add @anthropic/memory
49
+ ```
50
+
51
+ ### Verify
52
+
53
+ ```bash
54
+ askill --version
55
+ ```
56
+
57
+ ## Usage
58
+
59
+ ### Install a Skill
60
+
61
+ ```bash
62
+ # From GitHub (short format)
63
+ askill add gh:facebook/react@extract-errors
64
+
65
+ # From GitHub (path format)
66
+ askill add gh:facebook/react/scripts/error-codes
67
+
68
+ # Non-interactive (for CI/agents)
69
+ askill add gh:owner/repo@skill -y
70
+ ```
71
+
72
+ ### Search Skills
73
+
74
+ ```bash
75
+ askill find memory
76
+ askill find --tag git
77
+ ```
78
+
79
+ ### List Installed Skills
80
+
81
+ ```bash
82
+ askill list
83
+ askill list -g # global only
84
+ ```
85
+
86
+ ### Run Skill Commands (Planned)
87
+
88
+ Skills can define commands. When implemented, run them with:
89
+
90
+ ```bash
91
+ askill run <skill>:<command> [args]
92
+
93
+ # Example
94
+ askill run @anthropic/memory:save --key preferences --value "dark mode"
95
+ askill run @anthropic/memory:recall --key preferences
96
+ ```
97
+
98
+ ### Remove a Skill
99
+
100
+ ```bash
101
+ askill remove @anthropic/memory
102
+ ```
103
+
104
+ ## Documentation
105
+
106
+ Complete documentation is available in the [`docs/`](./docs/) directory:
107
+
108
+ | Document | Description |
109
+ |----------|-------------|
110
+ | [Introduction](./docs/introduction.md) | What is askill and why it exists |
111
+ | [Getting Started](./docs/getting-started.md) | Quick start guide with examples |
112
+ | [SKILL.md Specification](./docs/skill-spec.md) | Complete protocol for writing skills |
113
+ | [Slug System](./docs/slug-system.md) | How skill identification works (`@scope/name` vs `gh:`) |
114
+ | [Publishing Guide](./docs/publishing.md) | How to publish your own skills |
115
+ | [CLI Reference](./docs/cli-reference.md) | Complete command documentation |
116
+ | [API Specification](./docs/api-spec.md) | REST API for askill.sh |
117
+
118
+ ### For AI Agents
119
+
120
+ If you're an AI agent trying to understand askill:
121
+
122
+ 1. **To use installed skills**: Read [`skills/@askill/agent/SKILL.md`](./skills/@askill/agent/SKILL.md)
123
+ 2. **To develop skills**: Read [`skills/@askill/developer/SKILL.md`](./skills/@askill/developer/SKILL.md)
124
+ 3. **To understand the protocol**: Read [`docs/skill-spec.md`](./docs/skill-spec.md)
125
+
126
+ ## Skills
127
+
128
+ ### Slug System
129
+
130
+ Skills are identified by slugs:
131
+
132
+ | Type | Format | Example |
133
+ |------|--------|---------|
134
+ | Published | `@scope/name` | `@anthropic/memory` |
135
+ | Indexed | `gh:owner/repo/path` | `gh:facebook/react/scripts/errors` |
136
+
137
+ Published skills are hosted on [askill.sh](https://askill.sh). Indexed skills are automatically discovered from GitHub.
138
+
139
+ ### Official Skills
140
+
141
+ | Skill | Description | Path |
142
+ |-------|-------------|------|
143
+ | `@askill/agent` | Teaches agents how to use installed skills | [`skills/@askill/agent/`](./skills/@askill/agent/SKILL.md) |
144
+ | `@askill/developer` | Teaches agents how to develop skills | [`skills/@askill/developer/`](./skills/@askill/developer/SKILL.md) |
145
+
146
+ ### SKILL.md Format
147
+
148
+ Skills are defined by a `SKILL.md` file:
149
+
150
+ ```markdown
151
+ ---
152
+ name: my-skill
153
+ description: What this skill does
154
+ version: 1.0.0
155
+ dependencies:
156
+ - @dependency/one@^1.0.0
157
+ commands:
158
+ build:
159
+ run: npm run build
160
+ description: Build the project
161
+ ---
162
+
163
+ # My Skill
164
+
165
+ Instructions for the agent...
166
+ ```
167
+
168
+ See [SKILL.md Specification](./docs/skill-spec.md) for complete details.
169
+
170
+ ## For Developers
171
+
172
+ ### Creating a Skill
173
+
174
+ 1. Create a `SKILL.md` file with frontmatter and instructions
175
+ 2. Test locally: `askill add ./my-skill`
176
+ 3. Validate: `askill validate SKILL.md` (Planned)
177
+ 4. Publish: `askill login && askill publish` (Planned)
178
+
179
+ See [Publishing Guide](./docs/publishing.md) for details.
180
+
181
+ ### Building the CLI
182
+
183
+ ```bash
184
+ # Install dependencies
185
+ npm install
186
+
187
+ # Build
188
+ npm run build
189
+
190
+ # Run locally
191
+ node dist/cli.mjs --help
192
+ ```
193
+
194
+ ## Project Structure
195
+
196
+ ```
197
+ askill/
198
+ ├── src/ # CLI source code
199
+ │ ├── cli.ts # Main entry point
200
+ │ ├── api.ts # API client
201
+ │ ├── installer.ts # Skill installation
202
+ │ ├── config.ts # User preferences
203
+ │ ├── updater.ts # Self-update
204
+ │ └── constants.ts # Config and agent definitions
205
+ ├── docs/ # Documentation
206
+ │ ├── introduction.md # Overview
207
+ │ ├── getting-started.md # Quick start
208
+ │ ├── skill-spec.md # SKILL.md protocol
209
+ │ ├── slug-system.md # Slug identification
210
+ │ ├── publishing.md # Publishing guide
211
+ │ ├── cli-reference.md # CLI commands
212
+ │ └── api-spec.md # REST API spec
213
+ ├── skills/ # Official skills
214
+ │ └── @askill/
215
+ │ ├── agent/ # For using skills
216
+ │ └── developer/ # For creating skills
217
+ ├── package.json
218
+ ├── tsconfig.json
219
+ └── README.md
220
+ ```
221
+
222
+ ## Related Projects
223
+
224
+ | Project | Description | Repository |
225
+ |---------|-------------|------------|
226
+ | askill (this repo) | CLI and documentation | [avibe-bot/askill](https://github.com/avibe-bot/askill) |
227
+ | askill-registry | Web platform and API | [avibe-bot/askill-registry](https://github.com/avibe-bot/askill-registry) |
228
+
229
+ ## Contributing
230
+
231
+ Contributions are welcome! Please read our contributing guidelines before submitting PRs.
232
+
233
+ ### Development Setup
234
+
235
+ ```bash
236
+ git clone https://github.com/avibe-bot/askill.git
237
+ cd askill
238
+ npm install
239
+ npm run build
240
+ ```
241
+
242
+ ### Running Tests
243
+
244
+ ```bash
245
+ npm test
246
+ ```
247
+
248
+ ## License
249
+
250
+ MIT License - see [LICENSE](./LICENSE) for details.
251
+
252
+ ---
253
+
254
+ **Website**: [askill.sh](https://askill.sh) | **npm**: [@askill/cli](https://www.npmjs.com/package/@askill/cli)