$ docker run -it --rm rust:latest bash

$ cargo install code2prompt

$ code2prompt --help
Usage: code2prompt [OPTIONS] <PATH>

Arguments:
  <PATH>
          Path to the codebase directory

Options:
      --include <INCLUDE>
          Patterns to include

      --exclude <EXCLUDE>
          Patterns to exclude

      --include-priority
          Include files in case of conflict between include and exclude patterns

      --exclude-from-tree
          Exclude files/folders from the source tree based on exclude patterns

      --tokens
          Display the token count of the generated prompt

  -c, --encoding <ENCODING>
          Optional tokenizer to use for token count

          Supported tokenizers: cl100k (default), p50k, p50k_edit, r50k, gpt2

  -o, --output <OUTPUT>
          Optional output file path

  -d, --diff
          Include git diff

      --git-diff-branch <BRANCHES>
          Generate git diff between two branches

      --git-log-branch <BRANCHES>
          Retrieve git log between two branches

  -l, --line-number
          Add line numbers to the source code

      --no-codeblock
          Disable wrapping code inside markdown code blocks

      --relative-paths
          Use relative paths instead of absolute paths, including the parent directory

      --no-clipboard
          Optional Disable copying to clipboard

  -t, --template <TEMPLATE>
          Optional Path to a custom Handlebars template

      --json
          Print output as JSON

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

$ git clone https://github.com/streamlit/chatbot-template

$ code2prompt chatbot-template

▹▹▹▹▸ Done!
[!] Failed to copy to clipboard: Failed to initialize clipboard: Unknown error while interacting with the clipboard: X11 server connection timed out because it was unreachable

Project Path: chatbot-template

Source Tree:

```
chatbot-template
├── streamlit_app.py
├── requirements.txt
├── LICENSE
└── README.md

```

`/chatbot-template/streamlit_app.py`:

```py
import streamlit as st
from openai import OpenAI

# Show title and description.
st.title("💬 Chatbot")
st.write(
    "This is a simple chatbot that uses OpenAI's GPT-3.5 model to generate responses. "
(snip)

$ code2prompt chatbot-template --output=output.txt

(snip)
[✓] Prompt written to file: output.txt

$ head -5 output.txt
Project Path: chatbot-template

Source Tree:

```

$ code2prompt chatbot-template --tokens --encoding=cl100k | head -5

▹▹▹▹▸ Done!
[i] Token count: 3049, Model info: ChatGPT models, text-embedding-ada-002
(snip)

# code2prompt chatbot-template --include="*.py"

Project Path: chatbot-template

Source Tree:

```
chatbot-template
├── streamlit_app.py
├── requirements.txt
├── LICENSE
└── README.md

```

`/chatbot-template/streamlit_app.py`:

```py
import streamlit as st
from openai import OpenAI
(snip)

$ code2prompt chatbot-template --exclude="*.py"

Project Path: chatbot-template

Source Tree:

```
chatbot-template
├── streamlit_app.py
├── requirements.txt
├── LICENSE
└── README.md

```

`/chatbot-template/requirements.txt`:

```txt
streamlit
openai
```

`/chatbot-template/LICENSE`:
(snip)

$ find /usr/local -type f -name "**.hbs" | grep code2prompt
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/src/default_template.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/binary-exploitation-ctf-solver.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/document-the-code.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/write-github-pull-request.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/write-git-commit.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/write-github-readme.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/clean-up-code.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/cryptography-ctf-solver.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/find-security-vulnerabilities.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/refactor.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/improve-performance.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/reverse-engineering-ctf-solver.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/fix-bugs.hbs
/usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/web-ctf-solver.hbs

$ code2prompt chatbot-template -t /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/code2prompt-2.0.0/templates/clean-up-code.hbs

Project Path: chatbot-template

I'd like your help cleaning up and improving the code quality in this project. Please review all the code files carefully:

Source Tree:
```
chatbot-template
├── streamlit_app.py
├── requirements.txt
├── LICENSE
└── README.md

```

`/chatbot-template/streamlit_app.py`:

```py
import streamlit as st
from openai import OpenAI
(snip)

When reviewing the code, look for opportunities to improve:
- Readability and clarity
- Adherence to language idioms and best practices
- Modularity and code organization
- Efficiency and performance (within reason)
- Consistency in style and conventions
- Error handling and reliability
- Simplicity (remove unused code, simplify complex logic)
- Naming of variables, functions, classes, etc.
- Formatting and whitespace
- Comments and documentation

Make sure your changes don't alter existing behavior (except perhaps for improved error handling). Try to infer the original intent as much as possible, and refactor towards that intent.

For each change you make, include a brief code comment explaining your rationale, something like:

// Refactored to improve readability and efficiency.
// Combined error handling logic into a reusable function.

Be thoughtful and judicious with your changes. I trust your programming expertise! Let me know if any part of the original code is unclear.

Project Path: {{ absolute_code_path }}

I'd like your help cleaning up and improving the code quality in this project. Please review all the code files carefully:

Source Tree:
```
{{ source_tree }}
```

{{#each files}}
{{#if code}}
`{{path}}`:

{{code}}

{{/if}}
{{/each}}

When reviewing the code, look for opportunities to improve:
- Readability and clarity
- Adherence to language idioms and best practices
- Modularity and code organization
- Efficiency and performance (within reason)
- Consistency in style and conventions
- Error handling and reliability
- Simplicity (remove unused code, simplify complex logic)
- Naming of variables, functions, classes, etc.
- Formatting and whitespace
- Comments and documentation

Make sure your changes don't alter existing behavior (except perhaps for improved error handling). Try to infer the original intent as much as possible, and refactor towards that intent.

For each change you make, include a brief code comment explaining your rationale, something like:

// Refactored to improve readability and efficiency.
// Combined error handling logic into a reusable function.

Be thoughtful and judicious with your changes. I trust your programming expertise! Let me know if any part of the original code is unclear.