Skip to content

Commit 19d3d57

Browse files
committed
can be now installed locally via pip to use with any local folder. make sure to have a .gitignore or else...
1 parent bcd3159 commit 19d3d57

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ The script will:
7474
2. Process files according to .gitignore rules
7575
3. Generate `llms.txt` with compressed content
7676

77+
### Install Locally
78+
79+
```bash
80+
pip install --user .
81+
```
82+
83+
Now you can use the `llmstxt` command from your terminal.
84+
7785
### GitHub Actions Integration
7886

7987
There are two ways to use this tool with GitHub Actions:

llmstxt/__main__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#!/usr/bin/env python3
12
"""Command-line interface for llmstxt."""
23

34
from .llms import generate_llms_txt

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ requires-python = ">=3.8"
88
readme = "README.md"
99
license = { text = "MIT" }
1010

11+
[project.scripts]
12+
llmstxt = "llmstxt.__main__:generate_llms_txt"
13+
1114
[project.optional-dependencies]
1215
dev = ["mypy>=1.7.0", "ruff>=0.1.8"]
1316

0 commit comments

Comments
 (0)