Skip to content

Latest commit

 

History

History
376 lines (239 loc) · 10.4 KB

README.md

File metadata and controls

376 lines (239 loc) · 10.4 KB
Raw

Deepgram CLI

This project is currently DEPRECATED. Please see this Repo for our new CLI.

oclif Version CircleCI Downloads/week License

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

Getting an API Key

🔑 To access the Deepgram API you will need a free Deepgram API Key.

Documentation

You can learn more about the Deepgram API at developers.deepgram.com.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Usage

$ npm install -g @deepgram/cli
$ deepgram COMMAND
running command...
$ deepgram (--version)
@deepgram/cli/0.4.0-beta.0 darwin-x64 node-v21.0.0
$ deepgram --help [COMMAND]
USAGE
  $ deepgram COMMAND
...

Commands

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 your Deepgram API key. This will create a new limited key for you on your account.

USAGE
  $ deepgram setup [-k <value>] [-s <value>] [-t <value>]

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

DESCRIPTION
  Setup the CLI using your Deepgram API key. This will create a new limited key for you on your account.

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

    An API key provided by Deepgram.

  -s, --scopes=<value>  https://dpgr.am/scopes

    Comma separated string of Deepgram API scopes.

  -t, --ttl=<value>  https://dpgr.am/ttl

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

See code: src/commands/setup/index.ts

deepgram starter [REPOSITORY]

Generate a Deepgram starter app.

USAGE
  $ deepgram starter [REPOSITORY] [-k <value>] [--select]

ARGUMENTS
  REPOSITORY  Repository to create a starter from

FLAGS
  --select  Select from the Starter library

GLOBAL FLAGS
  -k, --key=<value>  The `DEEPGRAM_API_KEY` environment variable (or --key flag) can be supplied instead of running
                     `deepgram setup` to configure the CLI.

DESCRIPTION
  Generate a Deepgram starter app.

See code: src/commands/starter/index.ts

deepgram summary

Summarize any audio or video using just one command.

USAGE
  $ deepgram summary [-k <value>] [--data-url <value>] [--data-binary <value>]

GLOBAL FLAGS
  -k, --key=<value>  The `DEEPGRAM_API_KEY` environment variable (or --key flag) can be supplied instead of running
                     `deepgram setup` to configure the CLI.

MEDIA SOURCE FLAGS
  --data-binary=<value>  https://dpgr.am/data-binary
  --data-url=<value>     https://dpgr.am/data-url

DESCRIPTION
  Summarize any audio or video using just one command.

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

    Filepath of local audio or video file

  --data-url=<value>  https://dpgr.am/data-url

    URL of an audio or video file

See code: src/commands/summary/index.ts

deepgram transcribe

Transcribe audio/video straight from the command line

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

GLOBAL FLAGS
  -k, --key=<value>  The `DEEPGRAM_API_KEY` environment variable (or --key flag) can be supplied instead of running
                     `deepgram setup` to configure the CLI.

DEEPGRAM FEATURES FLAGS
  --callback=<value>     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=<value>...  https://dpgr.am/keywords
  --language=<value>     https://dpgr.am/language
  --model=<value>        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=<value>...    https://dpgr.am/redact
  --replace=<value>...   https://dpgr.am/replace
  --search=<value>...    https://dpgr.am/search
  --smart_format         https://dpgr.am/smart_format
  --summarize            https://dpgr.am/summarize
  --tag=<value>...       https://dpgr.am/tag
  --tier=<value>         https://dpgr.am/tier
  --utt_split=<value>    https://dpgr.am/utt_split
  --utterances           https://dpgr.am/utterances
  --version=<value>      https://dpgr.am/version

MEDIA SOURCE FLAGS
  --data-binary=<value>  https://dpgr.am/data-binary
  --data-url=<value>     https://dpgr.am/data-url

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

DESCRIPTION
  Transcribe audio/video straight from the command line

EXAMPLES
  $ deepgram transcribe --data-url=https://dpgr.am/spacewalk.wav

  $ deepgram transcribe --data-url=https://dpgr.am/spacewalk.wav --smart_format

  $ deepgram transcribe --data-url=https://dpgr.am/spacewalk.wav

  $ deepgram transcribe --data-url=https://dpgr.am/spacewalk.wav

FLAG DESCRIPTIONS
  --callback=<value>  https://dpgr.am/callback

    Deepgram feature: callback

  --data-binary=<value>  https://dpgr.am/data-binary

    Filepath of local audio or video file

  --data-url=<value>  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=<value>...  https://dpgr.am/keywords

    Deepgram feature: keywords

  --language=<value>  https://dpgr.am/language

    Deepgram feature: language

  --model=<value>  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=<value>...  https://dpgr.am/redact

    Deepgram feature: redact

  --replace=<value>...  https://dpgr.am/replace

    Deepgram feature: replace

  --search=<value>...  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=<value>...  https://dpgr.am/tag

    Deepgram feature: tag

  --tier=<value>  https://dpgr.am/tier

    Deepgram feature: tier

  --utt_split=<value>  https://dpgr.am/utt_split

    Deepgram feature: utt_split

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

    Deepgram feature: utterances

  --version=<value>  https://dpgr.am/version

    Deepgram feature: version

See code: src/commands/transcribe/index.ts

Developing

  1. Clone this repository.
$ git clone [email protected]:deepgram-devs/deepgram-cli.git
  1. Switch to the CLI directory.
$ cd deepgram-cli
  1. Install all dependencies.
$ npm i

Run the CLI.

$ 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.