Skip to main content

Quick Start

Welcome to hns! This guide will get you up and running with hns in less than 30 seconds.

1. Installation​

Choose your preferred installation method below. uv and pipx are recommended as they install the CLI tool in an isolated environment.

uv tool install hns

See the Installation Guide for more details.

2. Your First Transcription​

Now, let's transcribe something.

  1. Run hns in your terminal:

    hns

  2. When you see 🎤 Recording..., speak the following sentence clearly into your microphone:

    "In the beginning the Universe was created. This has made a lot of people very angry and been widely regarded as a bad move."

  3. Press Enter when you're done.

The transcribed text will be printed to your terminal and, more importantly, copied directly to your clipboard, ready to be pasted anywhere.

First Run

The first time you transcribe with hns, it will download the configured Whisper model. This requires an internet connection. Subsequent transcriptions using the same model are fully offline.

3. Next Steps​

Congratulations on your first transcription! Here’s where to go next:

  • Explore Use Cases: Discover how to integrate hns into your daily workflows for maximum productivity.
  • Configure hns: Learn how to select different models, set language preferences, and customize hns to your needs.