Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 93 additions & 4 deletions apps/web/content/docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ char [--no-color] [-v] [-q] [-h] [-V] <command>
- `transcribe` — Transcribe an audio file
- `models` — Manage local models
- `completions` — Generate shell completions
- `play` — Play an audio file
- `record` — Record audio to an MP3 file
- `skill` — Install char skill for AI coding agents
- `desktop` — Open the desktop app or download page
- `update` — Update char to the latest version
- `shortcut` — Manage global shortcut (macOS only)
- `meetings` — Browse past meetings
- `humans` — Browse humans (contacts)
- `orgs` — Browse organizations
Expand All @@ -42,12 +46,12 @@ char [--no-color] [-v] [-q] [-h] [-V] <command>
Transcribe an audio file

```
char transcribe <--input> <-p> [-k] [-o] [-f] [--base] [--base-url] [--api-key] [-m] [-l] [-h] [-V]
char transcribe [INPUT] [-i] <-p> [-k] [-o] [-f] [--base] [--base-url] [--api-key] [-m] [-l] [-h] [-V]
```

**Options:**

- `--input <FILE>`
- `-i, --input <FILE>` (alias: `--file`)
- `-p, --provider <PROVIDER>`
- `-k, --keyword <KEYWORD>`
- `-o, --output <FILE>`
Expand All @@ -60,6 +64,10 @@ char transcribe <--input> <-p> [-k] [-o] [-f] [--base] [--base-url] [--api-key]
- `-h, --help` — Print help
- `-V, --version` — Print version

**Arguments:**

- `[INPUT]` — Timestamp (e.g. 20260327_143022) or path to an audio file

### char models

Manage local models
Expand Down Expand Up @@ -148,19 +156,66 @@ char completions [-h] [-V] <shell>

- `<SHELL>`

### char play

Play an audio file

```
char play [--base] [-h] [-V] <target>
```

**Options:**

- `--base <DIR>` — Base directory for session lookup
- `-h, --help` — Print help
- `-V, --version` — Print version

**Arguments:**

- `<TARGET>` — Timestamp (e.g. 20260327_143022) or path to an audio file

### char record

Record audio to an MP3 file

```
char record [--audio] [-o] [-f] [-h] [-V]
char record [--audio] [-o] [-f] [--base] [-h] [-V]
```

**Options:**

- `--audio <AUDIO>` (default: `input`)
- `--audio <AUDIO>` (default: `dual`)
- `-o, --output <FILE>`
- `-f, --format <FORMAT>` (default: `pretty`)
- `--base <DIR>`
- `-h, --help` — Print help
- `-V, --version` — Print version

### char skill

Install char skill for AI coding agents

```
char skill <command>
```

**Subcommands:**

- `install` — Install char skill for AI coding agents

---

### char skill install

Install char skill for AI coding agents

```
char skill install [-f] [-h] [-V]
```

**Options:**

- `-f, --format <FORMAT>` — Skip interactive selection: claude, codex, github-copilot
- `-h, --help` — Print help
- `-V, --version` — Print version

Expand All @@ -177,6 +232,40 @@ char desktop [-h] [-V]
- `-h, --help` — Print help
- `-V, --version` — Print version

### char update

Update char to the latest version

```
char update [-h] [-V]
```

**Options:**

- `-h, --help` — Print help
- `-V, --version` — Print version

### char shortcut

Manage global shortcut (macOS only)

```
char shortcut [-h] [-V] [command]
```

When run without a subcommand, opens the shortcut configuration screen.

**Options:**

- `-h, --help` — Print help
- `-V, --version` — Print version

**Subcommands:**

- `install` — Install the global shortcut daemon
- `uninstall` — Uninstall the shortcut daemon
- `status` — Check if the shortcut daemon is running

### char meetings

Browse past meetings
Expand Down
4 changes: 2 additions & 2 deletions apps/web/content/docs/developers/1.env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ CHAR_BASE_URL="" # STT proxy base URL (--base-url)
CHAR_API_KEY="" # API key for cloud STT providers (--api-key)
CHAR_MODEL="" # STT model name (--model)
CHAR_LANGUAGE="en" # Transcription language (--language, default: en)
CHAR_RECORD=false # Save audio recording alongside transcription (--record)
CHAR_BASE="" # Base directory for session data (--base)
```

These variables are used by the `listen`, `batch`, and `chat` subcommands. See the CLI help (`char --help`) for full usage.
These variables are used by the `transcribe` and `record` subcommands. See the CLI help (`char --help`) for full usage.

# Stripe

Expand Down
6 changes: 3 additions & 3 deletions apps/web/content/docs/developers/16.local-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ For step-by-step setup instructions for LM Studio and Ollama, see the [Local LLM

## Speech-to-text (STT)

- All STT models are stored in `~/Library/Application Support/hyprnote/models/stt/`
- All STT models are stored in `~/Library/Application Support/char/models/stt/`
- The built-in whisper-cpp backend is now an optional compile-time feature. Production builds on macOS Apple Silicon use the Argmax sidecar by default. Whisper-cpp quantized models have been removed from the settings UI.

### Cactus engine (beta)

Cactus is a local STT backend that runs optimized Whisper models. Cactus models are listed in Settings > Transcription under the Hyprnote provider. Models with an "Apple NPU" suffix use the Apple Neural Engine for hardware-accelerated inference on Apple Silicon Macs; non-Apple variants run on any platform.
Cactus is a local STT backend that runs optimized Whisper models. Cactus models are listed in Settings > Transcription under the Char provider. Models with an "Apple NPU" suffix use the Apple Neural Engine for hardware-accelerated inference on Apple Silicon Macs; non-Apple variants run on any platform.

| Model | Quantization | Platform |
| ----- | ------------ | -------- |
Expand Down Expand Up @@ -54,5 +54,5 @@ If you have [Huggingface CLI](https://huggingface.co/docs/huggingface_hub/guides
```bash
hf download argmaxinc/whisperkit-pro \
--include "openai_whisper-large-v3-v20240930_626MB/*" \
--local-dir "$HOME/Library/Application Support/hyprnote/models/stt"
--local-dir "$HOME/Library/Application Support/char/models/stt"
```
4 changes: 2 additions & 2 deletions apps/web/content/docs/faq/1.features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Yes! Char supports backlink mentions. Type `@` in a note to search for and link

## Can I search across all my notes?

Yes. Press <kbd>⌘</kbd> + <kbd></kbd> + <kbd>F</kbd> to open the Advanced Search tab, which uses Tantivy-powered full-text search to find matches across all sessions. You can filter by type (meeting notes, people, organizations) and date range (today, this week, this month). Results highlight matching text in context.
Yes. Use the searchbar (<kbd></kbd> + <kbd>K</kbd>) to find matches across all sessions using Tantivy-powered full-text search.

Within a note or transcript, <kbd>⌘</kbd> + <kbd>F</kbd> opens an inline search bar with case-sensitive and whole-word matching options. Press <kbd>⌘</kbd> + <kbd>H</kbd> to toggle find-and-replace mode, which supports replacing individual matches or all matches at once.

Expand All @@ -54,7 +54,7 @@ Yes. On macOS, right-click the Char icon in the Dock to see a context menu with

## Can I open the AI chat as a full tab?

Yes. The AI chat bubble can be expanded into a full tab for a more spacious conversation view. You can also open a support chat tab from the profile menu in the sidebar by selecting **Report Bug** or **Suggest Feature**.
Yes. Charlie (Char's AI assistant) can be expanded into a full tab for a more spacious conversation view. You can also open a support chat tab from the profile menu in the sidebar by selecting **Report Bug** or **Suggest Feature**.

## Can I select and delete multiple notes at once?

Expand Down
6 changes: 5 additions & 1 deletion apps/web/content/docs/faq/4.pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ description: "Questions about Char pricing and subscription plans."

## Is Char free?

Char offers a free tier with core features. Char Pro is $25/month or $250/year for managed cloud features, advanced templates, and priority support.
Char offers a free tier with core features including on-device transcription, audio recording, BYOK support, templates, shortcuts, and chat.

**Char Lite** is $8/month and adds cloud STT & LLM services and speaker identification.

**Char Pro** is $25/month (or $250/year) and includes everything in Lite plus playback rate controls, advanced templates, integrations, cloud sync, and shareable links.

## Can I try Pro features before subscribing?

Expand Down
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/6.keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ description: "Complete list of keyboard shortcuts in Char."
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>,</kbd> | Open AI Settings |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>C</kbd> | Open Calendar |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>D</kbd> | Open Daily Notes |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>F</kbd> | Open Advanced search |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>F</kbd> | Focus Searchbar |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>L</kbd> | Open Folders |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>O</kbd> | Open Contacts |

Expand Down
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/7.settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Location of the settings.json file in Char."
The settings file is located at:

```bash
~/Library/Application Support/hyprnote/settings.json
~/Library/Application Support/char/settings.json
```

You can edit this file directly, but changes only take effect after restarting Char. For most settings, use the in-app Settings panel instead.
Expand Down