context-gen-cli 1.3.3__tar.gz → 1.3.5__tar.gz
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.
- context_gen_cli-1.3.5/PKG-INFO +192 -0
- context_gen_cli-1.3.5/README.md +164 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/scanner.py +18 -0
- context_gen_cli-1.3.5/context_gen_cli.egg-info/PKG-INFO +192 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/requires.txt +2 -1
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/pyproject.toml +3 -2
- context_gen_cli-1.3.3/PKG-INFO +0 -115
- context_gen_cli-1.3.3/README.md +0 -88
- context_gen_cli-1.3.3/context_gen_cli.egg-info/PKG-INFO +0 -115
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/__init__.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/cli.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/distill.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/extractor.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/generator.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/graph.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/mcp/__init__.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen/mcp/advanced_tools.py +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/SOURCES.txt +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/dependency_links.txt +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/entry_points.txt +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/top_level.txt +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/setup.cfg +0 -0
- {context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/tests/test_advanced_tools.py +0 -0
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: context-gen-cli
|
|
3
|
+
Version: 1.3.5
|
|
4
|
+
Summary: A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json).
|
|
5
|
+
Author: yakkshit
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Keywords: llm,context,agent,cli,code-analysis,ast,graph,mcp
|
|
8
|
+
Classifier: Development Status :: 4 - Beta
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Topic :: Software Development :: Code Generators
|
|
17
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
Requires-Dist: typer>=0.12.0
|
|
21
|
+
Requires-Dist: rich>=13.7.0
|
|
22
|
+
Requires-Dist: shellingham>=1.5.4
|
|
23
|
+
Requires-Dist: pathspec>=0.12.1
|
|
24
|
+
Provides-Extra: dev
|
|
25
|
+
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
26
|
+
Requires-Dist: build>=1.1.0; extra == "dev"
|
|
27
|
+
Requires-Dist: twine>=5.0.0; extra == "dev"
|
|
28
|
+
|
|
29
|
+
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
30
|
+
|
|
31
|
+
<p align="center">
|
|
32
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/v/context-gen-cli.svg?color=3775a9" alt="PyPI version" /></a>
|
|
33
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/pyversions/context-gen-cli.svg" alt="Python Versions" /></a>
|
|
34
|
+
<a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-Protocol%20Ready-6366f1.svg" alt="MCP Ready" /></a>
|
|
35
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License" /></a>
|
|
36
|
+
<a href="https://resume.cedzlabs.com/labs"><img src="https://img.shields.io/badge/Cedzlabs-Labs%20%E2%86%97-cyan.svg" alt="Cedzlabs Labs" /></a>
|
|
37
|
+
</p>
|
|
38
|
+
|
|
39
|
+
> **Stop dumping 50,000 raw tokens into your AI coding agent.**
|
|
40
|
+
> `context-gen-cli` analyzes any codebase using native AST parsers and **Entropy-Guided Reference Distillation (EGRD)** to give Cursor, Antigravity, Claude Code, and VS Code an ultra-dense **~40-token Senior Engineer Context Plan**—or stops to ask targeted questions if your prompt is ambiguous.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
### 💡 Package Name vs. Command Alias
|
|
45
|
+
|
|
46
|
+
| What you install | What you run in your terminal |
|
|
47
|
+
| :--- | :--- |
|
|
48
|
+
| `pip install context-gen-cli` | **`ctx`** |
|
|
49
|
+
|
|
50
|
+
> **Why `ctx`?** While the package is registered as `context-gen-cli` on PyPI and npm, you shouldn't have to type 15 characters every time you run a command. The binary alias **`ctx`** is automatically registered upon installation. (The full `context-gen` alias is also preserved for scripts).
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## 🌟 Highlights
|
|
55
|
+
|
|
56
|
+
- **⚡ Fast Short Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
57
|
+
- **🧠 Entropy-Guided Reference Distillation (EGRD)**: Calculates Shannon Entropy ($H$) over codebase signatures to filter 98.5% of prompt noise.
|
|
58
|
+
- **🛡️ Anti-Hallucination Clarification Gate**: If your prompt is ambiguous ($H \ge 1.50\text{ bits}$), `ctx` halts guessing and asks targeted questions using real paths from your repo.
|
|
59
|
+
- **🕸️ 100% Accurate AST Knowledge Graph**: Uses native AST traversal to resolve relative imports, exports, roles, and downstream **Blast Radius** (what files break if this changes).
|
|
60
|
+
- **🔋 Zero GPU / CUDA Bloat**: Strictly capped at 1–2 CPU cores. No 15GB PyTorch downloads or local embedding models.
|
|
61
|
+
- **📁 Clean Monorepo / Workspace Storage**: Saves context models neatly into `context/agent.md`, `context/agent.json`, and `context/agent.yaml`.
|
|
62
|
+
- **🔒 Security Filter**: Strips virtual environments (`.venv*`, `venv*`), `.env*` files, pem/key certificates, and secrets automatically.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 📦 Installation
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Standard installation
|
|
70
|
+
pip install context-gen-cli
|
|
71
|
+
|
|
72
|
+
# Or with pipx (recommended for isolated global CLI tools)
|
|
73
|
+
pipx install context-gen-cli
|
|
74
|
+
|
|
75
|
+
# Or with uv
|
|
76
|
+
uv tool install context-gen-cli
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Verify installation:
|
|
80
|
+
```bash
|
|
81
|
+
ctx --help
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 🚀 Everyday Workflows & Examples
|
|
87
|
+
|
|
88
|
+
### 1. ⚡ All-In-One Workspace Mode (`ctx -d`)
|
|
89
|
+
Generates triple context formats (`agent.md`, `agent.json`, `agent.yaml`) in `context/` and runs a live auto-sync watcher in the background:
|
|
90
|
+
```bash
|
|
91
|
+
ctx -d
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 2. 🎯 Distill a Specific Prompt (`ctx distill`)
|
|
95
|
+
Generate a dense Senior Engineer Blueprint for any task:
|
|
96
|
+
```bash
|
|
97
|
+
ctx distill "add jwt refresh token rotation to authentication"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Output:**
|
|
101
|
+
```text
|
|
102
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
103
|
+
║ 🧠 SENIOR ENGINEER CONTEXT PLAN (EGRD Distilled) ║
|
|
104
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
105
|
+
|
|
106
|
+
🎯 Task: add jwt refresh token rotation to authentication
|
|
107
|
+
⚙️ Engineering Mode: Architecture / Refactor
|
|
108
|
+
|
|
109
|
+
📂 Primary Files to Reference:
|
|
110
|
+
✔ src/services/auth.py
|
|
111
|
+
✔ src/routes/auth_routes.py
|
|
112
|
+
✔ src/models/user.py
|
|
113
|
+
|
|
114
|
+
💥 Blast Radius (Downstream Callers):
|
|
115
|
+
src/middleware/guard.py, src/app.py
|
|
116
|
+
|
|
117
|
+
🛡️ Architecture Guardrail:
|
|
118
|
+
Changes affect 2 downstream callers. Verify token payload backward compatibility.
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 3. ⚠️ The Clarification Gate (Ambiguous Prompts)
|
|
122
|
+
If you provide a vague prompt like:
|
|
123
|
+
```bash
|
|
124
|
+
ctx distill "update config"
|
|
125
|
+
```
|
|
126
|
+
Instead of hallucinating or dumping the entire repository, `ctx` pauses and shows:
|
|
127
|
+
```text
|
|
128
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
129
|
+
║ ⚠️ CLARIFICATION NEEDED — Ambiguous Prompt Detected ║
|
|
130
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
131
|
+
|
|
132
|
+
▸ Prompt entropy H = 1.84 bits exceeds confident threshold (1.50 bits).
|
|
133
|
+
▸ Disambiguate by specifying target:
|
|
134
|
+
1. src/config/database.py
|
|
135
|
+
2. src/config/server.py
|
|
136
|
+
3. src/config/redis.py
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 4. 📊 Check Token Weight & Savings (`ctx --tokens`)
|
|
140
|
+
Inspect how much context weight your AI agent saves compared to raw directory dumps:
|
|
141
|
+
```bash
|
|
142
|
+
ctx --tokens
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## 📖 CLI Reference
|
|
148
|
+
|
|
149
|
+
| Command | Description |
|
|
150
|
+
| :--- | :--- |
|
|
151
|
+
| `ctx` | Scans workspace and generates `agent.md`, `agent.json`, `agent.yaml` in `context/` |
|
|
152
|
+
| `ctx -d` / `ctx --default` | **⚡ All-in-One**: Generates context and starts live file-watching sync |
|
|
153
|
+
| `ctx distill "<prompt>"` | **🧠 EGRD Distiller**: Generates high-signal Senior Engineer Blueprint |
|
|
154
|
+
| `ctx -w` / `ctx --watch` | **👀 Watch Mode**: Watches codebase and auto-updates context files on save |
|
|
155
|
+
| `ctx --tokens` | **📊 Token Analytics**: Displays token counts and compression ratios |
|
|
156
|
+
| `ctx -o <dir>` | **📁 Custom Output**: Specify output directory (defaults to `context/`) |
|
|
157
|
+
| `ctx -f <format>` | **📄 Format Filter**: Choose `md`, `json`, `yaml`, or `all` |
|
|
158
|
+
| `ctx update` | **🔄 Quick Refresh**: Re-indexes the current workspace |
|
|
159
|
+
| `ctx --help` | View full options and flag descriptions |
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 🛠️ MCP (Model Context Protocol) Integration
|
|
164
|
+
|
|
165
|
+
`ctx` can act as an MCP server for **Cursor**, **Claude Desktop**, **Antigravity**, and **VS Code**:
|
|
166
|
+
|
|
167
|
+
Add to your MCP settings (`claude_desktop_config.json` or Cursor Settings):
|
|
168
|
+
```json
|
|
169
|
+
{
|
|
170
|
+
"mcpServers": {
|
|
171
|
+
"context-gen": {
|
|
172
|
+
"command": "ctx",
|
|
173
|
+
"args": ["-d"]
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## 🤝 Ecosystem & Links
|
|
182
|
+
|
|
183
|
+
- **Documentation & Showcase:** [https://resume.cedzlabs.com/labs](https://resume.cedzlabs.com/labs)
|
|
184
|
+
- **Node.js (npm):** `npx context-gen-cli@latest`
|
|
185
|
+
- **Homebrew (macOS):** `brew install context-gen-cli`
|
|
186
|
+
- **GitHub Repository:** [https://github.com/yakkshit/context-gen](https://github.com/yakkshit/context-gen)
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## 📄 License
|
|
191
|
+
|
|
192
|
+
MIT © [Yakkshit](https://github.com/yakkshit) & [Cedzlabs](https://resume.cedzlabs.com/labs)
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/v/context-gen-cli.svg?color=3775a9" alt="PyPI version" /></a>
|
|
5
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/pyversions/context-gen-cli.svg" alt="Python Versions" /></a>
|
|
6
|
+
<a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-Protocol%20Ready-6366f1.svg" alt="MCP Ready" /></a>
|
|
7
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License" /></a>
|
|
8
|
+
<a href="https://resume.cedzlabs.com/labs"><img src="https://img.shields.io/badge/Cedzlabs-Labs%20%E2%86%97-cyan.svg" alt="Cedzlabs Labs" /></a>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
> **Stop dumping 50,000 raw tokens into your AI coding agent.**
|
|
12
|
+
> `context-gen-cli` analyzes any codebase using native AST parsers and **Entropy-Guided Reference Distillation (EGRD)** to give Cursor, Antigravity, Claude Code, and VS Code an ultra-dense **~40-token Senior Engineer Context Plan**—or stops to ask targeted questions if your prompt is ambiguous.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
### 💡 Package Name vs. Command Alias
|
|
17
|
+
|
|
18
|
+
| What you install | What you run in your terminal |
|
|
19
|
+
| :--- | :--- |
|
|
20
|
+
| `pip install context-gen-cli` | **`ctx`** |
|
|
21
|
+
|
|
22
|
+
> **Why `ctx`?** While the package is registered as `context-gen-cli` on PyPI and npm, you shouldn't have to type 15 characters every time you run a command. The binary alias **`ctx`** is automatically registered upon installation. (The full `context-gen` alias is also preserved for scripts).
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 🌟 Highlights
|
|
27
|
+
|
|
28
|
+
- **⚡ Fast Short Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
29
|
+
- **🧠 Entropy-Guided Reference Distillation (EGRD)**: Calculates Shannon Entropy ($H$) over codebase signatures to filter 98.5% of prompt noise.
|
|
30
|
+
- **🛡️ Anti-Hallucination Clarification Gate**: If your prompt is ambiguous ($H \ge 1.50\text{ bits}$), `ctx` halts guessing and asks targeted questions using real paths from your repo.
|
|
31
|
+
- **🕸️ 100% Accurate AST Knowledge Graph**: Uses native AST traversal to resolve relative imports, exports, roles, and downstream **Blast Radius** (what files break if this changes).
|
|
32
|
+
- **🔋 Zero GPU / CUDA Bloat**: Strictly capped at 1–2 CPU cores. No 15GB PyTorch downloads or local embedding models.
|
|
33
|
+
- **📁 Clean Monorepo / Workspace Storage**: Saves context models neatly into `context/agent.md`, `context/agent.json`, and `context/agent.yaml`.
|
|
34
|
+
- **🔒 Security Filter**: Strips virtual environments (`.venv*`, `venv*`), `.env*` files, pem/key certificates, and secrets automatically.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 📦 Installation
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Standard installation
|
|
42
|
+
pip install context-gen-cli
|
|
43
|
+
|
|
44
|
+
# Or with pipx (recommended for isolated global CLI tools)
|
|
45
|
+
pipx install context-gen-cli
|
|
46
|
+
|
|
47
|
+
# Or with uv
|
|
48
|
+
uv tool install context-gen-cli
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Verify installation:
|
|
52
|
+
```bash
|
|
53
|
+
ctx --help
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 🚀 Everyday Workflows & Examples
|
|
59
|
+
|
|
60
|
+
### 1. ⚡ All-In-One Workspace Mode (`ctx -d`)
|
|
61
|
+
Generates triple context formats (`agent.md`, `agent.json`, `agent.yaml`) in `context/` and runs a live auto-sync watcher in the background:
|
|
62
|
+
```bash
|
|
63
|
+
ctx -d
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### 2. 🎯 Distill a Specific Prompt (`ctx distill`)
|
|
67
|
+
Generate a dense Senior Engineer Blueprint for any task:
|
|
68
|
+
```bash
|
|
69
|
+
ctx distill "add jwt refresh token rotation to authentication"
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Output:**
|
|
73
|
+
```text
|
|
74
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
75
|
+
║ 🧠 SENIOR ENGINEER CONTEXT PLAN (EGRD Distilled) ║
|
|
76
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
77
|
+
|
|
78
|
+
🎯 Task: add jwt refresh token rotation to authentication
|
|
79
|
+
⚙️ Engineering Mode: Architecture / Refactor
|
|
80
|
+
|
|
81
|
+
📂 Primary Files to Reference:
|
|
82
|
+
✔ src/services/auth.py
|
|
83
|
+
✔ src/routes/auth_routes.py
|
|
84
|
+
✔ src/models/user.py
|
|
85
|
+
|
|
86
|
+
💥 Blast Radius (Downstream Callers):
|
|
87
|
+
src/middleware/guard.py, src/app.py
|
|
88
|
+
|
|
89
|
+
🛡️ Architecture Guardrail:
|
|
90
|
+
Changes affect 2 downstream callers. Verify token payload backward compatibility.
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 3. ⚠️ The Clarification Gate (Ambiguous Prompts)
|
|
94
|
+
If you provide a vague prompt like:
|
|
95
|
+
```bash
|
|
96
|
+
ctx distill "update config"
|
|
97
|
+
```
|
|
98
|
+
Instead of hallucinating or dumping the entire repository, `ctx` pauses and shows:
|
|
99
|
+
```text
|
|
100
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
101
|
+
║ ⚠️ CLARIFICATION NEEDED — Ambiguous Prompt Detected ║
|
|
102
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
103
|
+
|
|
104
|
+
▸ Prompt entropy H = 1.84 bits exceeds confident threshold (1.50 bits).
|
|
105
|
+
▸ Disambiguate by specifying target:
|
|
106
|
+
1. src/config/database.py
|
|
107
|
+
2. src/config/server.py
|
|
108
|
+
3. src/config/redis.py
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 4. 📊 Check Token Weight & Savings (`ctx --tokens`)
|
|
112
|
+
Inspect how much context weight your AI agent saves compared to raw directory dumps:
|
|
113
|
+
```bash
|
|
114
|
+
ctx --tokens
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## 📖 CLI Reference
|
|
120
|
+
|
|
121
|
+
| Command | Description |
|
|
122
|
+
| :--- | :--- |
|
|
123
|
+
| `ctx` | Scans workspace and generates `agent.md`, `agent.json`, `agent.yaml` in `context/` |
|
|
124
|
+
| `ctx -d` / `ctx --default` | **⚡ All-in-One**: Generates context and starts live file-watching sync |
|
|
125
|
+
| `ctx distill "<prompt>"` | **🧠 EGRD Distiller**: Generates high-signal Senior Engineer Blueprint |
|
|
126
|
+
| `ctx -w` / `ctx --watch` | **👀 Watch Mode**: Watches codebase and auto-updates context files on save |
|
|
127
|
+
| `ctx --tokens` | **📊 Token Analytics**: Displays token counts and compression ratios |
|
|
128
|
+
| `ctx -o <dir>` | **📁 Custom Output**: Specify output directory (defaults to `context/`) |
|
|
129
|
+
| `ctx -f <format>` | **📄 Format Filter**: Choose `md`, `json`, `yaml`, or `all` |
|
|
130
|
+
| `ctx update` | **🔄 Quick Refresh**: Re-indexes the current workspace |
|
|
131
|
+
| `ctx --help` | View full options and flag descriptions |
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 🛠️ MCP (Model Context Protocol) Integration
|
|
136
|
+
|
|
137
|
+
`ctx` can act as an MCP server for **Cursor**, **Claude Desktop**, **Antigravity**, and **VS Code**:
|
|
138
|
+
|
|
139
|
+
Add to your MCP settings (`claude_desktop_config.json` or Cursor Settings):
|
|
140
|
+
```json
|
|
141
|
+
{
|
|
142
|
+
"mcpServers": {
|
|
143
|
+
"context-gen": {
|
|
144
|
+
"command": "ctx",
|
|
145
|
+
"args": ["-d"]
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 🤝 Ecosystem & Links
|
|
154
|
+
|
|
155
|
+
- **Documentation & Showcase:** [https://resume.cedzlabs.com/labs](https://resume.cedzlabs.com/labs)
|
|
156
|
+
- **Node.js (npm):** `npx context-gen-cli@latest`
|
|
157
|
+
- **Homebrew (macOS):** `brew install context-gen-cli`
|
|
158
|
+
- **GitHub Repository:** [https://github.com/yakkshit/context-gen](https://github.com/yakkshit/context-gen)
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## 📄 License
|
|
163
|
+
|
|
164
|
+
MIT © [Yakkshit](https://github.com/yakkshit) & [Cedzlabs](https://resume.cedzlabs.com/labs)
|
|
@@ -14,12 +14,30 @@ DEFAULT_IGNORES: List[str] = [
|
|
|
14
14
|
".git/**",
|
|
15
15
|
".venv",
|
|
16
16
|
".venv/**",
|
|
17
|
+
".venv*",
|
|
18
|
+
".venv*/**",
|
|
17
19
|
"venv",
|
|
18
20
|
"venv/**",
|
|
21
|
+
"venv*",
|
|
22
|
+
"venv*/**",
|
|
23
|
+
"*venv*",
|
|
24
|
+
"*venv*/**",
|
|
19
25
|
"env",
|
|
20
26
|
"env/**",
|
|
27
|
+
"site-packages",
|
|
28
|
+
"site-packages/**",
|
|
29
|
+
".pytest_cache",
|
|
30
|
+
".pytest_cache/**",
|
|
31
|
+
".mypy_cache",
|
|
32
|
+
".mypy_cache/**",
|
|
33
|
+
".ruff_cache",
|
|
34
|
+
".ruff_cache/**",
|
|
21
35
|
"node_modules",
|
|
22
36
|
"node_modules/**",
|
|
37
|
+
".next",
|
|
38
|
+
".next/**",
|
|
39
|
+
".turbo",
|
|
40
|
+
".turbo/**",
|
|
23
41
|
".DS_Store",
|
|
24
42
|
"context",
|
|
25
43
|
"context/**",
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: context-gen-cli
|
|
3
|
+
Version: 1.3.5
|
|
4
|
+
Summary: A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json).
|
|
5
|
+
Author: yakkshit
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Keywords: llm,context,agent,cli,code-analysis,ast,graph,mcp
|
|
8
|
+
Classifier: Development Status :: 4 - Beta
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Topic :: Software Development :: Code Generators
|
|
17
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
Requires-Dist: typer>=0.12.0
|
|
21
|
+
Requires-Dist: rich>=13.7.0
|
|
22
|
+
Requires-Dist: shellingham>=1.5.4
|
|
23
|
+
Requires-Dist: pathspec>=0.12.1
|
|
24
|
+
Provides-Extra: dev
|
|
25
|
+
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
26
|
+
Requires-Dist: build>=1.1.0; extra == "dev"
|
|
27
|
+
Requires-Dist: twine>=5.0.0; extra == "dev"
|
|
28
|
+
|
|
29
|
+
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
30
|
+
|
|
31
|
+
<p align="center">
|
|
32
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/v/context-gen-cli.svg?color=3775a9" alt="PyPI version" /></a>
|
|
33
|
+
<a href="https://pypi.org/project/context-gen-cli/"><img src="https://img.shields.io/pypi/pyversions/context-gen-cli.svg" alt="Python Versions" /></a>
|
|
34
|
+
<a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-Protocol%20Ready-6366f1.svg" alt="MCP Ready" /></a>
|
|
35
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License" /></a>
|
|
36
|
+
<a href="https://resume.cedzlabs.com/labs"><img src="https://img.shields.io/badge/Cedzlabs-Labs%20%E2%86%97-cyan.svg" alt="Cedzlabs Labs" /></a>
|
|
37
|
+
</p>
|
|
38
|
+
|
|
39
|
+
> **Stop dumping 50,000 raw tokens into your AI coding agent.**
|
|
40
|
+
> `context-gen-cli` analyzes any codebase using native AST parsers and **Entropy-Guided Reference Distillation (EGRD)** to give Cursor, Antigravity, Claude Code, and VS Code an ultra-dense **~40-token Senior Engineer Context Plan**—or stops to ask targeted questions if your prompt is ambiguous.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
### 💡 Package Name vs. Command Alias
|
|
45
|
+
|
|
46
|
+
| What you install | What you run in your terminal |
|
|
47
|
+
| :--- | :--- |
|
|
48
|
+
| `pip install context-gen-cli` | **`ctx`** |
|
|
49
|
+
|
|
50
|
+
> **Why `ctx`?** While the package is registered as `context-gen-cli` on PyPI and npm, you shouldn't have to type 15 characters every time you run a command. The binary alias **`ctx`** is automatically registered upon installation. (The full `context-gen` alias is also preserved for scripts).
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## 🌟 Highlights
|
|
55
|
+
|
|
56
|
+
- **⚡ Fast Short Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
57
|
+
- **🧠 Entropy-Guided Reference Distillation (EGRD)**: Calculates Shannon Entropy ($H$) over codebase signatures to filter 98.5% of prompt noise.
|
|
58
|
+
- **🛡️ Anti-Hallucination Clarification Gate**: If your prompt is ambiguous ($H \ge 1.50\text{ bits}$), `ctx` halts guessing and asks targeted questions using real paths from your repo.
|
|
59
|
+
- **🕸️ 100% Accurate AST Knowledge Graph**: Uses native AST traversal to resolve relative imports, exports, roles, and downstream **Blast Radius** (what files break if this changes).
|
|
60
|
+
- **🔋 Zero GPU / CUDA Bloat**: Strictly capped at 1–2 CPU cores. No 15GB PyTorch downloads or local embedding models.
|
|
61
|
+
- **📁 Clean Monorepo / Workspace Storage**: Saves context models neatly into `context/agent.md`, `context/agent.json`, and `context/agent.yaml`.
|
|
62
|
+
- **🔒 Security Filter**: Strips virtual environments (`.venv*`, `venv*`), `.env*` files, pem/key certificates, and secrets automatically.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 📦 Installation
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Standard installation
|
|
70
|
+
pip install context-gen-cli
|
|
71
|
+
|
|
72
|
+
# Or with pipx (recommended for isolated global CLI tools)
|
|
73
|
+
pipx install context-gen-cli
|
|
74
|
+
|
|
75
|
+
# Or with uv
|
|
76
|
+
uv tool install context-gen-cli
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Verify installation:
|
|
80
|
+
```bash
|
|
81
|
+
ctx --help
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 🚀 Everyday Workflows & Examples
|
|
87
|
+
|
|
88
|
+
### 1. ⚡ All-In-One Workspace Mode (`ctx -d`)
|
|
89
|
+
Generates triple context formats (`agent.md`, `agent.json`, `agent.yaml`) in `context/` and runs a live auto-sync watcher in the background:
|
|
90
|
+
```bash
|
|
91
|
+
ctx -d
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 2. 🎯 Distill a Specific Prompt (`ctx distill`)
|
|
95
|
+
Generate a dense Senior Engineer Blueprint for any task:
|
|
96
|
+
```bash
|
|
97
|
+
ctx distill "add jwt refresh token rotation to authentication"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Output:**
|
|
101
|
+
```text
|
|
102
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
103
|
+
║ 🧠 SENIOR ENGINEER CONTEXT PLAN (EGRD Distilled) ║
|
|
104
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
105
|
+
|
|
106
|
+
🎯 Task: add jwt refresh token rotation to authentication
|
|
107
|
+
⚙️ Engineering Mode: Architecture / Refactor
|
|
108
|
+
|
|
109
|
+
📂 Primary Files to Reference:
|
|
110
|
+
✔ src/services/auth.py
|
|
111
|
+
✔ src/routes/auth_routes.py
|
|
112
|
+
✔ src/models/user.py
|
|
113
|
+
|
|
114
|
+
💥 Blast Radius (Downstream Callers):
|
|
115
|
+
src/middleware/guard.py, src/app.py
|
|
116
|
+
|
|
117
|
+
🛡️ Architecture Guardrail:
|
|
118
|
+
Changes affect 2 downstream callers. Verify token payload backward compatibility.
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 3. ⚠️ The Clarification Gate (Ambiguous Prompts)
|
|
122
|
+
If you provide a vague prompt like:
|
|
123
|
+
```bash
|
|
124
|
+
ctx distill "update config"
|
|
125
|
+
```
|
|
126
|
+
Instead of hallucinating or dumping the entire repository, `ctx` pauses and shows:
|
|
127
|
+
```text
|
|
128
|
+
╔═══════════════════════════════════════════════════════════════╗
|
|
129
|
+
║ ⚠️ CLARIFICATION NEEDED — Ambiguous Prompt Detected ║
|
|
130
|
+
╚═══════════════════════════════════════════════════════════════╝
|
|
131
|
+
|
|
132
|
+
▸ Prompt entropy H = 1.84 bits exceeds confident threshold (1.50 bits).
|
|
133
|
+
▸ Disambiguate by specifying target:
|
|
134
|
+
1. src/config/database.py
|
|
135
|
+
2. src/config/server.py
|
|
136
|
+
3. src/config/redis.py
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 4. 📊 Check Token Weight & Savings (`ctx --tokens`)
|
|
140
|
+
Inspect how much context weight your AI agent saves compared to raw directory dumps:
|
|
141
|
+
```bash
|
|
142
|
+
ctx --tokens
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## 📖 CLI Reference
|
|
148
|
+
|
|
149
|
+
| Command | Description |
|
|
150
|
+
| :--- | :--- |
|
|
151
|
+
| `ctx` | Scans workspace and generates `agent.md`, `agent.json`, `agent.yaml` in `context/` |
|
|
152
|
+
| `ctx -d` / `ctx --default` | **⚡ All-in-One**: Generates context and starts live file-watching sync |
|
|
153
|
+
| `ctx distill "<prompt>"` | **🧠 EGRD Distiller**: Generates high-signal Senior Engineer Blueprint |
|
|
154
|
+
| `ctx -w` / `ctx --watch` | **👀 Watch Mode**: Watches codebase and auto-updates context files on save |
|
|
155
|
+
| `ctx --tokens` | **📊 Token Analytics**: Displays token counts and compression ratios |
|
|
156
|
+
| `ctx -o <dir>` | **📁 Custom Output**: Specify output directory (defaults to `context/`) |
|
|
157
|
+
| `ctx -f <format>` | **📄 Format Filter**: Choose `md`, `json`, `yaml`, or `all` |
|
|
158
|
+
| `ctx update` | **🔄 Quick Refresh**: Re-indexes the current workspace |
|
|
159
|
+
| `ctx --help` | View full options and flag descriptions |
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 🛠️ MCP (Model Context Protocol) Integration
|
|
164
|
+
|
|
165
|
+
`ctx` can act as an MCP server for **Cursor**, **Claude Desktop**, **Antigravity**, and **VS Code**:
|
|
166
|
+
|
|
167
|
+
Add to your MCP settings (`claude_desktop_config.json` or Cursor Settings):
|
|
168
|
+
```json
|
|
169
|
+
{
|
|
170
|
+
"mcpServers": {
|
|
171
|
+
"context-gen": {
|
|
172
|
+
"command": "ctx",
|
|
173
|
+
"args": ["-d"]
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## 🤝 Ecosystem & Links
|
|
182
|
+
|
|
183
|
+
- **Documentation & Showcase:** [https://resume.cedzlabs.com/labs](https://resume.cedzlabs.com/labs)
|
|
184
|
+
- **Node.js (npm):** `npx context-gen-cli@latest`
|
|
185
|
+
- **Homebrew (macOS):** `brew install context-gen-cli`
|
|
186
|
+
- **GitHub Repository:** [https://github.com/yakkshit/context-gen](https://github.com/yakkshit/context-gen)
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## 📄 License
|
|
191
|
+
|
|
192
|
+
MIT © [Yakkshit](https://github.com/yakkshit) & [Cedzlabs](https://resume.cedzlabs.com/labs)
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "context-gen-cli"
|
|
7
|
-
version = "1.3.
|
|
7
|
+
version = "1.3.5"
|
|
8
8
|
description = "A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json)."
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
authors = [{ name = "yakkshit" }]
|
|
@@ -25,8 +25,9 @@ classifiers = [
|
|
|
25
25
|
]
|
|
26
26
|
|
|
27
27
|
dependencies = [
|
|
28
|
-
"typer
|
|
28
|
+
"typer>=0.12.0",
|
|
29
29
|
"rich>=13.7.0",
|
|
30
|
+
"shellingham>=1.5.4",
|
|
30
31
|
"pathspec>=0.12.1"
|
|
31
32
|
]
|
|
32
33
|
|
context_gen_cli-1.3.3/PKG-INFO
DELETED
|
@@ -1,115 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: context-gen-cli
|
|
3
|
-
Version: 1.3.3
|
|
4
|
-
Summary: A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json).
|
|
5
|
-
Author: yakkshit
|
|
6
|
-
License-Expression: MIT
|
|
7
|
-
Keywords: llm,context,agent,cli,code-analysis,ast,graph,mcp
|
|
8
|
-
Classifier: Development Status :: 4 - Beta
|
|
9
|
-
Classifier: Environment :: Console
|
|
10
|
-
Classifier: Intended Audience :: Developers
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
-
Classifier: Topic :: Software Development :: Code Generators
|
|
17
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
18
|
-
Requires-Python: >=3.9
|
|
19
|
-
Description-Content-Type: text/markdown
|
|
20
|
-
Requires-Dist: typer[all]>=0.12.0
|
|
21
|
-
Requires-Dist: rich>=13.7.0
|
|
22
|
-
Requires-Dist: pathspec>=0.12.1
|
|
23
|
-
Provides-Extra: dev
|
|
24
|
-
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
25
|
-
Requires-Dist: build>=1.1.0; extra == "dev"
|
|
26
|
-
Requires-Dist: twine>=5.0.0; extra == "dev"
|
|
27
|
-
|
|
28
|
-
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
29
|
-
|
|
30
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
31
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
32
|
-
[](https://opensource.org/licenses/MIT)
|
|
33
|
-
|
|
34
|
-
> ⚡ **Fast, AST-powered Python CLI tool that scans any project, extracts architecture models, and generates structured LLM context (`agent.md`, `agent.json`, `agent.yaml`).**
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## 🌟 Highlights
|
|
39
|
-
|
|
40
|
-
- **⚡ Short Command Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
41
|
-
- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities.
|
|
42
|
-
- **📁 Clean Workspace Storage**: Everything (`agent.md`, `agent.json`, `agent.yaml`, `.context-gen.json`) is saved neatly inside `context/`.
|
|
43
|
-
- **⚡ All-In-One Default Mode (`-d`)**: Auto-generates triple context formats in `context/` and runs a live auto-sync watcher in the background.
|
|
44
|
-
- **`.gitignore` & Multi-Ignore Respect**: Automatically parses rules from `.gitignore`, `.npmignore`, `.dockerignore`, `.contextignore`, `.ignore`, and filters `.env*` secrets.
|
|
45
|
-
- **Triple Format Output**: Generates Markdown (`agent.md`), MCP-compatible structured JSON (`agent.json`), and clean YAML (`agent.yaml`).
|
|
46
|
-
- **🔄 Auto-Sync Watch Mode (`-w`)**: Monitors workspace changes and updates context files automatically on save.
|
|
47
|
-
- **Configuration Parity**: Seamlessly reads `context/.context-gen.json` to maintain unified project settings with the Node.js edition.
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## 📦 Installation
|
|
52
|
-
|
|
53
|
-
Install from PyPI using `pip` (or `pipx` / `uv`):
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
pip install context-gen-cli
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## 🚀 Quick Start
|
|
62
|
-
|
|
63
|
-
### 1. ⚡ All-In-One Default Mode (Recommended)
|
|
64
|
-
Generates all formats in `context/` and starts the live auto-sync watcher in background:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
ctx -d
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### 2. Generate All Formats (Markdown, JSON, YAML)
|
|
71
|
-
Scans the current directory and outputs `agent.md`, `agent.json`, and `agent.yaml` in `context/`:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
ctx
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### 3. Quick Refresh / Regenerate
|
|
78
|
-
```bash
|
|
79
|
-
ctx update
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### 4. Custom Format & Output Destination
|
|
83
|
-
```bash
|
|
84
|
-
ctx update -f json
|
|
85
|
-
ctx -o custom_docs/
|
|
86
|
-
ctx -p /path/to/project
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### 5. Watch Mode
|
|
90
|
-
Keep context files fresh automatically on every file edit:
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
ctx -w
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
## 📖 CLI Reference
|
|
99
|
-
|
|
100
|
-
| Flag / Command | Alias | Description |
|
|
101
|
-
| :--- | :--- | :--- |
|
|
102
|
-
| `ctx -d` | `ctx --default` | **⚡ All-in-One**: Generates context files and starts live auto-sync watcher |
|
|
103
|
-
| `ctx -w` | `ctx --watch` | **👀 Watch Mode**: Auto-regenerates context on file changes |
|
|
104
|
-
| `ctx -f <type>` | `ctx --format <type>` | **Format**: `md`, `json`, `yaml`, or `all` |
|
|
105
|
-
| `ctx -o <path>` | `ctx --output <path>` | **Custom Output**: Output file/folder path |
|
|
106
|
-
| `ctx -p <path>` | `ctx --project <path>` | **Target Directory**: Directory to analyze |
|
|
107
|
-
| `ctx update` | — | **Refresh**: Regenerate context files |
|
|
108
|
-
| `ctx --help` | — | View full help options |
|
|
109
|
-
|
|
110
|
-
---
|
|
111
|
-
|
|
112
|
-
## 📄 License
|
|
113
|
-
|
|
114
|
-
MIT © [yakkshit](https://github.com/yakkshit)
|
|
115
|
-
|
context_gen_cli-1.3.3/README.md
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
2
|
-
|
|
3
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
4
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
5
|
-
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
|
|
7
|
-
> ⚡ **Fast, AST-powered Python CLI tool that scans any project, extracts architecture models, and generates structured LLM context (`agent.md`, `agent.json`, `agent.yaml`).**
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## 🌟 Highlights
|
|
12
|
-
|
|
13
|
-
- **⚡ Short Command Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
14
|
-
- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities.
|
|
15
|
-
- **📁 Clean Workspace Storage**: Everything (`agent.md`, `agent.json`, `agent.yaml`, `.context-gen.json`) is saved neatly inside `context/`.
|
|
16
|
-
- **⚡ All-In-One Default Mode (`-d`)**: Auto-generates triple context formats in `context/` and runs a live auto-sync watcher in the background.
|
|
17
|
-
- **`.gitignore` & Multi-Ignore Respect**: Automatically parses rules from `.gitignore`, `.npmignore`, `.dockerignore`, `.contextignore`, `.ignore`, and filters `.env*` secrets.
|
|
18
|
-
- **Triple Format Output**: Generates Markdown (`agent.md`), MCP-compatible structured JSON (`agent.json`), and clean YAML (`agent.yaml`).
|
|
19
|
-
- **🔄 Auto-Sync Watch Mode (`-w`)**: Monitors workspace changes and updates context files automatically on save.
|
|
20
|
-
- **Configuration Parity**: Seamlessly reads `context/.context-gen.json` to maintain unified project settings with the Node.js edition.
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## 📦 Installation
|
|
25
|
-
|
|
26
|
-
Install from PyPI using `pip` (or `pipx` / `uv`):
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
pip install context-gen-cli
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
---
|
|
33
|
-
|
|
34
|
-
## 🚀 Quick Start
|
|
35
|
-
|
|
36
|
-
### 1. ⚡ All-In-One Default Mode (Recommended)
|
|
37
|
-
Generates all formats in `context/` and starts the live auto-sync watcher in background:
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
ctx -d
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### 2. Generate All Formats (Markdown, JSON, YAML)
|
|
44
|
-
Scans the current directory and outputs `agent.md`, `agent.json`, and `agent.yaml` in `context/`:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
ctx
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### 3. Quick Refresh / Regenerate
|
|
51
|
-
```bash
|
|
52
|
-
ctx update
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### 4. Custom Format & Output Destination
|
|
56
|
-
```bash
|
|
57
|
-
ctx update -f json
|
|
58
|
-
ctx -o custom_docs/
|
|
59
|
-
ctx -p /path/to/project
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### 5. Watch Mode
|
|
63
|
-
Keep context files fresh automatically on every file edit:
|
|
64
|
-
|
|
65
|
-
```bash
|
|
66
|
-
ctx -w
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
## 📖 CLI Reference
|
|
72
|
-
|
|
73
|
-
| Flag / Command | Alias | Description |
|
|
74
|
-
| :--- | :--- | :--- |
|
|
75
|
-
| `ctx -d` | `ctx --default` | **⚡ All-in-One**: Generates context files and starts live auto-sync watcher |
|
|
76
|
-
| `ctx -w` | `ctx --watch` | **👀 Watch Mode**: Auto-regenerates context on file changes |
|
|
77
|
-
| `ctx -f <type>` | `ctx --format <type>` | **Format**: `md`, `json`, `yaml`, or `all` |
|
|
78
|
-
| `ctx -o <path>` | `ctx --output <path>` | **Custom Output**: Output file/folder path |
|
|
79
|
-
| `ctx -p <path>` | `ctx --project <path>` | **Target Directory**: Directory to analyze |
|
|
80
|
-
| `ctx update` | — | **Refresh**: Regenerate context files |
|
|
81
|
-
| `ctx --help` | — | View full help options |
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## 📄 License
|
|
86
|
-
|
|
87
|
-
MIT © [yakkshit](https://github.com/yakkshit)
|
|
88
|
-
|
|
@@ -1,115 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: context-gen-cli
|
|
3
|
-
Version: 1.3.3
|
|
4
|
-
Summary: A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json).
|
|
5
|
-
Author: yakkshit
|
|
6
|
-
License-Expression: MIT
|
|
7
|
-
Keywords: llm,context,agent,cli,code-analysis,ast,graph,mcp
|
|
8
|
-
Classifier: Development Status :: 4 - Beta
|
|
9
|
-
Classifier: Environment :: Console
|
|
10
|
-
Classifier: Intended Audience :: Developers
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
-
Classifier: Topic :: Software Development :: Code Generators
|
|
17
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
18
|
-
Requires-Python: >=3.9
|
|
19
|
-
Description-Content-Type: text/markdown
|
|
20
|
-
Requires-Dist: typer[all]>=0.12.0
|
|
21
|
-
Requires-Dist: rich>=13.7.0
|
|
22
|
-
Requires-Dist: pathspec>=0.12.1
|
|
23
|
-
Provides-Extra: dev
|
|
24
|
-
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
25
|
-
Requires-Dist: build>=1.1.0; extra == "dev"
|
|
26
|
-
Requires-Dist: twine>=5.0.0; extra == "dev"
|
|
27
|
-
|
|
28
|
-
# ⚡ context-gen-cli (`ctx`) — Python Edition
|
|
29
|
-
|
|
30
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
31
|
-
[](https://pypi.org/project/context-gen-cli/)
|
|
32
|
-
[](https://opensource.org/licenses/MIT)
|
|
33
|
-
|
|
34
|
-
> ⚡ **Fast, AST-powered Python CLI tool that scans any project, extracts architecture models, and generates structured LLM context (`agent.md`, `agent.json`, `agent.yaml`).**
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## 🌟 Highlights
|
|
39
|
-
|
|
40
|
-
- **⚡ Short Command Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
|
|
41
|
-
- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities.
|
|
42
|
-
- **📁 Clean Workspace Storage**: Everything (`agent.md`, `agent.json`, `agent.yaml`, `.context-gen.json`) is saved neatly inside `context/`.
|
|
43
|
-
- **⚡ All-In-One Default Mode (`-d`)**: Auto-generates triple context formats in `context/` and runs a live auto-sync watcher in the background.
|
|
44
|
-
- **`.gitignore` & Multi-Ignore Respect**: Automatically parses rules from `.gitignore`, `.npmignore`, `.dockerignore`, `.contextignore`, `.ignore`, and filters `.env*` secrets.
|
|
45
|
-
- **Triple Format Output**: Generates Markdown (`agent.md`), MCP-compatible structured JSON (`agent.json`), and clean YAML (`agent.yaml`).
|
|
46
|
-
- **🔄 Auto-Sync Watch Mode (`-w`)**: Monitors workspace changes and updates context files automatically on save.
|
|
47
|
-
- **Configuration Parity**: Seamlessly reads `context/.context-gen.json` to maintain unified project settings with the Node.js edition.
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## 📦 Installation
|
|
52
|
-
|
|
53
|
-
Install from PyPI using `pip` (or `pipx` / `uv`):
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
pip install context-gen-cli
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## 🚀 Quick Start
|
|
62
|
-
|
|
63
|
-
### 1. ⚡ All-In-One Default Mode (Recommended)
|
|
64
|
-
Generates all formats in `context/` and starts the live auto-sync watcher in background:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
ctx -d
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### 2. Generate All Formats (Markdown, JSON, YAML)
|
|
71
|
-
Scans the current directory and outputs `agent.md`, `agent.json`, and `agent.yaml` in `context/`:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
ctx
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### 3. Quick Refresh / Regenerate
|
|
78
|
-
```bash
|
|
79
|
-
ctx update
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### 4. Custom Format & Output Destination
|
|
83
|
-
```bash
|
|
84
|
-
ctx update -f json
|
|
85
|
-
ctx -o custom_docs/
|
|
86
|
-
ctx -p /path/to/project
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### 5. Watch Mode
|
|
90
|
-
Keep context files fresh automatically on every file edit:
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
ctx -w
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
## 📖 CLI Reference
|
|
99
|
-
|
|
100
|
-
| Flag / Command | Alias | Description |
|
|
101
|
-
| :--- | :--- | :--- |
|
|
102
|
-
| `ctx -d` | `ctx --default` | **⚡ All-in-One**: Generates context files and starts live auto-sync watcher |
|
|
103
|
-
| `ctx -w` | `ctx --watch` | **👀 Watch Mode**: Auto-regenerates context on file changes |
|
|
104
|
-
| `ctx -f <type>` | `ctx --format <type>` | **Format**: `md`, `json`, `yaml`, or `all` |
|
|
105
|
-
| `ctx -o <path>` | `ctx --output <path>` | **Custom Output**: Output file/folder path |
|
|
106
|
-
| `ctx -p <path>` | `ctx --project <path>` | **Target Directory**: Directory to analyze |
|
|
107
|
-
| `ctx update` | — | **Refresh**: Regenerate context files |
|
|
108
|
-
| `ctx --help` | — | View full help options |
|
|
109
|
-
|
|
110
|
-
---
|
|
111
|
-
|
|
112
|
-
## 📄 License
|
|
113
|
-
|
|
114
|
-
MIT © [yakkshit](https://github.com/yakkshit)
|
|
115
|
-
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{context_gen_cli-1.3.3 → context_gen_cli-1.3.5}/context_gen_cli.egg-info/dependency_links.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|