Deepgram CLI

!Deepgram CLI


> This project is currently ALPHA and is in active development. Commands are likely to change without warning or deprecation.

This is the Deepgram CLI. It is used to interact with Deepgram from the command line. It is built using oclif.

- For more about Deepgram see https://www.deepgram.com.
- To get started using Deepgram sign up for a free account and get 12,000 minutes free!

Issues

- For problems directly related to the CLI, add an issue on GitHub.
- For other questions using the Deepgram, post a question in our Community Forum.

Usage

``sh-session
$ npm install -g @deepgram/cli
$ deepgram COMMAND
running command...
$ deepgram (--version)
@deepgram/cli/0.4.0-beta.0 darwin-x64 node-v16.13.0
$ deepgram --help [COMMAND]
USAGE
$ deepgram COMMAND
...
`


Commands


* [deepgram help [COMMANDS]](#deepgram-help-commands)
* deepgram setup
* deepgram summary
* deepgram transcribe

deepgram help [COMMANDS]

Display help for deepgram.

`
USAGE
$ deepgram help [COMMANDS] [-n]

ARGUMENTS
COMMANDS Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for deepgram.
`

_See code: @oclif/plugin-help_

deepgram setup

Setup the CLI using a Deepgram API key.

`
USAGE
$ deepgram setup [-k ] [-s ] [-t ]

FLAGS
-k, --key= https://dpgr.am/api-key
-s, --scopes= [default: member] https://dpgr.am/scopes
-t, --ttl= [default: 86400] https://dpgr.am/ttl

DESCRIPTION
Setup the CLI using a Deepgram API key.

FLAG DESCRIPTIONS
-k, --key= https://dpgr.am/api-key

An API key provided by Deepgram.

-s, --scopes= https://dpgr.am/scopes

Comma separated string of Deepgram API scopes.

-t, --ttl= https://dpgr.am/ttl

How many seconds you should remain logged in with the Deepgram CLI. Default: 86400
`

_See code: dist/commands/setup/index.js_

deepgram summary

Summarize any audio or video using just one command.

`
USAGE
$ deepgram summary [--data-url | --mimetype ] [--data-binary ]

MEDIA SOURCE FLAGS
--data-binary= https://dpgr.am/data-binary
--data-url= https://dpgr.am/data-url
--mimetype= Mimetype of local audio or video file

DESCRIPTION
Summarize any audio or video using just one command.

FLAG DESCRIPTIONS
--data-binary= https://dpgr.am/data-binary

Filepath of local audio or video file

--data-url= https://dpgr.am/data-url

URL of an audio or video file
`

_See code: dist/commands/summary/index.js_

deepgram transcribe

Transcribe audio/video straight from the command line

`
USAGE
$ deepgram transcribe [--data-url | --mimetype ] [--data-binary ] [--no-transcript |
--paragraphs | | --smart_format | [--json | [--vtt --utterances] | [--srt ]]] [--model ] [--version ]
[--tier ] [--replace ] [--language ] [--punctuate] [--profanity_filter] [--redact ]
[--diarize] [--multichannel] [--search ] [--callback ] [--keywords ] [--keyword_boost]
[--utt_split ] [--detect_language] [--detect_entities] [--summarize] [--detect_topics] [--tag ]

DEEPGRAM FEATURES FLAGS
--callback= https://dpgr.am/callback
--detect_entities https://dpgr.am/detect_entities
--detect_language https://dpgr.am/detect_language
--detect_topics https://dpgr.am/detect_topics
--diarize https://dpgr.am/diarize
--keyword_boost https://dpgr.am/keyword_boost
--keywords=... https://dpgr.am/keywords
--language= https://dpgr.am/language
--model= https://dpgr.am/model
--multichannel https://dpgr.am/multichannel
--paragraphs https://dpgr.am/paragraphs
--profanity_filter https://dpgr.am/profanity_filter
--punctuate https://dpgr.am/punctuate
--redact=... https://dpgr.am/redact
--replace=... https://dpgr.am/replace
--search=... https://dpgr.am/search
--smart_format https://dpgr.am/smart_format
--summarize https://dpgr.am/summarize
--tag=... https://dpgr.am/tag
--tier= https://dpgr.am/tier
--utt_split= https://dpgr.am/utt_split
--utterances https://dpgr.am/utterances
--version= https://dpgr.am/version

MEDIA SOURCE FLAGS
--data-binary= https://dpgr.am/data-binary
--data-url= https://dpgr.am/data-url
--mimetype= Mimetype of local audio or video file

FORMATTING FLAGS
--json Output JSON format of the response. This comes verbatim from the API
--no-transcript Disable transcript so you can output understanding features
--srt Output SRT formatted captions. This requires utterances
--vtt Output WebVTT formatted captions. This requires utterances

DESCRIPTION
Transcribe audio/video straight from the command line

FLAG DESCRIPTIONS
--callback= https://dpgr.am/callback

Deepgram feature: callback

--data-binary= https://dpgr.am/data-binary

Filepath of local audio or video file

--data-url= https://dpgr.am/data-url

URL of an audio or video file

--detect_entities https://dpgr.am/detect_entities

Deepgram feature: detect_entities

--detect_language https://dpgr.am/detect_language

Deepgram feature: detect_language

--detect_topics https://dpgr.am/detect_topics

Deepgram feature: detect_topics

--diarize https://dpgr.am/diarize

Deepgram feature: diarize

--keyword_boost https://dpgr.am/keyword_boost

Deepgram feature: keyword_boost

--keywords=... https://dpgr.am/keywords

Deepgram feature: keywords

--language= https://dpgr.am/language

Deepgram feature: language

--model= https://dpgr.am/model

Deepgram feature: model

--multichannel https://dpgr.am/multichannel

Deepgram feature: multichannel

--paragraphs https://dpgr.am/paragraphs

Deepgram feature: paragraphs

--profanity_filter https://dpgr.am/profanity_filter

Deepgram feature: profanity_filter

--punctuate https://dpgr.am/punctuate

Deepgram feature: punctuate

--redact=... https://dpgr.am/redact

Deepgram feature: redact

--replace=... https://dpgr.am/replace

Deepgram feature: replace

--search=... https://dpgr.am/search

Deepgram feature: search

--smart_format https://dpgr.am/smart_format

Deepgram feature: smart_format

--summarize https://dpgr.am/summarize

Deepgram feature: summarize

--tag=... https://dpgr.am/tag

Deepgram feature: tag

--tier= https://dpgr.am/tier

Deepgram feature: tier

--utt_split= https://dpgr.am/utt_split

Deepgram feature: utt_split

--utterances https://dpgr.am/utterances

Deepgram feature: utterances

--version= https://dpgr.am/version

Deepgram feature: version
`

_See code: dist/commands/transcribe/index.js_


Developing

1. Clone this repository.

`sh-session
$ git clone git@github.com:deepgram-devs/deepgram-cli.git
`

1. Switch to the CLI directory.

`sh-session
$ cd deepgram-cli
`

1. Install all dependencies.

`sh-session
$ npm i
`

Run the CLI.

`sh-session
$ bin/dev COMMAND
running command...

$ bin/dev (--version)
@deepgram/cli/0.0.0 darwin-x64 node-v16.11.1

$ bin/dev --help [COMMAND]
USAGE
$ bin/dev COMMAND
``

Contributors

Would you like to contribute to this project? Check out our contributing guide.

Made with contrib.rocks.