nlook-router

Local router for nlook.me — executes workflows, provides SSH terminal, relays WebSocket communication.

Quick Start

# Install (downloads binary automatically)
npm install -g nlook-router

# Set your API key (get it from nlook.me → Settings → Routers)
nlook-router config set api_key YOUR_API_KEY

# Start
nlook-router router start

That's it! Your router will connect to nlook.me and appear in Settings → Routers.

What It Does

• Workflow Execution — Runs your workflows locally with step-by-step data pipeline
• SSH Terminal — Access your machine's terminal from nlook.me web UI
• Real-time Sync — WebSocket relay between nlook.me and your machine
• Auto Update — Checks for new versions on startup

Commands

nlook-router router start      # Start the router daemon
nlook-router router status     # Check connection status
nlook-router config list       # Show current configuration
nlook-router config set <key> <value>  # Set a config value
nlook-router self-update       # Update to latest version
nlook-router workflow list     # List your workflows
nlook-router workflow run <id> # Run a workflow

Configuration

Config file: ~/.nlook/config.yaml (created automatically on install)

api_url: https://nlook.me
api_key: your-api-key-here
router_id: ""
port: 3333

Requirements

• Node.js 18+ (for npm installer)
• macOS, Linux, or Windows

Links

• nlook.me
• GitHub
• Releases