# gpt-diff-cli

> Certainly! Below is a `README.md` for your Node.js application which can be used both through npm and Docker:

Latest version **1.0.0** (published 2023-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install gpt-diff-cli
pnpm add gpt-diff-cli
yarn add gpt-diff-cli
bun add gpt-diff-cli
```

Provides the command `gpt-diff-cli`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-08-31 |
| First published | 2023-08-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 19.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kmfb |
| Keywords | gpt, gpt-3, chatgpt, chat-gpt, git, openai |

## Links

- npm: https://www.npmjs.com/package/gpt-diff-cli
- npm.io page: https://npm.io/package/gpt-diff-cli

## Dependencies (4)

- [execa](https://npm.io/package/execa.md) ^8.0.1
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [openai](https://npm.io/package/openai.md) ^4.2.0

## Recent versions

- 1.0.0 (latest) — 2023-08-31

## README

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:

1. Clone the repository:

```bash
git clone https://github.com/your-username/gpt-diff-cli.git
```

2. Navigate to the repository:

```bash
cd gpt-diff-cli
```

3. Install the necessary packages:

```bash
npm install
```

4. Run the application:

```bash
node ./src/index.mjs arg1 arg2
```

### Docker:

1. Build the Docker image:

```bash
docker build -t stardusted/gpt-diff-cli .
```

2. Use the Docker container:

```bash
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:

```bash
docker run -v /Users/tian/repos/gpt-diff-cli:/toBeDiffed stardusted/gpt-diff-cli a309fc20cf85e4273fd9777df72e683ab3d13b32 6a365a532b7b6c04e86834ae21104eac677712f1
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](https://choosealicense.com/licenses/mit/)

---

Make sure to replace placeholders (like the GitHub URL or username) with your actual repository details.

---
_Source: https://npm.io/package/gpt-diff-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._