Project Syncer

Project Syncer is a command-line interface (CLI) tool designed to simplify working on your project with LLM. You need this tool if you want to bootstrap project drafts from ChatGPT fast or easily apply changes recommended by the chatbot, just ask it to output in a JSON format of FileNode array (see below).

Features

• Export: Generate a JSON representation of your project's file structure, making it easy to share with an LLM.

• Import: Recreate your project's file structure from a JSON string or file received from an LLM to either create a new project or modify it.

• Modify: Make modifications to your project described in a JSON string or file received from an LLM.

• Ignores files from .gitignore: Project sync doesn't export files included in .gitignore.

Format of ChatGPT prompt

To modify your project or create new one using ChatGPT, add this to your prompt:

======

Type to describe modifications to my code is:

interface FileNode {
  path: string; // path to the file relative to the project base
  action?: "delete"; // if node needs to be deleted, action should be "delete"
  content?: string;
}

and the JSON input should be stringified array of FileNode interface.

======

This app is intended for communication with LLM, so it doesn't read binary files!

Usage

Options

Usage:
  prjs [options]

Options:
  --output, -O      Output file path for export (default: stdout)
  --input, -I       Input file path or JSON string for import (default: stdin)
  --base-path, -B   Base path for directory operations (default: current directory)
  --import          Import mode flag (default mode: export)

Installation

npm install -g project-syncer

Export (to create JSON representation of your project to prompt ChatGPT)

# Export to stdout
prjs

# Export to file
prjs -O=output.json

Import (to create file tree and fill files with content or to apply modifications, from JSON string received from ChatGPT)

# Import from stdin
cat /path/to/file.json | project-sync --import

# Import from clipboard (execute the command and paste)
project-sync --import

# Import from file
prjs --import --I=file.json