chatporter
v1.0.0
Published
Import repositories and directories from your local machine into v0.dev chats
Maintainers
Readme
ChatPorter 🚀
Import repositories and directories from your local machine into v0.dev chats
ChatPorter is a CLI utility that imports your local codebases, repositories, and directories directly into v0.dev chats via the Platform API. Perfect for bringing your entire project context into v0 for AI-assisted development, code review, and technical discussions.
Features
- 📁 Import local directories - Bring your entire local codebase into v0.dev
- 📦 Import GitHub repositories - Import repos directly from GitHub URLs
- 📎 Import zip archives - Import code from zip archive URLs
- 📄 Upload individual files - Import specific markdown or code files
- 🚀 Create v0 chats via Platform API - Directly creates chats in v0.dev
- 🔗 Automatic browser opening - Opens your new chat automatically
- 🔒 File locking options - Lock files to prevent AI modifications
- ⚡ Fast, lightweight, zero-config CLI
Installation
npm install -g chatporterOr use it directly with npx:
npx chatporterQuick Start
Import Local Directory (Most Common!)
# Set your API key first
export V0_API_KEY=your_api_key_here
# Import entire local directory into v0
chatporter dir ./my-project
# With custom chat name
chatporter dir ./my-project --name "My Project"Import GitHub Repository
# Set your API key first
export V0_API_KEY=your_api_key_here
# Import entire GitHub repository
chatporter repo https://github.com/username/my-project
# With custom branch and name
chatporter repo https://github.com/username/my-project --branch develop --name "My Project Dev"
# Lock all files from AI modification
chatporter repo https://github.com/username/my-project --lock-all-filesImport Zip Archive
# Import from zip URL
chatporter zip https://github.com/username/project/archive/main.zip
# With custom name
chatporter zip https://github.com/username/project/archive/main.zip --name "Project Archive"Upload Individual Files
# Create v0 chat from markdown files
chatporter upload docs/*.md --platform v0 --api
# With custom name and locked files
chatporter upload docs/*.md --platform v0 --api --name "Project Docs" --lock-filesInteractive mode
chatporterThis will prompt you to:
- Select files to upload
- Choose your target platform (v0 API, v0 formatted, ChatGPT, Claude, etc.)
- Create chat via API or generate formatted output
Usage
Basic Upload
chatporter upload <file1> [file2] [file3...]Format for Specific Platform
chatporter upload docs/timeline.md --platform v0
chatporter upload docs/task-list.md --platform chatgptOutput to File
chatporter upload docs/*.md --output formatted-context.txtOpen Directly
chatporter upload docs/spec.md --open v0Configuration
Environment Variables
Create a .env file in your project root:
V0_API_KEY=your_v0_api_key_hereGet your API key from: https://v0.app/settings/api
Config File
Create a .chatporterrc.json file in your project root:
{
"defaultPlatform": "v0",
"includeMetadata": true,
"format": "concise",
"maxFileSize": "10MB"
}Examples
Import Local Codebase (Primary Use Case)
# Import your local project directory
chatporter dir ./my-project
# Import with custom name
chatporter dir ./my-project --name "Production Codebase"
# Import and lock all files from modification
chatporter dir ./my-project --lock-all-filesImport from GitHub
# Import GitHub repository
chatporter repo https://github.com/yourusername/your-project
# Import specific branch
chatporter repo https://github.com/yourusername/your-project --branch developImport from Zip Archive
# Import from zip URL
chatporter zip https://github.com/user/repo/archive/main.zipUpload Individual Files
# Upload markdown files to v0
chatporter upload docs/*.md --platform v0 --api
# Upload specific files with custom name
chatporter upload docs/timeline.md docs/task-list.md --platform v0 --api --name "Project Timeline"How It Works
- Scans your local directory or repository for files
- Reads all code and documentation files (excluding node_modules, .git, etc.)
- Uploads files to v0.dev via the Platform API
- Creates a new chat session with your codebase as context
- Opens the chat in your browser automatically
Platform Support
- ✅ v0.dev (Primary) - Direct API integration for creating chats
- 📝 Formatted output - Also supports generating formatted text for ChatGPT, Claude, Cursor AI
License
MIT
Contributing
This is a standalone utility. Feel free to fork and adapt for your needs!
