# gpt-doc-cli

> CLI for generating documentation from code using GPT

Latest version **1.0.1** (published 2023-04-09) · 0 weekly downloads

## Install

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

Provides the command `gpt-doc-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.1 |
| Published | 2023-04-09 |
| First published | 2023-04-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | pshenok |

## Links

- npm: https://www.npmjs.com/package/gpt-doc-cli
- Repository: https://github.com/pshenok/gpt-doc-cli
- Homepage: https://github.com/pshenok/gpt-doc-cli#readme
- Issues: https://github.com/pshenok/gpt-doc-cli/issues
- npm.io page: https://npm.io/package/gpt-doc-cli

## Dependencies (2)

- [yargs](https://npm.io/package/yargs.md) ^17.7.1
- [openai](https://npm.io/package/openai.md) ^3.2.1

## Recent versions

- 1.0.1 (latest) — 2023-04-09
- 1.0.0 — 2023-04-09

## README

# GPT Doc CLI

A command-line interface (CLI) for generating technical documentation from code using OpenAI's GPT model.

## Installation

To install the package globally, run:

```bash
npm install -g gpt-doc-cli
```

## Usage
### Using globally installed package

To generate technical documentation from a code file, run the following command:
```bash
gpt-doc-cli --path="path/to/your/codefile.ext" --api-key="your_openai_api_key"
```

### Using npx (without installing globally)

To generate technical documentation from a code file without installing the package globally, run the following command:
```bash
npx gpt-doc-cli --path="path/to/your/codefile.ext" --api-key="your_openai_api_key"
```

Replace `path/to/your/codefile.ext` with the path to your code file and `your_openai_api_key` with your OpenAI API key.

The CLI supports various file types, and the language is determined based on the file extension.

A Markdown file (.md) containing the generated technical documentation will be created in the same directory as the input code file. The name of the documentation file will be the same as the code file, but with a .md extension.

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