https://github.com/matigumma/voiceai

https://github.com/matigumma/voiceai

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/matigumma/voiceai
• Owner: matigumma
• Created: 2024-07-25T19:42:02.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-26T01:22:40.000Z (5 months ago)
• Last Synced: 2024-07-26T22:49:30.324Z (5 months ago)
• Language: Python
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Leer

Leer is a command-line tool that helps you reading output using OpenAI TTS.

## Installation

Follow these steps to install and set up Leer:

1. Make the script executable:

```sh

chmod +x leer.py

```

2. Create a symbolic link to make it accessible from anywhere:

```sh

sudo ln -s $(pwd)/leer.py /usr/local/bin/leer

```

3. Add `/usr/local/bin` to your PATH if it's not already included:

```sh

export PATH=$PATH:/usr/local/bin

```

4. Source your shell configuration to apply the changes:

```sh

source ~/.zshrc

```

5. Set your OpenAI API key:

```sh

export OPENAI_API_KEY=your_openai_api_key_here

```

## Usage

To use Leer, simply run:

```sh

echo "text to read" | leer

```

## Configuration

Make sure to replace `your_openai_api_key_here` with your actual OpenAI API key. You can add this line to your `~/.zshrc` or `~/.bashrc` to set the API key permanently:

```sh

export OPENAI_API_KEY=sk-your_openai_api_key_here

```

## Contributing

welcomed

## Acknowledgments

- [OpenAI](https://www.openai.com/) for providing the API.