ghedot

🎨 Cross-platform dotfiles management tool with beautiful TUI and encryption

ghedot adalah tool management dotfiles yang modern dan interaktif, dibangun dengan Bun.js. Kelola configuration files Anda dengan mudah menggunakan tampilan TUI yang indah, auto-suggestions, encryption untuk file sensitif, dan full cross-platform support untuk Windows & Linux.

🆕 What's New in v0.0.5

• 📁 Custom Folder Support - Gunakan ANY folder name (hades, olympus, zeus, dll.)
• 🔄 Auto Path Resolution - Relative paths otomatis dikonversi ke absolute
• 🪟 Improved Windows Support - Enhanced mkdir dengan proper escaping
• ✅ Path Validation - Validasi dan normalisasi path otomatis
• 📚 Enhanced Documentation - Quick Start Guide, QUICKSTART.md, dan CUSTOM_FOLDERS.md

See CHANGELOG.md for full release notes.

🔖 Previous Updates (v0.0.4)

• 🔍 Security Scanner - Auto-detect secrets and sensitive data in your dotfiles
• 📋 Encryption Policy - Define mandatory encryption rules for sensitive files
• 🔐 Argon2id Encryption - Industry-leading key derivation with memory-hard protection
• ⏱️ Passphrase Cache - Secure in-memory caching with auto-expiration (15min TTL)
• 🎯 20+ Secret Patterns - Detect AWS keys, GitHub tokens, private keys, and more
• 🚨 Policy Enforcement - Block or warn on unencrypted sensitive files
• 📊 Risk Classification - HIGH, MEDIUM, LOW severity levels

✨ Fitur Utama

• 🎨 Beautiful TUI - Interface interaktif yang modern dengan @clack/prompts
• 🔍 Auto-Suggestions - Pilih dotfiles dari daftar yang umum digunakan
• 🌍 Cross-Platform - Compatible di Windows, Linux, dan macOS
• 🔗 Symlink Management - Buat dan kelola symbolic links otomatis
• 💾 Backup System - Backup dotfiles sebelum perubahan
• 🔐 Encryption - Enkripsi dotfiles sensitif dengan ChaCha20-Poly1305 atau AES-256-GCM
• 📊 Beautiful Tables - Status display dengan tabel yang rapi
• ⚡ Fast - Built dengan Bun untuk performa maksimal
• 🎯 Platform-Specific - Konfigurasi per-OS
• 📦 Modular - Struktur kode yang clean dan maintainable
• 🔄 Auto Update Check - Otomatis cek versi terbaru dan notifikasi update

📸 Screenshots

┌─────────────────────────────────────┐
│  ghedot - Dotfiles Manager      │
└─────────────────────────────────────┘

◆  What would you like to do?
│  ● 🚀 Initialize
│  ○ ➕ Add dotfile
│  ○ 🔗 Link dotfiles
│  ○ 📊 Show status
│  ○ 💾 Backup dotfiles
│  ○ ♻️  Restore dotfiles
│  ○ 👋 Exit
└

📦 Installation

🚀 One-line Install (Recommended)

curl -fsSL https://raw.githubusercontent.com/dwirx/ghedot/main/install-curl.sh | bash

📦 Package Managers

NPM (Quick & Easy):

# Install latest version (v0.0.5)
npm install -g ghedot

# Verify installation
ghedot --version
# Should show: 0.0.5

Yarn:

yarn global add ghedot

pnpm:

pnpm add -g ghedot

Bun (Recommended for Best Performance):

bun install -g ghedot

Homebrew (macOS/Linux):

brew tap dwirx/ghedot
brew install ghedot

Arch Linux (AUR):

yay -S ghedot-bin
# or
paru -S ghedot-bin

Scoop (Windows):

scoop bucket add dwirx https://github.com/dwirx/scoop-ghedot
scoop install ghedot

Windows (PowerShell):

npm install -g ghedot
# Or with Bun
bun install -g ghedot

# Run Windows compatibility test
powershell -File test-windows.ps1

📥 Manual Download

Download pre-built binaries from GitHub Releases:

• Linux x64: ghedot
• Linux ARM64: ghedot-linux-arm64
• Windows x64: ghedot.exe
• macOS Intel: ghedot-macos
• macOS Apple Silicon: ghedot-macos-arm64

# Make executable and move to PATH
chmod +x ghedot
sudo mv ghedot /usr/local/bin/

📋 See INSTALL.md for all installation methods and troubleshooting.

🪟 See WINDOWS_SUPPORT.md for Windows-specific instructions.

📁 See CUSTOM_FOLDERS.md for using custom folders like "hades", "olympus", etc.

🐚 Shell Compatibility

Works with bash, zsh, fish, and other POSIX-compatible shells. Automatically detects and uses the best runtime (Bun → Node.js → fallback).

🚀 Quick Start Guide

🇮🇩 Ingin panduan lengkap dalam Bahasa Indonesia? Lihat CARA-PENGGUNAAN.md untuk tutorial lengkap, contoh, dan troubleshooting.

Langkah-langkah Dasar

1️⃣ Inisialisasi Konfigurasi

Jalankan perintah init untuk membuat file konfigurasi ~/.ghedot/ghedot.json:

# Inisialisasi dengan lokasi default (~/.dotfiles)
ghedot init

# Atau dengan path custom
ghedot init --path ~/my-dotfiles

# Atau dengan folder bernama "hades"
ghedot init --path ~/hades

# Atau dengan relative path (akan dikonversi ke absolute)
ghedot init --path ./my-config

💡 Tip: ghedot mendukung ANY folder name! Bisa hades, olympus, zeus, atau apapun. Lihat CUSTOM_FOLDERS.md untuk panduan lengkap.

Output yang diharapkan:

✅ Configuration initialized successfully!

📁 Dotfiles Directory:  /home/user/.dotfiles
💾 Backup Directory:    /home/user/.ghedot/backups
🖥️  Platform:           linux
📄 Config File:         /home/user/.ghedot/ghedot.json

2️⃣ Tambahkan Dotfiles

Ada dua cara untuk menambahkan dotfiles:

Cara A: Interactive Mode (Mudah untuk pemula)

ghedot add

Akan muncul prompt interaktif yang memandu Anda memilih file, platform, dan pengaturan backup.

Cara B: Manual Edit Config

Edit file ~/.ghedot/ghedot.json secara manual:

{
  "dotfilesDir": "/home/user/.dotfiles",
  "backupDir": "/home/user/.ghedot/backups",
  "files": [
    {
      "source": "zshrc",
      "target": ".zshrc",
      "platforms": ["linux", "darwin"],
      "backup": true
    },
    {
      "source": "vimrc",
      "target": ".vimrc",
      "backup": true
    }
  ],
  "platform": "linux",
  "encrypted": []
}

Kemudian copy file ke dotfiles directory:

cp ~/.zshrc ~/.dotfiles/zshrc
cp ~/.vimrc ~/.dotfiles/vimrc

3️⃣ Buat Symlinks

Buat symbolic links dari dotfiles directory ke home directory:

# Preview apa yang akan di-link (dry run)
ghedot link --dry-run

# Buat symlinks
ghedot link

# Force overwrite jika file sudah ada
ghedot link --force

Output yang diharapkan:

✓ Created symlink: /home/user/.zshrc -> /home/user/.dotfiles/zshrc
✓ Created symlink: /home/user/.vimrc -> /home/user/.dotfiles/vimrc

✓ All 2 dotfiles linked successfully!

4️⃣ Verifikasi Status

Cek status dotfiles Anda:

ghedot status

Output:

┌────────────────────┬─────────────────────────┬─────────────────────────┬───────────────┬───────────────┐
│ File               │ Source                  │ Target                  │ Status        │ Platform      │
├────────────────────┼─────────────────────────┼─────────────────────────┼───────────────┼───────────────┤
│ 🔒 zshrc           │ zshrc                   │ .zshrc                  │ ✓ Linked      │ LNX, MAC      │
│ 🔒 vimrc           │ vimrc                   │ .vimrc                  │ ✓ Linked      │ ALL           │
└────────────────────┴─────────────────────────┴─────────────────────────┴───────────────┴───────────────┘

🎯 Workflow Lengkap - Contoh Nyata

Skenario: Anda ingin mengelola .zshrc, .vimrc, dan .gitconfig

# 1. Install ghedot (jika belum)
npm install -g ghedot

# 2. Inisialisasi
ghedot init
# Pilih lokasi: ~/.dotfiles (default)
# Konfirmasi create directory: Yes

# 3. Cek file yang ada
ls -la ~ | grep "^\."

# 4. Copy file ke dotfiles directory
mkdir -p ~/.dotfiles
cp ~/.zshrc ~/.dotfiles/zshrc
cp ~/.vimrc ~/.dotfiles/vimrc
cp ~/.gitconfig ~/.dotfiles/gitconfig

# 5. Edit config untuk mendaftarkan files
cat > ~/.ghedot/ghedot.json << 'EOF'
{
  "dotfilesDir": "/home/user/.dotfiles",
  "backupDir": "/home/user/.ghedot/backups",
  "files": [
    {
      "source": "zshrc",
      "target": ".zshrc",
      "platforms": ["linux", "darwin"],
      "backup": true
    },
    {
      "source": "vimrc",
      "target": ".vimrc",
      "backup": true
    },
    {
      "source": "gitconfig",
      "target": ".gitconfig",
      "backup": true
    }
  ],
  "platform": "linux",
  "encrypted": []
}
EOF

# 6. Backup file asli
ghedot backup

# 7. Remove file asli (akan diganti dengan symlink)
rm ~/.zshrc ~/.vimrc ~/.gitconfig

# 8. Buat symlinks
ghedot link

# 9. Verifikasi
ls -la ~/.zshrc ~/.vimrc ~/.gitconfig
# Output:
# lrwxrwxrwx 1 user user 21 Nov 7 10:00 /home/user/.zshrc -> /home/user/.dotfiles/zshrc
# lrwxrwxrwx 1 user user 21 Nov 7 10:00 /home/user/.vimrc -> /home/user/.dotfiles/vimrc
# lrwxrwxrwx 1 user user 25 Nov 7 10:00 /home/user/.gitconfig -> /home/user/.dotfiles/gitconfig

# 10. Cek status
ghedot status

✨ Keuntungan Menggunakan ghedot

Setelah setup, semua perubahan pada dotfiles Anda akan otomatis tersinkron:

# Edit file di home directory
vim ~/.zshrc

# File di dotfiles directory juga berubah (karena symlink)
cat ~/.dotfiles/zshrc  # akan sama dengan ~/.zshrc

# Commit ke Git
cd ~/.dotfiles
git add .
git commit -m "Update zshrc configuration"
git push

# Di komputer lain
cd ~/.dotfiles
git pull
ghedot link  # create symlinks di komputer baru

🔐 Encryption Quick Start (NEW in v0.0.2!)

Encrypt your sensitive dotfiles safely! Perfect for API keys, credentials, SSH configs, and more.

# Encrypt .env file
ghedot encrypt .env
# ✓ Choose algorithm: ChaCha20-Poly1305 (recommended)
# ✓ Enter password: ********
# ✓ File encrypted: .env.encrypted

# Now safe to commit!
git add .env.encrypted
git commit -m "Add encrypted environment"

# Decrypt when needed
ghedot decrypt .env
# ✓ Enter password: ********
# ✓ File decrypted: .env

🎯 Common Use Cases

# Encrypt environment variables
ghedot encrypt .env
ghedot encrypt .env.production

# Encrypt API credentials
ghedot encrypt credentials.json
ghedot encrypt secrets.json

# Encrypt SSH configuration
ghedot encrypt .ssh/config

# Encrypt AWS credentials
ghedot encrypt .aws/credentials

# List all encrypted files
ghedot encrypt --list

📖 Full Encryption Guide: ENCRYPTION.md

💻 Quick Start

Mode 1: Interactive Menu (Recommended)

Jalankan tanpa argumen untuk masuk ke interactive menu:

bun run index.ts
# atau
bun run index.ts menu

Mode 2: Command Line

Gunakan commands langsung:

# 1. Initialize
bun run index.ts init

# 2. Add dotfile (dengan auto-suggestion!)
bun run index.ts add

# 3. Link dotfiles
bun run index.ts link

# 4. Check status
bun run index.ts status

📚 Commands

🔄 update - Check for Updates

Check if there's a newer version of ghedot available:

# Simple check
ghedot update

# Verbose output with full version info
ghedot update --verbose

# Alias command
ghedot check-version

Features:

• ✓ Checks npm registry for latest version
• ✓ Compares with current version
• ✓ Shows update instructions if available
• ✓ Cached for 24 hours (won't spam requests)
• ✓ Auto-checks on startup (compact notification)

Auto Update Notification:

ghedot automatically checks for updates once per day when you run any command. If an update is available, you'll see a compact notification:

📦 Update available: 0.0.1 → 0.0.2
   Run: bun install -g ghedot

🎨 menu - Interactive Menu

Mode interaktif dengan TUI yang indah:

bun run index.ts menu

Features:

• Navigasi dengan keyboard (↑/↓)
• Visual feedback real-time
• Easy untuk pemula

🚀 init - Initialize

Inisialisasi konfigurasi ghedot:

bun run index.ts init

# Dengan custom path
bun run index.ts init --path ~/my-dotfiles

Interactive prompts:

• ✓ Pilih lokasi dotfiles directory
• ✓ Auto-create directory jika belum ada
• ✓ Konfirmasi overwrite jika sudah ada config

➕ add - Add Dotfile

Tambah dotfile dengan auto-suggestions:

bun run index.ts add

Features:

• 📝 Auto-suggestions untuk dotfiles umum:
  • .bashrc, .zshrc, .vimrc
  • .gitconfig, .tmux.conf
  • .config/nvim/init.vim
  • PowerShell profiles (Windows)
  • i3/sway configs (Linux)
  • Dan banyak lagi!
• 🔍 Automatic file existence check
• 🎯 Platform-specific configuration
• 💾 Backup settings
• 📋 Copy file langsung ke dotfiles directory

🔗 link - Create Symlinks

Buat symbolic links untuk semua dotfiles:

# Normal link
bun run index.ts link

# Force overwrite existing files
bun run index.ts link --force

# Dry run (preview only)
bun run index.ts link --dry-run

# Verbose output
bun run index.ts link --verbose

Features:

• ⚡ Batch symlink creation
• ✓ Konfirmasi sebelum execute
• 📊 Progress indicator
• 📈 Success/failure summary

📊 status - Show Status

Tampilkan status dotfiles dengan beautiful table:

bun run index.ts status

Output includes:

• 📋 Configuration summary
• 📊 Beautiful status table
• ✓ File existence indicators
• 🎨 Color-coded status
• 🏷️ Platform badges

💾 backup - Backup Dotfiles

Backup semua dotfiles:

# Simple backup
bun run index.ts backup

# Dengan timestamp
bun run index.ts backup --timestamp

# Dry run
bun run index.ts backup --dry-run

♻️ restore - Restore Dotfiles

Restore dari dotfiles directory:

# Restore all
bun run index.ts restore

# Dry run
bun run index.ts restore --dry-run

🔑 password - Password Management

Manage encryption password profiles with interactive TUI:

# Interactive menu
ghedot password

# List all password profiles
ghedot password --list

# Generate a strong password
ghedot password --generate

# Generate with custom length
ghedot password --generate --length 32

Features:

• ➕ Create password profiles - Save password metadata for different environments
• 📋 List profiles - View all saved password profiles with hints and timestamps
• 🗑️ Remove profiles - Delete password profiles when no longer needed
• 🎲 Generate passwords - Create strong, cryptographically secure passwords (8-128 characters)
• 🔍 Check strength - Test password strength with visual indicators and feedback
• 📝 Environment variables - Get setup instructions for password environment variables

Interactive Menu Options:

1. Add password profile - Create a new password profile

   • Enter profile name (e.g., production, staging, personal)
   • Set password (not stored, only metadata)
   • Add optional hint for easy recall
   • Get environment variable setup instructions

2. List password profiles - View all saved profiles

   • See profile names, hints, created dates, last used dates
   • Get environment variable names for each profile

3. Remove password profile - Delete a profile you no longer need

4. Generate strong password - Create a random secure password

   • Choose length (8-128 characters)
   • Includes mixed case, numbers, and symbols
   • Visual strength indicator

5. Check password strength - Test your password

   • Visual strength meter (Weak/Fair/Good/Strong)
   • Detailed feedback on how to improve
   • Detection of common patterns

6. Show environment variables - View password setup instructions

   • General password: GHEDOT_ENCRYPTION_PASSWORD
   • Profile-specific: GHEDOT_PASSWORD_<PROFILE_NAME>
   • Usage examples for each profile

Password Profiles:

Password profiles help you organize different passwords:

• 🏭 Production - Production environment secrets
• 🧪 Staging - Staging/testing environment
• 👤 Personal - Personal projects
• 👥 Team - Shared team secrets

Example Workflow:

# 1. Create a password profile
ghedot password
# Select: Add password profile
# Name: production
# Enter password: [your strong password]
# Hint: Production API keys

# 2. Set environment variable
export GHEDOT_PASSWORD_PRODUCTION="your-password"

# 3. Use with encryption (will auto-detect profile)
ghedot encrypt .env
# Select: Use saved password profile? Yes
# Select: production
# ✓ File encrypted!

Security Note:

• Passwords are NOT stored by ghedot
• Only metadata (name, hint, timestamps) is saved
• Actual passwords must be set via environment variables
• This keeps your passwords secure while organizing encryption workflows

🔐 encrypt - Encrypt Sensitive Dotfiles

Encrypt sensitive files dengan password protection:

# Interactive encrypt
ghedot encrypt

# Encrypt specific file
ghedot encrypt .ssh/config

# List encrypted files
ghedot encrypt --list

# Specify encryption algorithm
ghedot encrypt .env --algorithm chacha20
ghedot encrypt .env --algorithm aes256

Features:

• 🔒 Password-protected - Secure with strong password (minimum 8 characters)
• 🛡️ Two encryption algorithms:
  • ChaCha20-Poly1305 - Modern, fast, secure (recommended)
  • AES-256-GCM - Industry standard, hardware accelerated
• 🔑 PBKDF2 key derivation - 100,000 iterations with unique salt
• 📝 Metadata tracking - Tracks encrypted files in config
• 🔍 List encrypted files - View all encrypted files with details
• 🎯 Safe for git - Encrypted files are safe to commit to public repos
• ⚡ Interactive prompts - Password confirmation and algorithm selection

Use cases:

• 🔐 API keys and tokens
• 🔑 SSH keys and configs
• 📧 Email credentials
• 💳 Sensitive environment variables
• 🔒 Any dotfile with secrets

🔓 decrypt - Decrypt Encrypted Dotfiles

Decrypt encrypted files when needed:

# Interactive decrypt
ghedot decrypt

# Decrypt specific file
ghedot decrypt .ssh/config

# Specify output path
ghedot decrypt .env --output .env.local

# Keep encrypted file after decryption
ghedot decrypt .env --keep-encrypted

Features:

• 🔓 Password verification - Secure password-based decryption
• 📊 Encryption info - Shows algorithm and encryption metadata
• 📁 Flexible output - Decrypt to custom location
• 🗑️ Optional cleanup - Remove encrypted file after decryption
• ✅ Validation - Verifies encrypted file format and integrity
• ⚠️ Error handling - Clear error messages for invalid passwords

🎯 Usage Examples

Example 1: First Time Setup (Interactive)

# Run interactive menu
bun run index.ts

# Select: 🚀 Initialize
# Enter dotfiles path: /home/user/.dotfiles
# Confirm create directory: Yes

# Select: ➕ Add dotfile
# Choose from suggestions: .bashrc
# Source name: bashrc
# Platform: All platforms
# Backup: Yes
# Copy now: Yes

# Select: 🔗 Link dotfiles
# Confirm: Yes
# ✓ Success!

# Select: 📊 Show status
# View beautiful table

# Select: 👋 Exit

Example 2: Command Line Workflow

# Initialize
bun run index.ts init

# Add multiple dotfiles
bun run index.ts add  # Choose .bashrc
bun run index.ts add  # Choose .vimrc
bun run index.ts add  # Choose .gitconfig

# Preview what will be linked
bun run index.ts link --dry-run

# Link for real
bun run index.ts link

# Check status
bun run index.ts status

Example 3: Platform-Specific Setup

# Add Linux-only file
bun run index.ts add
# Select: .xinitrc
# Platform: Linux only

# Add Windows-only file
bun run index.ts add
# Select: PowerShell profile
# Platform: Windows only

# Add cross-platform file
bun run index.ts add
# Select: .gitconfig
# Platform: All platforms

# Link akan otomatis filter berdasarkan platform saat ini
bun run index.ts link

Example 4: Encrypting Sensitive Files

# Encrypt SSH config with interactive prompts
ghedot encrypt .ssh/config
# Choose algorithm: ChaCha20-Poly1305
# Enter password: ********
# Confirm password: ********
# ✓ File encrypted successfully!
# ✓ Created: .ssh/config.encrypted

# List all encrypted files
ghedot encrypt --list

# Decrypt when needed
ghedot decrypt .ssh/config
# Enter password: ********
# ✓ File decrypted successfully!

# Encrypt environment file with AES-256
ghedot encrypt .env --algorithm aes256
# Now safe to commit .env.encrypted to git!

🗂️ Project Structure

ghedot/
├── index.ts                      # Main CLI entry
├── src/
│   ├── cli/                      # Command handlers
│   │   ├── init.ts               # Initialize dengan TUI
│   │   ├── add.ts                # Add dengan auto-suggestions
│   │   ├── link.ts               # Link dengan progress
│   │   ├── backup.ts             # Backup dengan konfirmasi
│   │   ├── restore.ts            # Restore dengan warning
│   │   ├── status.ts             # Status dengan tables
│   │   ├── encrypt.ts            # Encrypt sensitive files
│   │   ├── decrypt.ts            # Decrypt encrypted files
│   │   └── menu.ts               # Interactive menu
│   ├── core/
│   │   └── dotfiles.ts           # Core operations
│   ├── config/
│   │   └── index.ts              # Config management
│   ├── utils/
│   │   ├── platform.ts           # Cross-platform utils
│   │   ├── fs.ts                 # File operations
│   │   ├── crypto.ts             # Encryption utilities
│   │   ├── tui.ts                # TUI components (@clack)
│   │   ├── table.ts              # Table formatting
│   │   ├── file-selector.ts     # Auto-suggestions
│   │   ├── logger.ts             # Logging
│   │   └── prompt.ts             # Prompts
│   └── types/
│       └── index.ts              # TypeScript types
├── package.json
└── README.md

🎨 TUI Features

Interactive Prompts

• Text Input: Dengan placeholder dan validation
• Confirm: Yes/No dengan default values
• Select: Single choice dengan hints
• Multi-select: Multiple choices
• Auto-complete: Dengan fuzzy search

Visual Elements

• Spinners: Loading indicators
• Tables: Beautiful formatted tables
• Notes: Info boxes
• Colors: Syntax highlighting
• Icons: Emoji untuk better UX

Auto-Suggestions

ghedot menyediakan auto-suggestions untuk dotfiles umum:

Cross-Platform:

• .bashrc, .zshrc, .profile
• .vimrc, .config/nvim/init.vim
• .gitconfig
• .tmux.conf
• .ssh/config
• VSCode settings

Windows:

• PowerShell profiles
• .wslconfig
• .minttyrc

Linux:

• .xinitrc, .Xresources
• i3/sway configs
• Polybar configs

⚙️ Configuration

File konfigurasi: ~/.ghedot/ghedot.json

{
  "dotfilesDir": "/home/user/.dotfiles",
  "backupDir": "/home/user/.ghedot/backups",
  "platform": "linux",
  "files": [
    {
      "source": "bashrc",
      "target": ".bashrc",
      "platforms": ["linux", "darwin"],
      "backup": true
    },
    {
      "source": "vimrc",
      "target": ".vimrc",
      "backup": true
    }
  ],
  "encrypted": [
    {
      "source": ".ssh/config",
      "algorithm": "chacha20-poly1305",
      "encryptedAt": "2024-01-15T10:30:00.000Z",
      "encryptedFile": ".ssh/config.encrypted"
    }
  ]
}

🔧 Cross-Platform Details

Windows

• ✓ Symbolic links (requires Admin or Developer Mode)
• ✓ PowerShell profile support
• ✓ WSL configuration
• ✓ Auto path conversion (\ separators)
• ✓ cmd /c mklink for symlinks

Linux

• ✓ Standard ln -sf symlinks
• ✓ XDG Base Directory support
• ✓ Linux-specific configs (i3, sway, etc.)
• ✓ Shell configurations

macOS

• ✓ Unix-like symlinks
• ✓ macOS-specific paths
• ✓ Compatible dengan Homebrew

🎯 Tips & Tricks

1. Use Interactive Menu for Beginners

bun run index.ts menu

Lebih mudah dengan visual guidance!

2. Always Dry Run First

bun run index.ts link --dry-run

Preview sebelum execute.

3. Backup Before Major Changes

bun run index.ts backup --timestamp

Aman untuk rollback.

4. Check Status Regularly

bun run index.ts status

Monitor broken links atau missing files.

5. Use Platform-Specific Configs

Pisahkan configs per-OS untuk flexibility.

📋 Command Reference

Quick reference for all ghedot commands:

| Command | Description | Example | |---------|-------------|---------| | ghedot menu | Interactive TUI menu | ghedot menu | | ghedot init | Initialize configuration | ghedot init | | ghedot add | Add dotfile to manage | ghedot add | | ghedot link | Create symlinks | ghedot link --force | | ghedot unlink | Remove symlinks | ghedot unlink | | ghedot status | Show dotfiles status | ghedot status | | ghedot doctor | Diagnose issues | ghedot doctor | | ghedot backup | Backup dotfiles | ghedot backup --timestamp | | ghedot restore | Restore dotfiles | ghedot restore | | ghedot sync | Sync with git | ghedot sync --push | | ghedot encrypt | Encrypt file | ghedot encrypt .env | | ghedot decrypt | Decrypt file | ghedot decrypt .env | | ghedot update | Check for updates | ghedot update |

Encryption Commands

| Command | Options | Description | |---------|---------|-------------| | ghedot encrypt [file] | --list | List all encrypted files | | | --algorithm <type> | Choose algorithm (chacha20, aes256) | | ghedot decrypt [file] | -o, --output <path> | Custom output path | | | --keep-encrypted | Keep encrypted file after decrypt |

🐛 Troubleshooting

❌ Error: "No dotfiles configured"

Problem: Ketika menjalankan ghedot link muncul error:

▲  No dotfiles configured. Run "ghedot add" to add files.

Solution:

# 1. Pastikan sudah init
ghedot init

# 2. Verifikasi config file ada
cat ~/.ghedot/ghedot.json

# 3. Jika config kosong, tambahkan files secara manual
# Edit ~/.ghedot/ghedot.json dan tambahkan entry files
# Atau gunakan command add
ghedot add

Contoh config yang benar:

{
  "dotfilesDir": "/home/user/.dotfiles",
  "backupDir": "/home/user/.ghedot/backups",
  "files": [
    {
      "source": "zshrc",
      "target": ".zshrc",
      "platforms": ["linux"],
      "backup": true
    }
  ],
  "platform": "linux",
  "encrypted": []
}

❌ Error: "Configuration not found"

Problem: Muncul error "Configuration not found. Run 'ghedot init' first."

Solution:

# Jalankan init untuk membuat config
ghedot init

# Verifikasi config dibuat
ls -la ~/.ghedot/ghedot.json

❌ Symlink Fails on Windows

Problem: Tidak bisa membuat symlink di Windows

Solution:

• Run as Administrator, atau
• Enable Developer Mode (Windows 10/11)
  1. Settings → Update & Security → For Developers
  2. Enable "Developer Mode"

❌ File Already Exists

Problem: Error saat link karena file sudah ada

Solution:

# Option 1: Backup dulu
ghedot backup

# Option 2: Force overwrite
ghedot link --force

# Option 3: Hapus file manual
rm ~/.zshrc
ghedot link

❌ Symlink Broken / Not Working

Problem: Symlink dibuat tapi tidak berfungsi

Solution:

# 1. Cek apakah source file ada
ls -la ~/.dotfiles/

# 2. Cek symlink
ls -la ~/.zshrc

# 3. Jika broken, unlink dan link ulang
ghedot unlink
ghedot link

# 4. Verifikasi dengan status
ghedot status

❌ Colors Not Showing

Problem: Tidak ada warna di output

Solution: ghedot menggunakan ANSI colors. Pastikan terminal support colors atau coba terminal lain (iTerm2, Windows Terminal, etc.)

❌ Permission Denied

Problem: Error permission saat buat symlink atau copy file

Solution:

# Cek permission dotfiles directory
ls -la ~/.dotfiles

# Fix permission jika perlu
chmod 755 ~/.dotfiles
chmod 644 ~/.dotfiles/*

# Atau jalankan dengan sudo (tidak disarankan)
sudo ghedot link

💡 Debug Mode

Untuk debugging lebih detail, gunakan:

# Verbose mode
ghedot link --verbose

# Dry run untuk preview
ghedot link --dry-run

# Check doctor untuk diagnosa
ghedot doctor

📦 Dependencies

• @clack/prompts - Beautiful CLI prompts
• picocolors - Terminal colors
• ora - Spinners
• cli-table3 - Tables
• fuzzy - Fuzzy search
• commander - CLI framework
• chalk - Colors (fallback)

🚀 Development

Run in Dev Mode

bun --hot index.ts

Build (Optional)

bun build index.ts --compile --outfile ghedot

Test Commands

# Test with dry-run
bun run index.ts link --dry-run
bun run index.ts backup --dry-run

📚 Documentation

Comprehensive documentation available in multiple formats:

• 📖 Quick Start Guide - Get started in 5 minutes
• 🇮🇩 Cara Penggunaan (Bahasa Indonesia) - Panduan lengkap dalam bahasa Indonesia
• 🔐 Encryption Guide - Detailed encryption documentation
• 🪟 Windows Support - Windows-specific instructions
• 📁 Custom Folders - Using custom folder names
• 📋 Changelog - Version history and updates
• 📝 Install Guide - Installation instructions

📄 License

MIT

🙏 Credits

Built with:

• Bun - Fast all-in-one JavaScript runtime
• @clack/prompts - Beautiful CLI prompts
• cli-table3 - Tables

Made with ❤️ using Bun.js