infinitered
v0.0.2
Published
Infinite Red's internal CLI
Downloads
1
Readme
infinitered CLI
A CLI for Infinite Red, with functionality we use internally.
Commands
npx infinitered transcribe <filename>
Alias: t
Transcribes the given audio file and writes the transcription to a text file with the same name.
This uses OpenAI's whisper-1
model.
We primarily use this for transcribing React Native Radio's podcast episodes.
Options:
--format
: The response format you want the transcription in (default is 'json').--prompt
: An optional prompt to include in the transcription request.
Environment:
OPENAI_API_KEY
: You must set this environment variable with your OpenAI API key.
Example Usage:
The filename is required. All --options are optional.
# can also be set in .zshrc file or similar
export OPENAI_API_KEY=yourkeyhere
# transcribe a file
npx infinitered transcribe myfile.mp3 --format=json --prompt="Optional prompt" --output=mytranscription.txt
Make sure you have set the OPENAI_API_KEY
in your environment before running the command.
Working on the CLI
Clone it down:
git clone [email protected]:infinitered/infinitered-cli.git
Install dependencies:
cd infinitered-cli
yarn
Link the CLI:
yarn link
Now you can run the CLI from anywhere:
ir transcribe <filename>
# or
infinitered transcribe <filename>
infinitered-cli is powered by Gluegun. See Gluegun's docs for more information on how to use it.
Publishing to NPM
To package your CLI up for NPM, do this:
$ yarn login
$ yarn whoami
$ yarn test
$ yarn build
$ yarn publish
License
MIT - see LICENSE