gpt-diff-cli
v1.0.0
Published
Certainly! Below is a `README.md` for your Node.js application which can be used both through npm and Docker:
Downloads
4
Maintainers
kmfbReadme
Certainly! Below is a README.md for your Node.js application which can be used both through npm and Docker:
GPT Diff CLI
A command line tool to diff between various changesets using advanced algorithms. Works with npm as well as Docker.
Prerequisites
- Node.js (for npm usage)
- Docker (for Docker usage)
Installation & Usage
NPM:
- Clone the repository:
git clone https://github.com/your-username/gpt-diff-cli.git- Navigate to the repository:
cd gpt-diff-cli- Install the necessary packages:
npm install- Run the application:
node ./src/index.mjs arg1 arg2Docker:
- Build the Docker image:
docker build -t stardusted/gpt-diff-cli .- Use the Docker container:
docker run -v /path/to/your/directory:/toBeDiffed stardusted/gpt-diff-cli <commit_id1> <commit_id2>Replace /path/to/your/directory with the actual path to your repository or the directory you want to use with the CLI. Replace <commit_id1> and <commit_id2> with the actual commit IDs you want to diff.
Example:
docker run -v /Users/tian/repos/gpt-diff-cli:/toBeDiffed stardusted/gpt-diff-cli a309fc20cf85e4273fd9777df72e683ab3d13b32 6a365a532b7b6c04e86834ae21104eac677712f1Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
Make sure to replace placeholders (like the GitHub URL or username) with your actual repository details.