Interactive CLI to select files, generate markdown for LLM prompts, and copy it to the clipboard.
Project description
Promptify CLI
An interactive CLI to select files, generate markdown suitable for LLM prompts, and copy it to the clipboard.
Installation
pip install promptify-cli
Demo
Basic Usage
Default Behavior
- Run
promptify
to interactively select files and generate markdown for your clipboard - Supports
.promptignore
files (works like.gitignore
) - Offers to add a basic
.promptignore
if none is found at project root. (First time only) - Includes a file tree to depth 4, excluding ignored files
- Selected files (highlighted green) are md-formatted
- Shows LOC and GPT-4o token counts as you use the UI
Help
promptify --help
Option Short Type Description Default --depth
-d
INTEGER Max directory depth (0=root only) 4
--path
-p
DIRECTORY Starting directory path CWD --clear-state
Clear previous selections --install-completion
Install shell completion --show-completion
Show shell completion --help
Show help message and exit
Example Output (Copied to Clipboard)
Project Structure (Depth: 4):
```
example_documentation_project/
├─ foobar/
│ └─ bar.py
├─ foo.py
└─ output.md
```
---
## File: `foo.py`
```python
def foo(bar):
return bar
```
---
## File: `foobar/bar.py`
```python
def bar(foo):
return foo
```
Development
This package is self-contained in 1 file at src/promptify/cli.py
. It's in a state that the UI and features meet my needs, but if you wish to modify the functionality, add more args, etc. drop me a github issue (slow response time) or feel free to submit a merge request!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
promptify_cli-0.1.8.tar.gz
(12.6 kB
view details)
Built Distribution
File details
Details for the file promptify_cli-0.1.8.tar.gz
.
File metadata
- Download URL: promptify_cli-0.1.8.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25c1e23e04889558b6913b01fcc1f49129298be6ae537c270b42ca55dbb6ef72 |
|
MD5 | 4ba7c3cb423f9ccc2072207923da1aca |
|
BLAKE2b-256 | 5ba2e78ce571f9cac1285a6271e2c0e9ce50637f816890bdc778e21dadaf9e76 |
File details
Details for the file promptify_cli-0.1.8-py3-none-any.whl
.
File metadata
- Download URL: promptify_cli-0.1.8-py3-none-any.whl
- Upload date:
- Size: 11.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99791b2912419e71b64de95df1989b3c7afd4d71d28b06ca7178172620c6c33b |
|
MD5 | f950be85c5a1bf916346b6ac45ed0855 |
|
BLAKE2b-256 | 2e2ee8bf0d5c21f13c3a4176bc4ff590c09520fe636891416ab2c4fad48cf60e |