Skip to content

Getting Started

Quick Start Guide

Get up and running with Kodachi security binaries in minutes.


Installation

# Default installation to ~/dashboard/hooks
curl -sSL https://www.kodachi.cloud/apps/os/install/kodachi-binary-install.sh | bash

# Install to Desktop
curl -sSL https://www.kodachi.cloud/apps/os/install/kodachi-binary-install.sh | bash -s -- --desktop

# Custom installation path
curl -sSL https://www.kodachi.cloud/apps/os/install/kodachi-binary-install.sh | bash -s -- --path /opt/kodachi

Post-Installation Setup

# Add binaries to PATH
export PATH="$HOME/dashboard/hooks:$PATH"

# Or source the environment script
source ~/dashboard/hooks/kodachi-env.sh

# Verify installation
ip-fetch --version
tor-switch --version
health-control --version

For detailed installation instructions, see the Installation Guide.


Troubleshooting

Connection Issues

# Recover routing/network issues
sudo ./routing-switch recover

# Recover internet connectivity
sudo ./health-control recover-internet --force

# Reset DNS to defaults
sudo ./dns-switch reset

Authentication Problems

# Re-authenticate
sudo ./online-auth logout
sudo ./online-auth authenticate

# For long sessions, use --relogin for automatic reconnection
sudo ./online-auth authenticate --relogin

# Check if blocked
./online-auth check-if-blocked

Binary Overview

Network & Anonymity

  • tor-switch - Advanced Tor network orchestration (107 commands)
  • routing-switch - Multi-protocol routing engine (12 protocols)
  • ip-fetch - Secure IP geolocation with verification
  • dns-switch - DNS management with 50+ resolvers
  • dns-leak - Real-time DNS leak detection

Security & Protection

System Management

AI & Intelligence


Next Steps

  1. Explore Network Tools: Review the Network Tools Overview for advanced features
  2. Configure Security: Set up Health Control panic modes
  3. Test Your Setup: Use DNS Leak to verify privacy
  4. Learn Commands: Run any binary with --help or --examples flags

Quick Reference

# Help and examples for any binary
./tor-switch --help
./tor-switch --examples
./tor-switch --version

# JSON output for automation
./ip-fetch fetch --json-human
./health-control net-check --json-human
./dns-leak test --json-human

# Human-readable JSON output
./ip-fetch fetch --json-human
./tor-switch status --json-human
./routing-switch list-protocols --json-human