Skip to content

Commit 607f75d

Browse files
committed
Add CLI documentation to website
1 parent e4a0343 commit 607f75d

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

public/index.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,28 @@ <h3>Available Tools</h3>
810810
</section>
811811

812812

813+
<section id="cli">
814+
<header>
815+
<h2>CLI Usage</h2>
816+
<p>
817+
Sosumi also provides a CLI that complements MCP.
818+
Run it directly with <code>npx</code>:
819+
</p>
820+
<pre><code>npx @nshipster/sosumi fetch https://developer.apple.com/documentation/swift/array</code></pre>
821+
<p>If you use it regularly, install it once:</p>
822+
<pre><code>npm i -g @nshipster/sosumi</code></pre>
823+
<p>Then use <code>sosumi</code> directly:</p>
824+
<pre><code>sosumi fetch /documentation/swift/array
825+
sosumi search "SwiftData"
826+
sosumi serve --port 8787</code></pre>
827+
<p>
828+
By default, output is plain text / Markdown.
829+
Add <code>--json</code> for scripts.
830+
</p>
831+
</header>
832+
</section>
833+
834+
813835
<div class="troubleshooting">
814836
<h3>Troubleshooting</h3>
815837
<p>

public/llms.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,36 @@ you can run this command to proxy over stdio:
131131
- Parameters: `url` (string) - External URL (e.g., `https://apple.github.io/swift-argument-parser/documentation/argumentparser`)
132132
- Returns content as Markdown
133133

134+
## CLI Usage
135+
136+
Sosumi also provides a CLI that complements MCP:
137+
138+
```bash
139+
npx @nshipster/sosumi fetch https://developer.apple.com/documentation/swift/array
140+
```
141+
142+
If you use it regularly, install once:
143+
144+
```bash
145+
npm i -g @nshipster/sosumi
146+
```
147+
148+
Then use `sosumi` directly:
149+
150+
```bash
151+
sosumi fetch /documentation/swift/array
152+
sosumi search "SwiftData"
153+
sosumi serve --port 8787
154+
```
155+
156+
By default, output is plain text / Markdown.
157+
Use JSON output for scripts:
158+
159+
```bash
160+
sosumi fetch https://developer.apple.com/documentation/swift/array --json
161+
sosumi search "SwiftData" --json
162+
```
163+
134164
## Troubleshooting
135165

136166
If you're experiencing connection timeouts or network issues with the MCP server,

0 commit comments

Comments
 (0)