Skip to content

Commit eda0ecd

Browse files
committed
docs: add MCP client configs and binary documentation (#134, #137)
1 parent dc76e99 commit eda0ecd

File tree

54 files changed

+1532
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1532
-6
lines changed

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
## 0.9.1 (2026-01-25)
2+
3+
### Added
4+
- **MCP client configuration docs** - Added setup guides for multiple AI tools (#134, #137)
5+
- OpenAI Codex (CLI and ~/.codex/config.toml)
6+
- Cursor (.cursor/mcp.json)
7+
- VS Code with GitHub Copilot (.vscode/mcp.json)
8+
- Zed (settings.json)
9+
- Windsurf (~/.codeium/windsurf/mcp_config.json)
10+
- opencode (opencode.jsonc)
11+
- **Binary documentation** - Full docs for additional executables (#137)
12+
- cupertino-tui: Terminal UI with 5 views documented
13+
- mock-ai-agent: MCP testing tool with arguments documented
14+
- cupertino-rel: Release tool with 6 subcommands and all options
15+
- 48 new documentation files in docs/binaries/
16+
- **mock-ai-agent --version** - Added version flag support (#137)
17+
18+
---
19+
120
## 0.9.0 (2025-12-31)
221

322
### Changed

Packages/Sources/MockAIAgent/main.swift

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,18 @@ struct MockAIAgent {
1919
setbuf(stdout, nil)
2020
setbuf(stderr, nil)
2121

22+
// Handle --version flag
23+
let args = CommandLine.arguments
24+
if args.contains("--version") || args.contains("-v") {
25+
print(Shared.Constants.App.version)
26+
return
27+
}
28+
2229
print("🤖 Mock AI Agent Starting...")
2330
print("=".repeating(80))
2431
print()
2532

2633
// Parse command line arguments
27-
let args = CommandLine.arguments
2834
var serverCommand: [String]?
2935

3036
if args.count > 1 {

Packages/Sources/Shared/Constants.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ extension Shared {
156156
public static let userAgent = "CupertinoCrawler/1.0"
157157

158158
/// Current version
159-
public static let version = "0.9.0"
159+
public static let version = "0.9.1"
160160

161161
/// Database version - separate from CLI version, only bump when schema/content changes
162162
public static let databaseVersion = "0.8.2"

README.md

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,103 @@ claude mcp add cupertino --scope user -- $(which cupertino)
181181

182182
This registers Cupertino globally for all your projects. Claude Code will automatically have access to Apple documentation search.
183183

184+
### Use with OpenAI Codex
185+
186+
If you're using [OpenAI Codex](https://github.com/openai/codex), add Cupertino with:
187+
188+
```bash
189+
codex mcp add cupertino -- $(which cupertino) serve
190+
```
191+
192+
Or add directly to `~/.codex/config.toml`:
193+
194+
```toml
195+
[mcp_servers.cupertino]
196+
command = "/opt/homebrew/bin/cupertino" # Homebrew on Apple Silicon
197+
# command = "/usr/local/bin/cupertino" # Intel Mac or manual install
198+
args = ["serve"]
199+
```
200+
201+
> **Tip:** Run `which cupertino` to find your installation path.
202+
203+
### Use with Cursor
204+
205+
Add to `.cursor/mcp.json` in your project (or `~/.cursor/mcp.json` for global access):
206+
207+
```json
208+
{
209+
"mcpServers": {
210+
"cupertino": {
211+
"command": "/opt/homebrew/bin/cupertino",
212+
"args": ["serve"]
213+
}
214+
}
215+
}
216+
```
217+
218+
### Use with VS Code (GitHub Copilot)
219+
220+
Add to `.vscode/mcp.json` in your workspace:
221+
222+
```json
223+
{
224+
"servers": {
225+
"cupertino": {
226+
"type": "stdio",
227+
"command": "/opt/homebrew/bin/cupertino",
228+
"args": ["serve"]
229+
}
230+
}
231+
}
232+
```
233+
234+
### Use with Zed
235+
236+
Add to your Zed `settings.json`:
237+
238+
```json
239+
{
240+
"context_servers": {
241+
"cupertino": {
242+
"command": "/opt/homebrew/bin/cupertino",
243+
"args": ["serve"]
244+
}
245+
}
246+
}
247+
```
248+
249+
### Use with Windsurf
250+
251+
Add to `~/.codeium/windsurf/mcp_config.json`:
252+
253+
```json
254+
{
255+
"mcpServers": {
256+
"cupertino": {
257+
"command": "/opt/homebrew/bin/cupertino",
258+
"args": ["serve"]
259+
}
260+
}
261+
}
262+
```
263+
264+
### Use with opencode
265+
266+
Add to `opencode.jsonc`:
267+
268+
```json
269+
{
270+
"mcp": {
271+
"cupertino": {
272+
"type": "local",
273+
"command": ["/opt/homebrew/bin/cupertino", "serve"]
274+
}
275+
}
276+
}
277+
```
278+
279+
> **Note:** All examples use `/opt/homebrew/bin/cupertino` (Homebrew on Apple Silicon). Use `/usr/local/bin/cupertino` for Intel Macs or manual installs. Run `which cupertino` to find your path.
280+
184281
### What You Get
185282

186283
Once configured, Claude Desktop can search your local documentation:
@@ -535,7 +632,7 @@ For development setup, see [DEVELOPMENT.md](DEVELOPMENT.md).
535632

536633
## Project Status
537634

538-
**Version:** 0.9.0
635+
**Version:** 0.9.1
539636
**Status:** 🚧 Active Development
540637

541638
- ✅ All core functionality working

docs/DEPLOYMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cupertino Deployment Guide
22

3-
**Version:** 0.9.0
3+
**Version:** 0.9.1
44
**Last Updated:** 2025-12-12
55

66
This guide covers the complete release process for Cupertino.

docs/binaries/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Cupertino Binaries
2+
3+
Executable binaries included in the Cupertino package.
4+
5+
## Binaries
6+
7+
| Binary | Description |
8+
|--------|-------------|
9+
| [cupertino-tui](cupertino-tui/) | Terminal UI for browsing packages, archives, and settings |
10+
| [mock-ai-agent](mock-ai-agent/) | MCP testing tool for debugging server communication |
11+
| [cupertino-rel](cupertino-rel/) | Release automation tool (maintainers only) |
12+
13+
## Installation
14+
15+
All binaries are built when you run:
16+
17+
```bash
18+
cd Packages
19+
swift build -c release
20+
```
21+
22+
The binaries are located in `.build/release/`:
23+
- `.build/release/cupertino`
24+
- `.build/release/cupertino-tui`
25+
- `.build/release/mock-ai-agent`
26+
- `.build/release/cupertino-rel`
27+
28+
## See Also
29+
30+
- [Commands](../commands/) - Main CLI commands (`cupertino`)
31+
- [Tools](../tools/) - MCP tools provided by the server
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# cupertino-rel
2+
3+
Release automation tool for Cupertino maintainers.
4+
5+
## Synopsis
6+
7+
```bash
8+
cupertino-rel [options] [subcommand]
9+
```
10+
11+
## Options
12+
13+
| Option | Description |
14+
|--------|-------------|
15+
| [--version](option (--)/version.md) | Show version information |
16+
| -h, --help | Show help information |
17+
18+
## Description
19+
20+
Automates the complete Cupertino release workflow:
21+
22+
1. Update version in `Constants.swift`, `README.md`, `CHANGELOG.md`
23+
2. Commit version bump
24+
3. Create and push git tag
25+
4. Wait for GitHub Actions to build
26+
5. Upload databases via `cupertino release`
27+
6. Update Homebrew formula
28+
29+
## Requirements
30+
31+
- `GITHUB_TOKEN` environment variable with `repo` scope
32+
33+
## Subcommands
34+
35+
| Subcommand | Description |
36+
|------------|-------------|
37+
| `full` | Run the complete release workflow (default) |
38+
| `bump` | Bump version in all required files |
39+
| `tag` | Commit changes and create git tag |
40+
| `databases` | Package and upload databases to GitHub Releases |
41+
| `homebrew` | Update Homebrew formula with new version |
42+
| `docs-update` | Update documentation databases and bump minor version |
43+
44+
## Usage
45+
46+
### Full Release
47+
48+
```bash
49+
# Run complete release workflow (major/minor/patch)
50+
cupertino-rel full --bump-type patch
51+
cupertino-rel full --bump-type minor
52+
cupertino-rel full --bump-type major
53+
```
54+
55+
### Individual Steps
56+
57+
```bash
58+
# Bump version only
59+
cupertino-rel bump --type patch
60+
61+
# Create and push tag
62+
cupertino-rel tag
63+
64+
# Upload databases
65+
cupertino-rel databases
66+
67+
# Update Homebrew formula
68+
cupertino-rel homebrew
69+
```
70+
71+
### Documentation Update
72+
73+
```bash
74+
# Update docs databases and bump minor version
75+
cupertino-rel docs-update
76+
```
77+
78+
## Version Bump Locations
79+
80+
The `bump` command updates version in:
81+
82+
- `Sources/Shared/Constants.swift` - App version constant
83+
- `README.md` - Version badge and references
84+
- `CHANGELOG.md` - New version section
85+
86+
## See Also
87+
88+
- [DEVELOPMENT.md](../../../DEVELOPMENT.md) - Development workflow
89+
- [DEPLOYMENT.md](../DEPLOYMENT.md) - Deployment and CI/CD
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# --version
2+
3+
Show version information.
4+
5+
## Synopsis
6+
7+
```bash
8+
cupertino-rel --version
9+
```
10+
11+
## Description
12+
13+
Prints the Cupertino version and exits.
14+
15+
## Example
16+
17+
```bash
18+
$ cupertino-rel --version
19+
0.9.0
20+
```
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# cupertino-rel bump
2+
3+
Bump version in all required files.
4+
5+
## Synopsis
6+
7+
```bash
8+
cupertino-rel bump <version-or-type> [options]
9+
```
10+
11+
## Description
12+
13+
Updates the version number in:
14+
- `Sources/Shared/Constants.swift`
15+
- `README.md`
16+
- `CHANGELOG.md`
17+
18+
## Arguments
19+
20+
| Argument | Description |
21+
|----------|-------------|
22+
| [version-or-type](argument (<>)/version-or-type.md) | New version (e.g., 0.5.0) or bump type (major, minor, patch) |
23+
24+
## Options
25+
26+
| Option | Description |
27+
|--------|-------------|
28+
| [--dry-run](option (--)/dry-run.md) | Preview changes without modifying files |
29+
| [--repo-root](option (--)/repo-root.md) | Path to repository root |
30+
31+
## Examples
32+
33+
```bash
34+
cupertino-rel bump patch # 0.9.0 → 0.9.1
35+
cupertino-rel bump minor # 0.9.0 → 0.10.0
36+
cupertino-rel bump major # 0.9.0 → 1.0.0
37+
cupertino-rel bump 1.0.0 # Set exact version
38+
cupertino-rel bump patch --dry-run # Preview only
39+
```
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# <version-or-type>
2+
3+
Version or bump type argument.
4+
5+
## Synopsis
6+
7+
```bash
8+
cupertino-rel bump <version-or-type>
9+
```
10+
11+
## Description
12+
13+
Specify either an exact version number or a bump type.
14+
15+
## Values
16+
17+
| Value | Description | Example |
18+
|-------|-------------|---------|
19+
| `major` | Bump major version | 0.9.0 → 1.0.0 |
20+
| `minor` | Bump minor version | 0.9.0 → 0.10.0 |
21+
| `patch` | Bump patch version | 0.9.0 → 0.9.1 |
22+
| `X.Y.Z` | Set exact version | 0.9.0 → 1.0.0 |
23+
24+
## Examples
25+
26+
```bash
27+
cupertino-rel bump patch # Increment patch
28+
cupertino-rel bump 2.0.0 # Set to 2.0.0
29+
```

0 commit comments

Comments
 (0)