apple-docs 1.0.1 → 1.0.5

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 CHANGED
@@ -16,7 +16,9 @@ Or run directly:
16
16
  npx apple-docs search "SwiftUI List"
17
17
  ```
18
18
 
19
- ### Claude Code Skill
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
  ```
@@ -104,10 +108,19 @@ apple-docs updates --technology SwiftUI --year 2025
104
108
  apple-docs overviews --platform ios
105
109
  ```
106
110
 
111
+ ### Version
112
+
113
+ ```bash
114
+ apple-docs version
115
+ apple-docs --version
116
+ apple-docs -v
117
+ ```
118
+
107
119
  ## Flags
108
120
 
109
121
  | Flag | Description |
110
122
  |------|-------------|
123
+ | `--version`, `-v` | Show current version |
111
124
  | `--type <type>` | Symbol/search type filter (class, struct, enum, protocol) |
112
125
  | `--limit <n>` | Max results |
113
126
  | `--year <year>` | Year filter |
package/dist/cli.js CHANGED
@@ -1,6 +1,13 @@
1
1
  #!/usr/bin/env node
2
+ import { createRequire } from 'node:module';
2
3
  import { callTool } from './mcp.js';
4
+ const require = createRequire(import.meta.url);
5
+ const { version } = require('../package.json');
3
6
  const [, , command, ...rest] = process.argv;
7
+ if (command === '--version' || command === '-v' || command === 'version') {
8
+ console.log(version);
9
+ process.exit(0);
10
+ }
4
11
  function parseArgs(argv) {
5
12
  const positional = [];
6
13
  const flags = {};
@@ -25,6 +32,7 @@ const num = (key) => flags[key] ? parseInt(flags[key], 10) : undefined;
25
32
  const HELP = `Usage: apple-docs <command> [args] [--flags]
26
33
 
27
34
  Commands:
35
+ version Show current version
28
36
  search <query> Search Apple documentation
29
37
  doc <url> Get documentation content
30
38
  tech [category] List Apple technologies
@@ -53,7 +61,8 @@ Flags:
53
61
  --query <q> Search query filter
54
62
  --technology <t> Technology filter
55
63
  --language <lang> Language filter (swift, occ)
56
- --depth <d> Search depth (shallow, medium, deep)`;
64
+ --depth <d> Search depth (shallow, medium, deep)
65
+ --version, -v Show version`;
57
66
  function need(val, usage) {
58
67
  if (!val) {
59
68
  console.error(usage);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "apple-docs",
3
- "version": "1.0.1",
3
+ "version": "1.0.5",
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,80 @@
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 version # Show current version
43
+ apple-docs search <query> # Search Apple documentation
44
+ apple-docs doc <url> # Get full doc page content
45
+ apple-docs tech [category] # List Apple technologies/frameworks
46
+ apple-docs symbols <framework> # Browse framework symbols (--type class|struct|enum|protocol)
47
+ apple-docs wwdc [year] # Browse WWDC videos
48
+ apple-docs wwdc-search <query> # Search WWDC transcripts & code
49
+ apple-docs wwdc-video <year> <id> # Get WWDC video transcript + code
50
+ apple-docs wwdc-code [framework] # Get WWDC code examples
51
+ apple-docs wwdc-topics [topicId] # Browse WWDC topics
52
+ apple-docs wwdc-years # List available WWDC years
53
+ apple-docs sample [query] # Browse sample code
54
+ apple-docs related <url> # Find related APIs
55
+ apple-docs similar <url> # Find similar/alternative APIs
56
+ apple-docs platform <url> # Check platform compatibility
57
+ apple-docs updates [category] # Documentation updates
58
+ apple-docs overviews [category] # Technology overviews
59
+ apple-docs references <url> # Resolve API references
60
+ ```
61
+
62
+ ## Flags
63
+
64
+ - `--type <type>` — Symbol type filter (class, struct, enum, protocol)
65
+ - `--limit <n>` — Max results
66
+ - `--year <year>` — Year filter
67
+ - `--framework <fw>` — Framework filter
68
+ - `--topic <topic>` — Topic filter
69
+ - `--platform <p>` — Platform filter (ios, macos, watchos, tvos, visionos)
70
+ - `--language <lang>` — Language filter (swift, occ)
71
+ - `--depth <d>` — Search depth (shallow, medium, deep)
72
+
73
+ ## Tips
74
+
75
+ - Start with `search` for general questions
76
+ - Use `doc <url>` to get full details on a specific API found in search results
77
+ - Use `symbols <framework> --type <type>` to find specific classes/structs/protocols
78
+ - Use `platform <url>` to check OS version requirements
79
+ - Use `wwdc-search` to find implementation guidance from WWDC talks
80
+ - Chain commands when needed: search → doc → related