apple-docs 1.0.1 → 1.0.2
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 +5 -1
- package/package.json +3 -2
- package/skills/apple-docs/SKILL.md +79 -0
package/README.md
CHANGED
|
@@ -16,7 +16,9 @@ Or run directly:
|
|
|
16
16
|
npx apple-docs search "SwiftUI List"
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
## Agent Skill
|
|
20
|
+
|
|
21
|
+
Install as a skill for Claude Code, Cursor, Windsurf, and 40+ other AI agents:
|
|
20
22
|
|
|
21
23
|
```bash
|
|
22
24
|
npx skills add mtcnbzks/apple-docs-cli
|
|
@@ -24,6 +26,8 @@ npx skills add mtcnbzks/apple-docs-cli
|
|
|
24
26
|
|
|
25
27
|
Then use `/apple-docs` in Claude Code to query Apple documentation.
|
|
26
28
|
|
|
29
|
+
Browse on [skills.sh](https://skills.sh) or learn more about the [skills ecosystem](https://github.com/vercel-labs/skills).
|
|
30
|
+
|
|
27
31
|
## Usage
|
|
28
32
|
|
|
29
33
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "apple-docs",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "CLI for querying Apple Developer Documentation — search docs, browse frameworks, WWDC videos, sample code, and API analysis",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "mtcnbzks",
|
|
@@ -34,7 +34,8 @@
|
|
|
34
34
|
"prepublishOnly": "npm run build"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
|
37
|
-
"dist"
|
|
37
|
+
"dist",
|
|
38
|
+
"skills"
|
|
38
39
|
],
|
|
39
40
|
"dependencies": {
|
|
40
41
|
"@kimsungwhee/apple-docs-mcp": "^1.0.26"
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: apple-docs
|
|
3
|
+
description: Search Apple Developer Documentation — APIs, frameworks, WWDC videos, sample code, and platform compatibility. Uses the apple-docs CLI to fetch real-time data from developer.apple.com.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# apple-docs
|
|
7
|
+
|
|
8
|
+
Query Apple Developer Documentation from the command line. Provides real-time access to API docs, framework symbols, WWDC video transcripts and code examples, sample code, and platform compatibility info.
|
|
9
|
+
|
|
10
|
+
## When to use
|
|
11
|
+
|
|
12
|
+
- When you need up-to-date Apple API documentation (SwiftUI, UIKit, Foundation, etc.)
|
|
13
|
+
- When checking platform availability or minimum OS versions
|
|
14
|
+
- When looking for WWDC session content, transcripts, or code examples
|
|
15
|
+
- When exploring framework symbols (classes, structs, protocols, enums)
|
|
16
|
+
- When finding sample code from Apple
|
|
17
|
+
- When discovering related or alternative APIs
|
|
18
|
+
|
|
19
|
+
## Setup
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx apple-docs search "SwiftUI"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or install globally:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm i -g apple-docs
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Instructions
|
|
32
|
+
|
|
33
|
+
Based on the user's question: $ARGUMENTS
|
|
34
|
+
|
|
35
|
+
1. Determine which `apple-docs` command(s) best answer the question
|
|
36
|
+
2. Run them using the Bash tool
|
|
37
|
+
3. Present the results concisely, focusing on what the user needs
|
|
38
|
+
|
|
39
|
+
## Commands
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
apple-docs search <query> # Search Apple documentation
|
|
43
|
+
apple-docs doc <url> # Get full doc page content
|
|
44
|
+
apple-docs tech [category] # List Apple technologies/frameworks
|
|
45
|
+
apple-docs symbols <framework> # Browse framework symbols (--type class|struct|enum|protocol)
|
|
46
|
+
apple-docs wwdc [year] # Browse WWDC videos
|
|
47
|
+
apple-docs wwdc-search <query> # Search WWDC transcripts & code
|
|
48
|
+
apple-docs wwdc-video <year> <id> # Get WWDC video transcript + code
|
|
49
|
+
apple-docs wwdc-code [framework] # Get WWDC code examples
|
|
50
|
+
apple-docs wwdc-topics [topicId] # Browse WWDC topics
|
|
51
|
+
apple-docs wwdc-years # List available WWDC years
|
|
52
|
+
apple-docs sample [query] # Browse sample code
|
|
53
|
+
apple-docs related <url> # Find related APIs
|
|
54
|
+
apple-docs similar <url> # Find similar/alternative APIs
|
|
55
|
+
apple-docs platform <url> # Check platform compatibility
|
|
56
|
+
apple-docs updates [category] # Documentation updates
|
|
57
|
+
apple-docs overviews [category] # Technology overviews
|
|
58
|
+
apple-docs references <url> # Resolve API references
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Flags
|
|
62
|
+
|
|
63
|
+
- `--type <type>` — Symbol type filter (class, struct, enum, protocol)
|
|
64
|
+
- `--limit <n>` — Max results
|
|
65
|
+
- `--year <year>` — Year filter
|
|
66
|
+
- `--framework <fw>` — Framework filter
|
|
67
|
+
- `--topic <topic>` — Topic filter
|
|
68
|
+
- `--platform <p>` — Platform filter (ios, macos, watchos, tvos, visionos)
|
|
69
|
+
- `--language <lang>` — Language filter (swift, occ)
|
|
70
|
+
- `--depth <d>` — Search depth (shallow, medium, deep)
|
|
71
|
+
|
|
72
|
+
## Tips
|
|
73
|
+
|
|
74
|
+
- Start with `search` for general questions
|
|
75
|
+
- Use `doc <url>` to get full details on a specific API found in search results
|
|
76
|
+
- Use `symbols <framework> --type <type>` to find specific classes/structs/protocols
|
|
77
|
+
- Use `platform <url>` to check OS version requirements
|
|
78
|
+
- Use `wwdc-search` to find implementation guidance from WWDC talks
|
|
79
|
+
- Chain commands when needed: search → doc → related
|