llmstxt-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/dist/index.js +8170 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# llmstxt-cli
|
|
2
|
+
|
|
3
|
+
Install llms.txt documentation into your AI coding agents.
|
|
4
|
+
|
|
5
|
+
> 900+ entries from the [llms-txt-hub](https://github.com/thedaviddias/llms-txt-hub) registry, delivered as agent skills for Claude Code, Cursor, Windsurf, Cline, OpenCode, Codex & more.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Auto-detect your project's dependencies and install matching docs
|
|
11
|
+
npx llmstxt-cli init
|
|
12
|
+
|
|
13
|
+
# Install a specific skill
|
|
14
|
+
npx llmstxt-cli install react
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## How It Works
|
|
18
|
+
|
|
19
|
+
1. Fetches `llms.txt` / `llms-full.txt` from the registry
|
|
20
|
+
2. Stores canonically in `.agents/skills/<slug>/SKILL.md`
|
|
21
|
+
3. Creates symlinks for each detected agent (`.claude/skills/`, `.cursor/skills/`, etc.)
|
|
22
|
+
4. Updates `CLAUDE.md` with a managed reference section
|
|
23
|
+
5. Adds `.gitignore` entries (installs are per-developer)
|
|
24
|
+
|
|
25
|
+
## Commands
|
|
26
|
+
|
|
27
|
+
| Command | Description |
|
|
28
|
+
|---|---|
|
|
29
|
+
| `init` | Auto-detect dependencies and install matching docs |
|
|
30
|
+
| `install <names...>` | Install by name (supports multiple) |
|
|
31
|
+
| `search <query>` | Search the registry |
|
|
32
|
+
| `list` (alias: `ls`) | Show installed entries |
|
|
33
|
+
| `update [name]` | Re-fetch installed entries (or a specific one) |
|
|
34
|
+
| `remove` (alias: `rm`) | Uninstall an entry |
|
|
35
|
+
| `info <name>` | Show registry details for an entry |
|
|
36
|
+
|
|
37
|
+
## Options
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Prefer llms-full.txt when available
|
|
41
|
+
npx llmstxt-cli init --full
|
|
42
|
+
npx llmstxt-cli install react --full
|
|
43
|
+
|
|
44
|
+
# Preview without installing
|
|
45
|
+
npx llmstxt-cli init --dry-run
|
|
46
|
+
|
|
47
|
+
# Force re-download
|
|
48
|
+
npx llmstxt-cli install react --force
|
|
49
|
+
npx llmstxt-cli update --force
|
|
50
|
+
|
|
51
|
+
# Filter by category
|
|
52
|
+
npx llmstxt-cli init --category frameworks,libraries
|
|
53
|
+
npx llmstxt-cli search react --category frameworks
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Supported Agents
|
|
57
|
+
|
|
58
|
+
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
|
|
59
|
+
- [Cursor](https://cursor.sh)
|
|
60
|
+
- [Windsurf](https://codeium.com/windsurf)
|
|
61
|
+
- [Cline](https://github.com/cline/cline)
|
|
62
|
+
- [OpenCode](https://opencode.ai)
|
|
63
|
+
- [Codex](https://github.com/openai/codex)
|
|
64
|
+
|
|
65
|
+
## Requirements
|
|
66
|
+
|
|
67
|
+
- Node.js >= 22
|
|
68
|
+
|
|
69
|
+
## Links
|
|
70
|
+
|
|
71
|
+
- Website: [llmstxt.directory](https://llmstxt.directory)
|
|
72
|
+
- Registry: [github.com/thedaviddias/llms-txt-hub](https://github.com/thedaviddias/llms-txt-hub)
|
|
73
|
+
- Issues: [github.com/thedaviddias/llms-txt-hub/issues](https://github.com/thedaviddias/llms-txt-hub/issues)
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
MIT
|