Skip to content

Commit 62b9ceb

Browse files
committed
Add npx quick start to README
1 parent 7731db2 commit 62b9ceb

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,39 @@ Works with **Claude Code/Desktop**, **VS Code**, **Cursor**, **Zed**, **Amazon Q
88

99
Transform config files, translate platform CLI commands, or pipe JSON directly - we've got you covered.
1010

11+
## Quick start
12+
13+
No install needed — just run with `npx`:
14+
15+
```bash
16+
# Fix a config file
17+
npx @operatorkit/mcp2win --write claude_desktop_config.json
18+
19+
# Translate a CLI command
20+
npx @operatorkit/mcp2win claude mcp add github-server -- npx -y @modelcontextprotocol/server-github
21+
22+
# Convert inline JSON
23+
npx @operatorkit/mcp2win '{"command":"npx","args":["-y","@pkg"]}'
24+
```
25+
1126
## Install
1227

28+
If you use it often, install globally:
29+
1330
```bash
14-
# npm (recommended for MCP users)
1531
npm i -g @operatorkit/mcp2win
1632

17-
# scoop (Windows)
18-
scoop bucket add operator-kit https://github.com/operator-kit/scoop-bucket
19-
scoop install mcp2win
20-
21-
# go
33+
# or with go
2234
go install github.com/operator-kit/mcp2win/cmd/mcp2win@latest
2335

24-
# or download from GitHub Releases
36+
# or download a binary from GitHub Releases
2537
```
2638

2739
## Usage
2840

29-
### Mode 1: CLI command translation
41+
### CLI command translation
3042

31-
Translate a provider's `mcp add` command to its Windows equivalent:
43+
Paste any provider's `mcp add` command and get the Windows version:
3244

3345
```bash
3446
# Claude
@@ -45,7 +57,7 @@ mcp2win qchat mcp add -- npx -y @pkg
4557
mcp2win gemini mcp add fetch-server -- npx -y @pkg
4658
```
4759

48-
### Mode 2: JSON conversion
60+
### JSON conversion
4961

5062
Transform inline JSON or pipe from stdin:
5163

@@ -60,7 +72,7 @@ cat claude_desktop_config.json | mcp2win
6072
mcp2win '{"mcpServers":{"s1":{"command":"npx","args":["-y","@pkg"]}}}'
6173
```
6274

63-
### Mode 3: File transformation
75+
### File transformation
6476

6577
```bash
6678
# Preview changes (default)

0 commit comments

Comments
 (0)