One-Click Context Toolkit - visual file trees + AI summaries
Project description
One-Click Context Toolkit 🗂️✨
Visual file trees & inline code commentary for any project — in one command.
Features
| Flag / Sub-feature | What it does |
|---|---|
--fmt text (default) |
Classic Unicode tree in the terminal |
--fmt md |
Collapsible Markdown ready for GitHub / PRs |
--fmt json |
Machine-readable nested dict |
--fmt html |
Expandable <ul><li> list for web/docs |
--list-scripts .py .ts |
Prints full source of matching files |
--depth N |
Limit recursion (default = 3) |
--suppress node_modules |
Skip noisy folders (case-insensitive) |
Installation
# recommended
pipx install oneclick-context
# or plain pip
python -m pip install --upgrade oneclick-context
```Requires Python 3.10+.
`pipx` keeps the tool isolated in its own virtual-env & puts `oneclick` on your PATH.
## Quick start
#### 1. Plain-text tree
```bash
oneclick . --depth 2
``````css
├── src
│ └── oneclick_context
├── tests
│ └── test_cli.py
└── pyproject.toml
2. Paste-ready Markdown
oneclick . --depth 2 --fmt md
``````html
<details><summary>📁 my-project</summary>
├── src
│ └── ...
└── pyproject.toml
</details>
3. JSON (pipe to jq)
oneclick . --fmt json | jq .
``````jsonc
{
"type": "dir",
"name": "my-project",
"children": [
{ "type": "file", "name": "pyproject.toml", "children": [] }
]
}
4. HTML
oneclick . --fmt html > tree.html && start tree.html
5. Print out all scripts
oneclick . --list-scripts .py .ts .yaml > SCRIPTS.md
Combine with depth / suppress flags:
oneclick . --depth 3 --suppress node_modules dist .git \
--list-scripts .py .sh
Why?
- LLM context compression — shrink 50 KLOC into a 1-page digest for ChatGPT, Claude, etc.
- Lightning-fast code reviews — drop the Markdown tree in a PR comment.
- Docs & onboarding — generate an instant project map for new teammates.
Roadmap
- GPT-powered file summaries (
--summarise) - VS Code extension panel
- SVG / Graphviz exporter
Contributing
PRs and issues welcome!
poetry install
poetry run pytest -q
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oneclick_context-0.2.2.tar.gz.
File metadata
- Download URL: oneclick_context-0.2.2.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.11.13 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
536dd7d874900a4f5c5c056cc473f14dbd34dd3b02a747b099ed13665d54d956
|
|
| MD5 |
8562c783512eadb49f6b8897e9819fae
|
|
| BLAKE2b-256 |
272384cdd86b538d9685024b320ce011c6f27c4a07274f260d48b387d648ec5a
|
File details
Details for the file oneclick_context-0.2.2-py3-none-any.whl.
File metadata
- Download URL: oneclick_context-0.2.2-py3-none-any.whl
- Upload date:
- Size: 8.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.11.13 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3933cb1b3d9347966b05ce17e71c318ca29caced840e1ec1536804ed1c6102ce
|
|
| MD5 |
ae02be486d7b81c165a0f0475e30ea8a
|
|
| BLAKE2b-256 |
b8a57c44aa0bb9dc507914bfc56b6f94f0f049d6f5493fe3e79f6ed8f8db8ebe
|