docterm 0.2.0

A TUI-first documentation browser for Dash/Zeal docsets, optimized for the terminal.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# --- General Path & Behavior ---
# If not set, follows XDG Base Directory Specification
# db_path = "~/.local/share/docterm/library.db"
project_aware = true
log_level = "info" # trace, debug, info, warn, error

[storage]
zstd_compression_level = 3 # 1-22, 3 is the sweet spot
backup_before_update = true

# --- TUI Settings ---
[tui]
# show_url = false  # Show the URL/path column in the search-results table (TODO: per-docset)

[network]
user_agent = "doc-browser-tui/0.1.0"
# proxy = "http://localhost:8080"

# --- Key Bindings ---
# Each action accepts a single key ("q") or multiple shortcuts (["/", "s"]).
[keys]
global_search = ["/", "s"]          # '/' or 's' both open global search
local_search = "S-/"                # Shift + /
quit = "q"
back = "esc"
jump_to_definition = "ctrl-]"
copy_import = "y"
run_snippet = "r"
toggle_favorite = "+"               # '+' in Explore tab bookmarks current page
delete_favorite = ["d", "delete"]   # In Favorites tab: delete selected bookmark

# --- MCP Server ---
[mcp]
enabled = false
listen_address = "127.0.0.1"
port = 3000
# auth_token = "generate_a_secure_token_here"
root_path = "/" # Allowed path for the AI to read

# --- Docsets Management ---
[[docsets]]
name = "rust"
version = "1.75.0" # Optional pinned version
auto_update = true

[[docsets]]
name = "tokio"
# version omitted = latest

[[docsets]]
name = "ratatui"