Skip to main content

​
Overview

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

​
Syntax

rtk config [OPTIONS]

​
Options

​
--create
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.
​
tracking.enabled
boolean
default:"true"
Enable/disable token tracking
​
tracking.history_days
number
default:"90"
Days to retain tracking data before auto-cleanup
​
tracking.database_path
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.
​
display.colors
boolean
default:"true"
Enable ANSI color codes in output
​
display.emoji
boolean
default:"true"
Use emoji in output (📊, ✅, ❌, etc.)
​
display.max_width
number
default:"120"
Maximum output width for table formatting

​
Filters

Controls automatic filtering behavior for ls, find, and other commands.
​
filters.ignore_dirs
string[]
Directories to exclude from listings (unless -a flag used)
​
filters.ignore_files
string[]
File patterns to exclude (glob syntax)

​
Tee (Output Recovery)

Controls automatic saving of full command output on failure.
​
tee.enabled
boolean
default:"true"
Enable tee functionality
​
tee.mode
string
default:"failures"
When to save output:
  • failures - Only on non-zero exit codes
  • always - Save all command output
  • never - Disable tee
​
tee.directory
string
default:"~/.local/share/rtk/tee"
Directory for saved output files
​
tee.max_files
number
default:"20"
Maximum files to keep (oldest deleted first)
​
tee.max_size_bytes
number
default:"1048576"
Maximum size per output file (1MB default)
​
tee.skip_small
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

​
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