rtk config

Overview

Displays RTK configuration from ~/.config/rtk/config.toml or creates a default configuration file.

Syntax

rtk config [OPTIONS]

Options

flag

Create default configuration file at ~/.config/rtk/config.toml

Configuration File

Location: ~/.config/rtk/config.toml

Default Configuration

[tracking]
enabled = true
history_days = 90
# Optional: custom database path
# database_path = "/custom/path/tracking.db"

[display]
colors = true
emoji = true
max_width = 120

[filters]
ignore_dirs = [
  ".git",
  "node_modules",
  "target",
  "__pycache__",
  ".venv",
  "vendor"
]
ignore_files = [
  "*.lock",
  "*.min.js",
  "*.min.css"
]

[tee]
enabled = true
mode = "failures"  # "always", "failures", "never"
directory = "~/.local/share/rtk/tee"
max_files = 20
max_size_bytes = 1048576  # 1MB
skip_small = 500  # Skip outputs < 500 chars

Configuration Sections

Tracking

Controls token savings tracking and database behavior.

boolean

default:"true"

Enable/disable token tracking

number

default:"90"

Days to retain tracking data before auto-cleanup

string

Custom path for tracking database. Defaults to ~/.local/share/rtk/tracking.db.Can also be set via environment variable: RTK_DB_PATH=/custom/path.db

Display

Controls terminal output formatting.

boolean

default:"true"

Enable ANSI color codes in output

boolean

default:"true"

Use emoji in output (📊, ✅, ❌, etc.)

number

default:"120"

Maximum output width for table formatting

Filters

Controls automatic filtering behavior for ls, find, and other commands.

string[]

Directories to exclude from listings (unless -a flag used)

string[]

File patterns to exclude (glob syntax)

Tee (Output Recovery)

Controls automatic saving of full command output on failure.

boolean

default:"true"

Enable tee functionality

string

default:"failures"

When to save output:

failures - Only on non-zero exit codes
always - Save all command output
never - Disable tee

string

default:"~/.local/share/rtk/tee"

Directory for saved output files

number

default:"20"

Maximum files to keep (oldest deleted first)

number

default:"1048576"

Maximum size per output file (1MB default)

number

default:"500"

Skip saving outputs smaller than N characters

Environment Variables

Environment variables take precedence over config file:

RTK_DB_PATH - Override tracking database path
RTK_TEE - Override tee mode (always, failures, never)
RTK_TEE_DIR - Override tee directory

Usage

View Current Config

rtk config

Output:

Config: /Users/you/.config/rtk/config.toml

[tracking]
enabled = true
history_days = 90

[display]
colors = true
emoji = true
max_width = 120

[filters]
ignore_dirs = ['.git', 'node_modules', 'target', '__pycache__', '.venv', 'vendor']
ignore_files = ['*.lock', '*.min.js', '*.min.css']

[tee]
enabled = true
mode = 'failures'
directory = '~/.local/share/rtk/tee'
max_files = 20
max_size_bytes = 1048576
skip_small = 500

Create Default Config

rtk config --create

Output:

Created: /Users/you/.config/rtk/config.toml

Edit Config

vim ~/.config/rtk/config.toml

Example Customizations

Disable Tracking

[tracking]
enabled = false

Custom Database Location

[tracking]
database_path = "/mnt/data/rtk.db"

Or via environment:

export RTK_DB_PATH="/mnt/data/rtk.db"
rtk gain

No Colors (CI/CD)

[display]
colors = false
emoji = false

Always Save Output

[tee]
mode = "always"
max_files = 100

Add Custom Ignore Patterns

[filters]
ignore_dirs = [
  ".git",
  "node_modules",
  "target",
  "__pycache__",
  ".venv",
  "vendor",
  "build",      # Added
  ".turbo"      # Added
]
ignore_files = [
  "*.lock",
  "*.min.js",
  "*.min.css",
  "*.d.ts"      # Added
]

rtk config
# Shows current configuration

rtk config --create
# Creates ~/.config/rtk/config.toml

export RTK_DB_PATH="/mnt/data/rtk.db"
rtk gain
# Uses custom database location

vim ~/.config/rtk/config.toml
# Manual editing

Exit Codes

0 - Success
1 - Error creating config file

rtk init --show - View installation status
rtk gain - View token savings (uses tracking config)
rtk verify - Verify hook integrity

Command Reference

Global Flags

Overview

Syntax

Options

Configuration File

Default Configuration

Configuration Sections

Tracking

Display

Filters

Tee (Output Recovery)

Environment Variables

Usage

View Current Config

Create Default Config

Edit Config

Example Customizations

Disable Tracking

Custom Database Location

No Colors (CI/CD)

Always Save Output

Add Custom Ignore Patterns

Exit Codes

​Overview

​Syntax

​Options

​Configuration File

​Default Configuration

​Configuration Sections

​Tracking

​Display

​Filters

​Tee (Output Recovery)

​Environment Variables

​Usage

​View Current Config

​Create Default Config

​Edit Config

​Example Customizations

​Disable Tracking

​Custom Database Location

​No Colors (CI/CD)

​Always Save Output

​Add Custom Ignore Patterns

​Exit Codes

​Related Commands

Overview

Syntax

Options

Configuration File

Default Configuration

Configuration Sections

Tracking

Display

Filters

Tee (Output Recovery)

Environment Variables

Usage

View Current Config

Create Default Config

Edit Config

Example Customizations

Disable Tracking

Custom Database Location

No Colors (CI/CD)

Always Save Output

Add Custom Ignore Patterns

Exit Codes

Related Commands