deepctl 0.1.10

Official Deepgram CLI for speech recognition and audio intelligence

deepctl

[!WARNING]
Alpha Software: This CLI is experimental and under active development.

Official Deepgram CLI. Modular Python package with plugin system.

Development

Setup

git clone https://github.com/deepgram/cli && cd cli
uv venv && uv pip install -e ".[dev]"

Run CLI

uv run deepctl --help
uv run deepctl login
uv run deepctl transcribe audio.wav

Development Commands

make dev                   # Format, lint, test
make test                  # Run tests
uv run tox                 # Test all Python versions

Requirements

• Python 3.10+
• uv package manager
• Cross-platform: Linux, Windows, macOS

Architecture

cli/
├── src/deepctl/           # Main CLI
├── packages/              # Command packages
├── tests/                 # Integration tests
└── Makefile               # Development tasks

Plugin Development

from deepctl_core.base_command import BaseCommand

class MyCommand(BaseCommand):
    name = "mycommand"
    help = "My custom command"

    def handle(self, config, auth_manager, client, **kwargs):
        pass

See packages/deepctl-plugin-example.

Testing

• tests/ - Integration tests
• packages/*/tests/unit/ - Unit tests
• Runs on Python 3.10-3.12, Linux/Windows/macOS

Documentation

• docs/Quick Start For Contributors.md
• docs/Architecture and Design.md
• docs/Testing and Test Strategy.md

Release

Semi-automated release (recommended)

# 1. Update versions
make version VERSION=0.2.0

# 2. Commit changes
make commit

# 3. Build packages
make build

# 4. Verify everything
make verify-packages

# 5. Create tag
make tag

# 6. Push to trigger PyPI publish
git push origin main --tags

Full automated release

make release
# Enter version when prompted (e.g., 0.2.0)
git push origin main --tags

Installation

Try Without Installing

uv run deepctl --help
pipx run deepctl --help

{WIP} Install

pip install deepctl
uv tool install deepctl
brew install deepctl

Usage

Commands

deepctl login
deepctl transcribe audio.wav
deepctl projects list
deepctl usage --month 2024-01

Aliases

• deepctl (primary)
• deepgram
• dg

Plugins

deepctl plugin search
deepctl plugin install <package>
deepctl plugin list

Configuration

Priority: CLI args > env vars > ~/.deepgram/config.yaml > ./deepgram.yaml

Output Formats

deepctl transcribe audio.wav --output json|yaml|table|csv

Contributing

1. Fork repository
2. Run make dev (formats, lints, tests)
3. Add tests for changes
4. Submit pull request

Links

• Documentation
• Discord
• Issues

License

MIT