Back to Home
CodePrint Docs
v2.1.0

Basic Usage

Scan current directory and save to file:

$ codeprint

Scan with specific format:

$ codeprint -f mcp # Generate MCP format
$ codeprint -f txt # Generate TXT format (default)

Copy to clipboard automatically:

$ codeprint -c

Advanced Usage

$ codeprint -p /path/to/project

Scan specific directory

$ codeprint -o my_snapshot.txt

Custom output file

$ codeprint --include-hidden

Include hidden files

$ codeprint --max-files 1000 --max-file-size 2048 --max-lines 2000

Set custom limits

$ codeprint --no-auto-detect

Disable automatic project detection

$ codeprint --no-gitignore

Disable gitignore patterns

$ codeprint -v

Verbose output

🎯 Project Type Detection

CodePrint automatically detects your project type and applies appropriate ignore patterns:

Project TypeDetection FilesAuto-Ignored
Pythonrequirements.txt, setup.py, pyproject.toml__pycache__, *.pyc, venv/, .egg-info/
JavaScriptpackage.jsonnode_modules/, dist/, *.min.js
TypeScripttsconfig.jsonnode_modules/, dist/, *.d.ts
Javapom.xml, build.gradletarget/, *.class, .gradle/
AndroidAndroidManifest.xml, gradle.propertiesbuild/, *.apk, *.aab
iOSPodfile, *.xcodeprojPods/, *.ipa, DerivedData/
Reactpackage.json + React filesnode_modules/, build/, .next/
.NET*.csproj, *.slnbin/, obj/, packages/
Gogo.modvendor/, *.exe
RustCargo.tomltarget/, Cargo.lock
Flutterpubspec.yamlbuild/, .dart_tool/

📋 Output Formats

TXT Format

Simple text format with file contents and directory structure. Perfect for quick sharing.

MCP Format (Markdown Context Pack)

Structured markdown format with metadata, syntax highlighting, and better organization. Ideal for AI assistants.

⚙️ Configuration

Command-Line Flags

FlagDescriptionDefault
-f, --formatOutput format (txt/mcp)txt
-o, --outputOutput file nameauto-generated
-c, --clipboardCopy to clipboardfalse
-p, --pathPath to scancurrent directory
--max-file-sizeMax file size (KB)1024
--max-filesMax number of files500
--max-linesMax lines per file1000
--include-hiddenInclude hidden filesfalse
--no-gitignoreIgnore .gitignore patternsfalse
--no-auto-detectDisable project type detectionfalse
--no-progressDisable progress outputfalse
--no-parallelDisable parallel processingfalse
-v, --verboseVerbose outputfalse

Environment Variables

export GEMINI_DEFAULT_FORMAT=mcp
export GEMINI_CLIPBOARD=true
export GEMINI_MAX_FILES=1000

🔧 Development

Building from Source

# Clone the repository
$ git clone https://github.com/Tanayk07/codeprint.git
$ cd codeprint
# Install dependencies
$ pip install -r requirements.txt
# Run locally
$ python src/codeprint.py
# Run tests
$ pytest tests/
# Build distributions
$ python setup.py sdist bdist_wheel