# terminal-ai

> Terminal-based AI assistant for developers.

Latest version **1.0.3** (published 2023-10-10) · GNU General Public License v3.0 license · 0 weekly downloads

## Install

```sh
npm install terminal-ai
pnpm add terminal-ai
yarn add terminal-ai
bun add terminal-ai
```

Provides the command `tai`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-10-10 |
| First published | 2023-10-10 |
| Weekly downloads | 0 |
| License | GNU General Public License v3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 37.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | coderhashtag03 |

## Links

- npm: https://www.npmjs.com/package/terminal-ai
- Repository: https://github.com/cdnjmusic/Terminal-AI
- Homepage: https://github.com/cdnjmusic/Terminal-AI#readme
- Issues: https://github.com/cdnjmusic/Terminal-AI/issues
- npm.io page: https://npm.io/package/terminal-ai

## Dependencies (2)

- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [openai](https://npm.io/package/openai.md) ^4.11.1

## Recent versions

- 1.0.3 (latest) — 2023-10-10
- 1.0.2 — 2023-10-10
- 1.0.1 — 2023-10-10
- 1.0.0 — 2023-10-10

## README

# Terminal-AI

Terminal-AI is a terminal-based AI assistant for NodeJS users. It provides a simple interface to interact with OpenAI's GPT-3 model. Follow the steps below to install and configure the app.

## Installation

1. Create a new Node.js project or navigate to an existing project's directory where you want to use Terminal-AI.

2. Install Terminal-AI as a dependency using npm:

   ```bash
   npm install terminal-ai
   ```

## Configuration

3. Inside your project's directory, locate `./node_modules/terminal-ai` and create a `.env` file. This file is used to store sensitive information, i.e., your OpenAI API key.

4. Open the `.env` file and add your OpenAI API key as follows:

   ```
   OPENAI_API_KEY=<your-api-key>
   ```

   Replace `<your-api-key>` with your actual OpenAI API key.

## Running Terminal-AI

5. Open your project's `package.json` file located in the root directory.

6. In the `scripts` section of your `package.json`, add a script that uses Terminal-AI. For example, to run Terminal-AI with the prompt "hello," add the following script:

   ```json
   "scripts": {
     "tai": "cd node_modules/terminal-ai && npm start"
   }
   ```

   You can customize the prompt by changing `"hello"` to any other prompt you'd like to use.

7. Save your `package.json` file.

## Usage

Now that you've configured Terminal-AI, you can run it by executing the following command in your terminal:

```bash
npm run tai <prompt>
```

Terminal-AI will start, and you can interact with it by providing prompts.

## Support

If you encounter any issues or have questions, please [open an issue on GitHub](https://github.com/cdnjmusic/Terminal-AI/issues).

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