Skip to content

Commit 5c2427a

Browse files
committed
docs: quote URLs in CLI examples
1 parent 7c0c360 commit 5c2427a

8 files changed

Lines changed: 45 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ Additional packaged skills live under `skills/`, including `skills/youtube-to-bl
6060

6161
```bash
6262
# Scrape a webpage (default: markdown)
63-
dumplingai scrape https://docs.example.com
63+
dumplingai scrape 'https://docs.example.com'
6464

6565
# Scrape and save to file
66-
dumplingai scrape https://example.com/article -o article.md
66+
dumplingai scrape 'https://example.com/article' -o article.md
6767

6868
# URL shortcut — no subcommand needed
69-
dumplingai https://example.com
69+
dumplingai 'https://example.com'
7070

7171
# Web search
7272
dumplingai search "TypeScript 5.5 new features"
@@ -75,11 +75,12 @@ dumplingai search "TypeScript 5.5 new features"
7575
dumplingai search "best React state management" --scrape
7676

7777
# Get YouTube transcript
78-
dumplingai transcript https://youtube.com/watch?v=dQw4w9WgXcQ
78+
dumplingai transcript 'https://youtube.com/watch?v=dQw4w9WgXcQ'
7979

8080
# Output as JSON
81-
dumplingai scrape https://example.com --json
81+
dumplingai scrape 'https://example.com' --json
8282
```
83+
Quote URLs in shell examples by default. This avoids `zsh` globbing issues with characters like `?` and keeps commands copy-paste safe.
8384

8485
---
8586

‎packages/cli/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,13 @@ npx skills add dumplingai/cli --skill dumplingai-cli --skill youtube-to-blog-pos
3434

3535
```bash
3636
dumplingai login --api-key sk_yourkey
37-
dumplingai scrape https://example.com
37+
dumplingai scrape 'https://example.com'
38+
```
39+
40+
Quote URLs in shell examples by default so special characters like `?` are passed through safely.
41+
42+
```bash
43+
dumplingai transcript 'https://youtube.com/watch?v=dQw4w9WgXcQ'
3844
```
3945

4046
## Commands

‎packages/cli/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dumplingai-cli",
3-
"version": "0.1.4",
3+
"version": "0.1.5",
44
"description": "DumplingAI CLI — scrape, search, and extract from the terminal",
55
"license": "MIT",
66
"type": "module",

‎packages/cli/src/commands/init.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export function makeInitCommand(): Command {
7878
await runSkillSetup();
7979
}
8080

81-
printStatus('\nDone! Try: dumplingai scrape https://example.com');
81+
printStatus("\nDone! Try: dumplingai scrape 'https://example.com'");
8282
});
8383
}
8484

‎packages/cli/src/commands/setup-skill.ts‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,19 @@ description: Use when working with the DumplingAI CLI to scrape webpages, search
3636
3737
\`\`\`bash
3838
# Scrape a webpage
39-
dumplingai scrape https://example.com -o .dumplingai/page.md
39+
dumplingai scrape 'https://example.com' -o .dumplingai/page.md
4040
4141
# Web search
4242
dumplingai search "TypeScript best practices 2024" --json
4343
4444
# Get a YouTube transcript
45-
dumplingai transcript https://youtube.com/watch?v=dQw4w9WgXcQ -o .dumplingai/transcript.txt
45+
dumplingai transcript 'https://youtube.com/watch?v=dQw4w9WgXcQ' -o .dumplingai/transcript.txt
4646
4747
# URL shortcut (auto-forwards to scrape)
48-
dumplingai https://example.com
48+
dumplingai 'https://example.com'
4949
\`\`\`
50+
51+
Quote URLs in shell examples by default so special characters like \`?\` are passed through unchanged.
5052
`,
5153
'rules/safety.md': `# Safety Rules
5254
@@ -118,9 +120,9 @@ Turn a YouTube video into a structured blog post using the DumplingAI CLI.
118120
Always write intermediate artifacts to \`.dumplingai/\`:
119121
120122
\`\`\`bash
121-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
123+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
122124
dumplingai search "concept referenced in the video" -o .dumplingai/search.md
123-
dumplingai scrape https://example.com/reference -o .dumplingai/reference.md
125+
dumplingai scrape 'https://example.com/reference' -o .dumplingai/reference.md
124126
\`\`\`
125127
126128
Then read incrementally:
@@ -137,6 +139,8 @@ sed -n '80,180p' .dumplingai/transcript.txt
137139
- Remove filler, repetition, sponsor reads, and off-topic asides
138140
- Convert spoken language into tighter written prose
139141
- If the transcript is noisy or incomplete, produce an outline first and flag uncertainty
142+
143+
Quote URLs in shell examples by default so special characters like \`?\` are passed through to the CLI.
140144
`,
141145
'rules/safety.md': `# Safety Rules
142146
@@ -183,8 +187,8 @@ Write research artifacts to \`.dumplingai/\` before drafting:
183187
184188
\`\`\`bash
185189
dumplingai search "AI sales assistant pain points for SMB founders" -o .dumplingai/search.md
186-
dumplingai scrape https://example.com/product-page -o .dumplingai/product.md
187-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
190+
dumplingai scrape 'https://example.com/product-page' -o .dumplingai/product.md
191+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
188192
\`\`\`
189193
190194
Then read incrementally:
@@ -204,6 +208,8 @@ sed -n '1,120p' .dumplingai/product.md
204208
- Avoid hashtags unless the user asks for them
205209
- Produce multiple variants when tone is ambiguous
206210
- Default to one version per requested platform, not one generic post
211+
212+
Quote URLs in shell examples by default so special characters like \`?\` do not get expanded before \`dumplingai\` runs.
207213
`,
208214
'rules/safety.md': `# Safety Rules
209215

‎skills/dumplingai-cli/SKILL.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ When gathering web content, prefer in this order:
2929
Always write large outputs to `.dumplingai/` to keep context clean:
3030

3131
```bash
32-
dumplingai scrape https://example.com -o .dumplingai/page.md
32+
dumplingai scrape 'https://example.com' -o .dumplingai/page.md
3333
dumplingai search "TypeScript 5.5 features" -o .dumplingai/search.md
34-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
34+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
3535
```
3636

3737
Then read incrementally:
@@ -44,20 +44,21 @@ rg "function" .dumplingai/page.md
4444

4545
```bash
4646
# Quick scrape (markdown, default)
47-
dumplingai scrape https://docs.example.com/guide
47+
dumplingai scrape 'https://docs.example.com/guide'
4848

4949
# HTML scrape
50-
dumplingai scrape https://example.com --format html -o .dumplingai/raw.html
50+
dumplingai scrape 'https://example.com' --format html -o .dumplingai/raw.html
5151

5252
# Search and scrape top results
5353
dumplingai search "best TypeScript ORMs 2024" --scrape --json
5454

5555
# Get transcript in Spanish
56-
dumplingai transcript https://youtube.com/watch?v=ID --lang es
56+
dumplingai transcript 'https://youtube.com/watch?v=ID' --lang es
5757

5858
# URL shortcut (no subcommand needed)
59-
dumplingai https://example.com/article
59+
dumplingai 'https://example.com/article'
6060
```
61+
Quote URLs in shell examples by default so special characters like `?` are passed through unchanged.
6162

6263
## Safety
6364

‎skills/social-media-post/SKILL.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Write research artifacts to `.dumplingai/` before drafting:
4444

4545
```bash
4646
dumplingai search "AI sales assistant pain points for SMB founders" -o .dumplingai/search.md
47-
dumplingai scrape https://example.com/product-page -o .dumplingai/product.md
48-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
47+
dumplingai scrape 'https://example.com/product-page' -o .dumplingai/product.md
48+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
4949
```
5050

5151
Then read incrementally:
@@ -73,11 +73,12 @@ sed -n '1,120p' .dumplingai/product.md
7373
dumplingai search "B2B SaaS onboarding mistakes founder audience" -o .dumplingai/search.md
7474

7575
# Pull a primary source if available
76-
dumplingai scrape https://example.com/blog-post -o .dumplingai/source.md
76+
dumplingai scrape 'https://example.com/blog-post' -o .dumplingai/source.md
7777

7878
# Optional: use a video as source material
79-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
79+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
8080
```
81+
Quote URLs in shell examples by default so special characters like `?` do not get expanded before `dumplingai` runs.
8182

8283
## Safety
8384

‎skills/youtube-to-blog-post/SKILL.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ dumplingai scrape <url> # Read specific references in depth
3737
Always write intermediate artifacts to `.dumplingai/`:
3838

3939
```bash
40-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
40+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
4141
dumplingai search "company or concept from the video" -o .dumplingai/search.md
42-
dumplingai scrape https://example.com/reference -o .dumplingai/reference.md
42+
dumplingai scrape 'https://example.com/reference' -o .dumplingai/reference.md
4343
```
4444

4545
Then read incrementally:
@@ -62,14 +62,15 @@ sed -n '80,180p' .dumplingai/transcript.txt
6262

6363
```bash
6464
# Step 1: fetch the transcript
65-
dumplingai transcript https://youtube.com/watch?v=ID -o .dumplingai/transcript.txt
65+
dumplingai transcript 'https://youtube.com/watch?v=ID' -o .dumplingai/transcript.txt
6666

6767
# Step 2: verify referenced claims if needed
6868
dumplingai search "site:docs.example.com feature mentioned in the video" -o .dumplingai/search.md
6969

7070
# Step 3: scrape the best supporting source
71-
dumplingai scrape https://docs.example.com/feature -o .dumplingai/feature.md
71+
dumplingai scrape 'https://docs.example.com/feature' -o .dumplingai/feature.md
7272
```
73+
Quote URLs in shell examples by default so special characters like `?` are passed through to the CLI.
7374

7475
## Safety
7576

0 commit comments

Comments
 (0)