Skip to main content

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

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)
  • 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.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

promptify_cli-0.1.4-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file promptify_cli-0.1.4.tar.gz.

File metadata

  • Download URL: promptify_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for promptify_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 7103c605f7c28510e81b82be55c0b661d62ad5e027e4effab4ef358ede9c5a11
MD5 15188e1265ec3c7c11e1ea879e978ccb
BLAKE2b-256 a4f96664e9daf998fd45970a9de2ff3ad9928c57fdc94af9508c5b027d44b20e

See more details on using hashes here.

File details

Details for the file promptify_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: promptify_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for promptify_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 849a40e6eed6ec4d0461256c880e01af7e8fe2ca2f52b0282095fcb30ae7ffcf
MD5 5347f7c06f27c0da6639e6629f71c54c
BLAKE2b-256 e831f14b6f89be1d108a11d051ca8d29a71414c979090e977b2dbc580857f267

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page