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

Uploaded Source

Built Distribution

promptify_cli-0.1.6-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: promptify_cli-0.1.6.tar.gz
  • Upload date:
  • Size: 12.4 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.6.tar.gz
Algorithm Hash digest
SHA256 95496ee082624ccc116bbc9526324f0984163de5319c8b04a30216a74715f871
MD5 bc0d447ee534d04ea2e5f45c75b5dd9f
BLAKE2b-256 88976ac193ffb1bf37abcfbaa95487555f105caa84c803c14f6ca63d0867e252

See more details on using hashes here.

File details

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

File metadata

  • Download URL: promptify_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0a439cffb84732ebecbcce7cc317191265811ece03ab4dd60a4e6ae61144decf
MD5 158ebc2a4c9e05d70fa910fbd6ee2fd5
BLAKE2b-256 e8560f60ed67854e2f3ab9d3bed7e8336d5c3dbfa39466c3b14f5b86e3541012

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