| Name | pluk JSON |
| Version |
0.1.2.1
JSON |
| download |
| home_page | None |
| Summary | Symbol lookup / search engine CLI |
| upload_time | 2025-08-03 21:25:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.13.5 |
| license | MIT |
| keywords |
symbol
search
cli
index
lookup
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PLUK
**Pluk** is a minimal, backend-first symbol lookup and cross-reference engine CLI.
Index git-tracked code, search symbols, see definitions/usages, and compute impact/blast-radius impact chains.
## Quick install
### Unix / Linux / macOS (or Git Bash on Windows)
```bash
curl -sSL https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.sh | bash
```
### Windows (PowerShell)
```powershell
pwsh -NoProfile -ExecutionPolicy Bypass -Command "Invoke-Expression (Invoke-WebRequest https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.ps1).Content)"
```
## Verify installer (optional)
```bash
curl -sSL https://github.com/Jorstors/pluk/releases/download/v0.1.1/pluk.sh.sha256 -o pluk.sh.sha256
curl -sSL https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.sh -o pluk.sh
sha256sum -c pluk.sh.sha256
```
## Basic usage
After the bootstrapper has run (it brings up the service via Docker Compose):
```bash
pluk start # run API + worker
pluk init ./path/to/repo # index a git repository
pluk search <symbol> # fuzzy lookup
pluk define <symbol> # show definition + references
pluk impact <symbol> # show downstream impact
pluk diff --from A --to B # compare commits
pluk status # health & repo status
pluk doctor # diagnostics
```
## Development
Editable/development install and test:
```bash
python -m pip install --upgrade build
python -m build
pip install -e .
pytest
```
## Releases
Tagging a semantic version like `v0.1.1` triggers the release workflow, publishing `pluk.sh`, `pluk.ps1`, and their checksums. Users can install a specific version via the jsDelivr URLs above.
## Requirements
- Docker with `docker compose` (v2+)
- Git (for target repositories)
- Python (for development/testing, optional for users using embedded CLI)
## License
## MIT © Justus Jones
Raw data
{
"_id": null,
"home_page": null,
"name": "pluk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13.5",
"maintainer_email": null,
"keywords": "symbol, search, cli, index, lookup",
"author": null,
"author_email": "Justus Jones <Justus1274@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2a/5b/649cadeae021196288dc78226207e6103137c4c305d42f2840ae7e921d05/pluk-0.1.2.1.tar.gz",
"platform": null,
"description": "# PLUK\n\n**Pluk** is a minimal, backend-first symbol lookup and cross-reference engine CLI.\nIndex git-tracked code, search symbols, see definitions/usages, and compute impact/blast-radius impact chains.\n\n## Quick install\n\n### Unix / Linux / macOS (or Git Bash on Windows)\n\n```bash\ncurl -sSL https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.sh | bash\n```\n\n### Windows (PowerShell)\n\n```powershell\npwsh -NoProfile -ExecutionPolicy Bypass -Command \"Invoke-Expression (Invoke-WebRequest https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.ps1).Content)\"\n```\n\n## Verify installer (optional)\n\n```bash\ncurl -sSL https://github.com/Jorstors/pluk/releases/download/v0.1.1/pluk.sh.sha256 -o pluk.sh.sha256\ncurl -sSL https://cdn.jsdelivr.net/gh/Jorstors/pluk@v0.1.1/pluk.sh -o pluk.sh\nsha256sum -c pluk.sh.sha256\n```\n\n## Basic usage\n\nAfter the bootstrapper has run (it brings up the service via Docker Compose):\n\n```bash\npluk start # run API + worker\npluk init ./path/to/repo # index a git repository\npluk search <symbol> # fuzzy lookup\npluk define <symbol> # show definition + references\npluk impact <symbol> # show downstream impact\npluk diff --from A --to B # compare commits\npluk status # health & repo status\npluk doctor # diagnostics\n```\n\n## Development\n\nEditable/development install and test:\n\n```bash\npython -m pip install --upgrade build\npython -m build\npip install -e .\npytest\n```\n\n## Releases\n\nTagging a semantic version like `v0.1.1` triggers the release workflow, publishing `pluk.sh`, `pluk.ps1`, and their checksums. Users can install a specific version via the jsDelivr URLs above.\n\n## Requirements\n\n- Docker with `docker compose` (v2+)\n- Git (for target repositories)\n- Python (for development/testing, optional for users using embedded CLI)\n\n## License\n\n## MIT \u00a9 Justus Jones\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Symbol lookup / search engine CLI",
"version": "0.1.2.1",
"project_urls": null,
"split_keywords": [
"symbol",
" search",
" cli",
" index",
" lookup"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1ea32bc6163cac36bf2bed408a906e5ac9bb008c3d03dbecf27c5825a11f10b6",
"md5": "a87b6fa68e80fb94e04d81c9bbec38b3",
"sha256": "accdc1eb857bcf96382910c247b4a3878b296d44d378c56d95ff14db3e0101a5"
},
"downloads": -1,
"filename": "pluk-0.1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a87b6fa68e80fb94e04d81c9bbec38b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13.5",
"size": 3484,
"upload_time": "2025-08-03T21:25:37",
"upload_time_iso_8601": "2025-08-03T21:25:37.812863Z",
"url": "https://files.pythonhosted.org/packages/1e/a3/2bc6163cac36bf2bed408a906e5ac9bb008c3d03dbecf27c5825a11f10b6/pluk-0.1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2a5b649cadeae021196288dc78226207e6103137c4c305d42f2840ae7e921d05",
"md5": "abb7a9b4233c4fa09a0b809a2c8d2780",
"sha256": "a6de5862c31e448bd36f56dd957f9949f1eab9a05f60010ff2e9017253fe438b"
},
"downloads": -1,
"filename": "pluk-0.1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "abb7a9b4233c4fa09a0b809a2c8d2780",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13.5",
"size": 3234,
"upload_time": "2025-08-03T21:25:38",
"upload_time_iso_8601": "2025-08-03T21:25:38.604521Z",
"url": "https://files.pythonhosted.org/packages/2a/5b/649cadeae021196288dc78226207e6103137c4c305d42f2840ae7e921d05/pluk-0.1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-03 21:25:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pluk"
}
