Skip to content

Commit 2e97dae

Browse files
authored
refactor(cli): update CLI documentation and add deprecation warning to skill commands (#2711)
1 parent eb57986 commit 2e97dae

13 files changed

Lines changed: 57 additions & 356 deletions

File tree

.changeset/great-apples-like.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"ctx7": patch
3+
---
4+
5+
Add deprecation warning to skill commands

docs/clients/cli.mdx

Lines changed: 3 additions & 171 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
title: CLI
3-
description: The ctx7 CLI — fetch library documentation, manage skills, and configure Context7 MCP from your terminal
3+
description: The ctx7 CLI — fetch library documentation and configure Context7 MCP from your terminal
44
---
55

66
The `ctx7` CLI is the command-line interface for Context7. It does three things:
77

88
- **Fetch library documentation** — resolve any library by name and query its up-to-date docs directly in your terminal, without opening a browser
9-
- **Manage AI coding skills** — install, search, generate, and remove skills from the Context7 registry
109
- **Configure Context7 MCP** — set up the MCP server for Claude Code, Cursor, or OpenCode with a single command
1110

1211
The CLI is useful both as a standalone tool (fetching docs while you code) and as a setup utility (wiring up Context7 for your AI coding agent).
@@ -191,7 +190,7 @@ If you installed the CLI itself with `npm install -g ctx7`, remove that separate
191190

192191
## Authentication
193192

194-
Most commands work without authentication. Log in to unlock skill generation and higher rate limits on documentation commands.
193+
Most commands work without authentication. Log in to unlock higher rate limits on documentation commands.
195194

196195
### Commands
197196

@@ -222,178 +221,17 @@ export CONTEXT7_API_KEY=your_key
222221
| Feature | Required |
223222
| -------------------------------------------------------- | ---------------------------------------------------------------------------- |
224223
| `ctx7 library` / `ctx7 docs` | No — login gives higher rate limits |
225-
| `ctx7 skills install / search / suggest / list / remove` | No |
226-
| `ctx7 skills generate` | Yes |
227224
| `ctx7 setup` | Yes — unless `--api-key` is passed (`--oauth` also skips login for MCP mode) |
228225

229226
---
230227

231-
## Skills
232-
233-
Manage AI coding skills from the Context7 registry. See [Skills](/skills) for a full explanation of what skills are, the registry, trust scores, and skill file structure.
234-
235-
### ctx7 skills install
236-
237-
Install skills from any GitHub repository. Repository format is `/owner/repo`.
238-
239-
```bash
240-
# Interactive — pick from a list
241-
ctx7 skills install /anthropics/skills
242-
243-
# Install a specific skill by name
244-
ctx7 skills install /anthropics/skills pdf
245-
246-
# Install all skills without prompting
247-
ctx7 skills install /anthropics/skills --all
248-
```
249-
250-
**Target a specific AI coding assistant:**
251-
252-
```bash
253-
ctx7 skills install /anthropics/skills pdf --claude # Claude Code
254-
ctx7 skills install /anthropics/skills pdf --cursor # Cursor
255-
ctx7 skills install /anthropics/skills pdf --universal # Universal (.agents/skills/)
256-
ctx7 skills install /anthropics/skills pdf --antigravity
257-
ctx7 skills install /anthropics/skills pdf --all-agents # Universal + all vendor-specific locations
258-
```
259-
260-
**Install globally** (available across all projects):
261-
262-
```bash
263-
ctx7 skills install /anthropics/skills pdf --global
264-
ctx7 skills install /anthropics/skills --all --global
265-
ctx7 skills install /anthropics/skills pdf --global --universal --yes
266-
ctx7 skills install /anthropics/skills pdf --global --all-agents --yes
267-
```
268-
269-
<Note>
270-
When installing to multiple clients, the skill files are created in your primary client's
271-
directory and symlinked to the others.
272-
</Note>
273-
274-
Alias: `ctx7 si /anthropics/skills pdf`
275-
276-
### ctx7 skills search
277-
278-
Find skills across all indexed repositories by keyword. Shows an interactive list — select to install directly.
279-
280-
```bash
281-
ctx7 skills search pdf
282-
ctx7 skills search typescript testing
283-
ctx7 skills search react nextjs
284-
```
285-
286-
Alias: `ctx7 ss pdf`
287-
288-
### ctx7 skills suggest
289-
290-
Auto-detects your project dependencies and recommends relevant skills from the registry.
291-
292-
```bash
293-
# Scan current project
294-
ctx7 skills suggest
295-
296-
# Target a specific client
297-
ctx7 skills suggest --claude
298-
ctx7 skills suggest --cursor
299-
300-
# Install suggestions globally
301-
ctx7 skills suggest --global
302-
```
303-
304-
Scans: `package.json`, `requirements.txt`, `pyproject.toml`, `Cargo.toml`, `go.mod`, `Gemfile`.
305-
306-
Alias: `ctx7 ssg`
307-
308-
### ctx7 skills generate
309-
310-
Generate a custom skill tailored to your stack using AI. **Requires login.**
311-
312-
```bash
313-
ctx7 skills generate
314-
315-
# Generate and install to a specific client
316-
ctx7 skills generate --claude
317-
ctx7 skills generate --cursor
318-
ctx7 skills generate --universal
319-
320-
# Generate as a global skill
321-
ctx7 skills generate --global
322-
```
323-
324-
**Generation flow:**
325-
326-
1. Describe the expertise you want (e.g., "OAuth authentication with NextAuth.js")
327-
2. Select relevant libraries from search results
328-
3. Answer 3 clarifying questions to focus the skill
329-
4. Review the generated skill and request changes if needed
330-
5. Choose where to install it
331-
332-
<Tip>
333-
Describe best practices and constraints, not step-by-step tutorials. "TypeScript strict mode
334-
patterns" generates a more useful skill than "how to write TypeScript."
335-
</Tip>
336-
337-
**Weekly limits:** Free accounts get 6 generations/week, Pro accounts get 10.
338-
339-
Aliases: `ctx7 skills gen`, `ctx7 skills g`
340-
341-
### ctx7 skills list
342-
343-
View skills installed in your project or globally.
344-
345-
```bash
346-
ctx7 skills list # All detected clients
347-
ctx7 skills list --claude
348-
ctx7 skills list --cursor
349-
ctx7 skills list --global
350-
```
351-
352-
### ctx7 skills info
353-
354-
Preview all available skills in a repository without installing.
355-
356-
```bash
357-
ctx7 skills info /anthropics/skills
358-
```
359-
360-
### ctx7 skills remove
361-
362-
Uninstall a skill by name.
363-
364-
```bash
365-
ctx7 skills remove pdf
366-
ctx7 skills remove pdf --claude
367-
ctx7 skills remove pdf --global
368-
```
369-
370-
Aliases: `ctx7 skills rm`, `ctx7 skills delete`
371-
372-
---
373-
374-
## Shortcuts
375-
376-
| Shortcut | Full command |
377-
| ----------------- | ---------------------- |
378-
| `ctx7 si` | `ctx7 skills install` |
379-
| `ctx7 ss` | `ctx7 skills search` |
380-
| `ctx7 ssg` | `ctx7 skills suggest` |
381-
| `ctx7 skills i` | `ctx7 skills install` |
382-
| `ctx7 skills s` | `ctx7 skills search` |
383-
| `ctx7 skills ls` | `ctx7 skills list` |
384-
| `ctx7 skills rm` | `ctx7 skills remove` |
385-
| `ctx7 skills gen` | `ctx7 skills generate` |
386-
| `ctx7 skills g` | `ctx7 skills generate` |
387-
388-
---
389-
390228
## Telemetry
391229

392230
The CLI collects anonymous usage data to help improve the product. To disable:
393231

394232
```bash
395233
# For a single command
396-
CTX7_TELEMETRY_DISABLED=1 ctx7 skills search pdf
234+
CTX7_TELEMETRY_DISABLED=1 ctx7 docs /facebook/react "useEffect examples"
397235

398236
# Permanently — add to ~/.bashrc or ~/.zshrc
399237
export CTX7_TELEMETRY_DISABLED=1
@@ -404,12 +242,6 @@ export CTX7_TELEMETRY_DISABLED=1
404242
## Next Steps
405243

406244
<CardGroup cols={2}>
407-
<Card title="Browse Skills" icon="magnifying-glass" href="https://context7.com/skills">
408-
Explore the skills registry
409-
</Card>
410-
<Card title="Skills Guide" icon="book" href="/skills">
411-
Learn about skill file structure, trust scores, and the registry
412-
</Card>
413245
<Card title="Claude Code" icon="terminal" href="/clients/claude-code">
414246
Set up Context7 in Claude Code
415247
</Card>

docs/docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
"adding-libraries",
2929
"library-updates",
3030
"api-guide",
31-
"skills",
3231
"tips"
3332
]
3433
},
@@ -234,4 +233,4 @@
234233
}
235234
]
236235
}
237-
}
236+
}

docs/howto/verification.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ This badge appears on:
2828
- Your library's main page
2929
- Search results
3030
- Library listings and tables
31-
- Skills associated with your library
3231

3332
## How to Get Verified
3433

@@ -40,7 +39,6 @@ Libraries are automatically verified when they meet certain quality thresholds:
4039

4140
- **High trust score**: Libraries with a trust score of 9 or above. Trust score is calculated based on the GitHub organization/user profile, considering factors like total stars, number of repositories, account age, recent activity, followers, and profile completeness.
4241
- **Top 100 libraries**: Most-used libraries by API requests
43-
- **Top 100 skills**: Libraries with the most-installed skills
4442

4543
Automatic verification is checked daily. If your library qualifies, it will be verified automatically without any action required.
4644

@@ -121,13 +119,6 @@ You can check your library's verification status on the admin page:
121119
| **Verified** | Green badge displayed, full verification benefits |
122120
| **Not Verified** | No badge, apply to get verified |
123121

124-
## Skills and Verification
125-
126-
Skills inherit the verification status of their parent library. When your library is verified:
127-
128-
- All skills associated with your library display the verified badge
129-
- Skills rank higher in skill search results
130-
131122
## FAQ
132123

133124
### How long does manual verification take?
@@ -151,7 +142,7 @@ Automatic verification is recalculated daily. If your library no longer meets th
151142

152143
### My library is popular but not verified. Why?
153144

154-
Automatic verification considers multiple factors including trust score, usage statistics, and skill installs. When you apply manually, Context7 also checks quality criteria like GitHub stars, popularity ranking, and referring domains. If you believe your library meets any of these thresholds, please apply manually and the check will run immediately.
145+
Automatic verification considers multiple factors including trust score and usage statistics. When you apply manually, Context7 also checks quality criteria like GitHub stars, popularity ranking, and referring domains. If you believe your library meets any of these thresholds, please apply manually and the check will run immediately.
155146

156147
## Need Help?
157148

docs/security/data-safety.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Context7 indexes documentation from public and private sources. To prevent malic
1212

1313
- **Robust Detection** — Content is analyzed using a classifier tailored for Context7 to identify prompt injection attempts and malware-related patterns
1414
- **Targeted Validation** — Suspicious content is subjected to additional checks
15-
- **Skills.md Handling** — A separate but related detection pipeline is used for [Skills](/skills) files, adapted to their distinct structure and intent
1615
- **Continuous Monitoring** — Flagged content is tracked and reviewed on an ongoing basis
1716
- **Regular Updates** — Detection logic is updated to address evolving attack methods and new injection techniques
1817

0 commit comments

Comments
 (0)