Get started with ShellTime in just a few simple steps
Run this command in your terminal to install the ShellTime CLI:
curl -sSL https://shelltime.xyz/i | bashLogin to your account, setup shell hooks, and start the daemon:
shelltime initAfter installation, you can start tracking your shell commands automatically
Customize your ShellTime configuration at ~/.shelltime/config.yaml
Automatically mask sensitive data (API keys, passwords, etc.) before syncing
Enable end-to-end encryption (requires daemon mode)
Regular expressions, one per line. Matching commands are never synced
Number of commands to buffer before syncing (minimum: 3)
Buffer commands in the daemon-owned bolt database for faster tracking. Falls back to file storage when the daemon is unavailable
Route outbound traffic through an http, https, socks5 or socks5h proxy. Leave empty to use HTTP_PROXY / HTTPS_PROXY
Comma-separated hosts that skip the proxy
Show helpful tips when using AI features
Automatically execute read-only commands (ls, cat, grep)
Automatically execute file modification commands
Automatically execute delete commands (DANGEROUS)
Enable OpenTelemetry tracking for AI coding tools (Claude Code, Codex, etc.)
OpenTelemetry gRPC server port (default: 54027)
Write debug files for troubleshooting
Track coding activity heartbeats
Automatically clean up log files when they exceed threshold
Clean files larger than this size in MB
# yaml-language-server: $schema=./config-schema.json
# Get your token by running: shelltime init
token: "your-api-token"
# Sync Settings
flushCount: 10
# Storage Engine: bolt is daemon-owned and faster;
# the CLI falls back to file when the daemon is unavailable
storage:
engine: bolt
# Privacy & Security
dataMasking: true
encrypted: true
# Commands matching any of these regular expressions are never synced
# exclude:
# - ".*password.*"
# - "^export AWS_"
# Network Proxy (http, https, socks5, socks5h)
# When unset, HTTP_PROXY / HTTPS_PROXY / NO_PROXY are used
# proxy:
# url: "socks5h://127.0.0.1:7890"
# noProxy:
# - "localhost"
# AI Features
ai:
showTips: true
agent:
view: false
edit: false
delete: false
# AI Coding Tools (Claude Code, Codex, etc.)
aiCodeOtel:
enabled: true
grpcPort: 54027
debug: false
# Code Tracking (requires editor plugin setup)
codeTracking:
enabled: true
# Log Management
logCleanup:
enabled: true
thresholdMB: 100After editing your config:
Install AI coding environment:
We recommend running both commands to ensure compatibility with all AI coding tools.
For Claude Code:
shelltime cc installFor Codex:
shelltime codex installInstall editor plugins for code tracking:
Reload configuration:
shelltime daemon reinstallRemember to restart all terminal sessions and coding editors to apply the new settings.