code2prompt 命令

常用示例

说明

code2prompt transforms a source tree into a structured prompt for Large Language Models (LLMs). It recursively traverses a codebase, respects `.gitignore`, and formats files along with a file-tree overview. The output is copied to the clipboard by default. Handlebars templates let you customize the generated prompt for specific workflows such as code review, documentation, refactoring, or PR description drafting. Token counting using tiktoken-compatible encodings helps keep prompts within model context limits. Git integrations (`--diff`, `--git-diff-branch`, `--git-log-branch`) make it easy to generate prompts focused on recent changes rather than the entire codebase.

参数

-t, --template _FILE_

Path to a custom Handlebars template file.

--include _PATTERNS_

Comma-separated glob patterns of files to include.

--exclude _PATTERNS_

Comma-separated glob patterns of files to exclude.

--exclude-from-tree

Remove excluded files from the source tree display.

--output-file _FILE_

Write the generated prompt to a file instead of the clipboard.

--tokens

Display token count of the generated prompt.

--encoding _NAME_

Tokenizer to use: cl100k (default), p50k, p50k_edit, r50k_base.

--json

Output results in JSON format.

--diff

Include the git diff of staged files.

--git-diff-branch _BRANCH_

Include the diff between branches.

--git-log-branch _BRANCH_

Include the git log for a branch.

--line-number

Prefix source lines with line numbers.

--no-codeblock

Do not wrap code in markdown fenced blocks.