gdc-tui¶
The interactive terminal app. See Interactive terminal for a guided tour and Keyboard shortcuts for every key.
Usage¶
With no options, gdc-tui runs a private, self-contained instance for the
current project — you don't need to start a server. Pass --bind to
connect to a separately-running server
instead.
Options¶
Each option also has an environment variable; the flag takes priority.
| Flag | Environment | Default | Description |
|---|---|---|---|
--bind <host:port> |
GDC_TUI_BIND |
(self-contained) | Connect to a running server instead of starting a private one. Accepts host:port or a full URL. |
--db-path <path> |
GDC_TUI_DB_PATH |
per-project database | Where sessions are stored (self-contained mode only). |
--config <path> |
GDC_TUI_CONFIG |
standard cascade | Use a specific config file (self-contained mode only). |
--profile <name> |
GDC_TUI_PROFILE |
default |
Starting profile (self-contained mode only). |
--cwd <path> |
GDC_TUI_CWD |
current dir | Project directory to scope to (self-contained mode only). |
--log-dir <path> |
GDC_TUI_LOG_DIR |
(off) | Write a log file into this directory. Logging is off unless set. |
gdc-tui --version prints the version; gdc-tui --help prints usage.
Two ways it runs¶
- Self-contained (default). With no
--bind,gdc-tuiruns everything it needs itself, using a database dedicated to the current project. This is the "just run it" experience. - Remote client. With
--bind <host:port>,gdc-tuibecomes a thin client of a server you run separately — for shared or remote setups. The options marked "self-contained mode only" above don't apply then; the server owns those settings.
# self-contained, in the current project
gdc-tui
# connect to a server running elsewhere
gdc-tui --bind 192.168.1.10:8088
Disabling the mouse
If your terminal handles selection oddly with mouse capture on, set
GDC_DISABLE_MOUSE=1. See
Environment variables.