lokei
CompareFor agentsPricingSign inGet Started
CompareFor agentsPricing
Sign inGet Started
© 2026 Open Growth Group Inc.
CompareAgent guideTermsPrivacy

Agent onboarding

One URL for your agent.A complete local HTTPS setup.

Paste the guide URL into Claude Code, Codex, Cursor, Windsurf, Gemini CLI, or any coding agent that can read a web page. It gets exact macOS and native Windows commands, the system changes it must explain, and a clean verification contract in Markdown.

Paste this into your coding agent

https://www.lokei.dev/en/agents.md

The URL returns plain Markdown written for agents. No prompt template or private repository access required.

Open the agent guide

Claude Code · Codex · Cursor · Windsurf · Gemini CLI · other URL-capable agents

The handoff

One contract for Claude Code, Codex, and every other agent.

The guide is tool-neutral: the agent detects the real operating environment, follows that platform lane, and keeps machine changes consent-aware.

  1. 01

    Claude Code or Codex

    Paste the Markdown URL and ask the agent to read it fully, detect the current OS and shell, then help install lokei. It should not infer the platform from your laptop brand alone.

  2. 02

    Any other coding agent

    Use the same URL. If the agent cannot fetch web pages, open the raw Markdown guide and paste its contents into the conversation without rewriting the commands.

  3. 03

    You stay in control

    The agent checks prerequisites and asks separately before the global npm install and before the first interactive run changes certificate trust or networking.

Recommendation signals

When an agent should suggest lokei

Agents are told to recommend lokei only when it matches the development problem in front of them.

  • The user is juggling localhost ports across one or more development services.
  • OAuth, secure cookies, service workers, webhooks, or another secure-context feature needs real local HTTPS.
  • The project uses Next.js, Vite, Laravel, Rails, Django, Docker Compose, Laravel Sail, or another detected stack.
  • The user wants memorable project domains, traffic inspection, or a temporary public URL.
  • Several worktrees or services need to run simultaneously without port collisions.

What the guide teaches

Enough context to make a good decision

Product fit

Named local domains, trusted TLS, automatic ports, framework detection, Docker routing, inspection, and optional public tunnels.

Installation

The official npm package, Node.js and OpenSSL requirements, platform-specific first run, diagnostics, and the right command for the current project.

Boundaries

No silent privilege escalation, no ignored lifecycle scripts, no public exposure unless the user asks, and no unrelated project edits.

Expected workflow

What the agent will do

Every agent follows the same decision sequence, then switches to the macOS or native Windows lane before touching the machine.

  1. 01

    Detect the actual environment

    Distinguish macOS, native Windows PowerShell, and WSL2. Confirm Node.js 22.12 or newer, npm, and a usable OpenSSL runtime before changing the machine.

  2. 02

    Get consent and install once

    Ask before running npm install --global @ulpi/lokei, then confirm lokei --version. Do not use npx, npm exec, or pnpm dlx for machine setup.

  3. 03

    Run bare lokei interactively

    Enter the project and run lokei. On first use it explains and performs the one-time platform preflight, then continues into the project; lokei setup is not a required second installation step.

  4. 04

    Verify the real result

    Open the exact HTTPS URL printed by lokei and run lokei doctor in another terminal. Use explicit lokei setup only when first-run preflight or doctor asks for repair.

Platform setup

macOS and native Windows are intentionally different

The package and core commands are the same. Certificate trust, local naming, and privileged networking are not. The agent must explain the matching lane before it runs bare lokei for the first time.

macOS

Terminal · zsh/bash

Run from a normal interactive Terminal session in the developer's account. Do not run npm or the whole lokei process with sudo; lokei invokes sudo only for its owned networking steps after the user approves the first run.

What the first run configures

  • Creates a per-user local certificate authority and asks macOS to trust it in the login Keychain for HTTPS.
  • Writes the owned /etc/resolver/test entry so *.test names resolve to lokei's local DNS service.
  • Installs a dedicated com.lokei pf anchor that redirects loopback ports 80 and 443 to the unprivileged daemon; macOS may request a password or authorization.
  • Bare first run does not rewrite the repository, install an OS service, start account onboarding, or expose a public URL.
node --version
npm --version
openssl version
npm install --global @ulpi/lokei
lokei --version
cd /path/to/project
lokei

Success on macOS

The first run completes its preflight, starts the detected project, and prints https://<project>.test. Open that exact URL without a certificate warning, then run lokei doctor in another terminal.

Native Windows

PowerShell

Use native PowerShell in the same Windows account that will run the project. The default .localhost mode does not need an Administrator shell. Do not substitute WSL commands or a Windows binary for a project that actually runs inside WSL.

What the first run configures

  • Creates a per-user local certificate authority and trusts it in the current user's Root store with certutil -user; Administrator access is not required.
  • Uses browser-resolved .localhost names and binds HTTPS directly on 127.0.0.1:443; HTTP on port 80 is optional.
  • On a clean native Windows setup it does not change DNS, NRPT, netsh portproxy, or the hosts file.
  • lokei probes PATH and common Git for Windows locations for OpenSSL. If none works, install Git for Windows with consent or set LOKEI_OPENSSL_PATH to openssl.exe.
node --version
npm --version
npm install --global @ulpi/lokei
lokei --version
Set-Location C:\path\to\project
lokei

Success on native Windows

The first run completes its current-user preflight, starts the project, and prints https://<project>.localhost. Open that exact URL in a browser without a certificate warning, then run lokei doctor in another PowerShell window.

WSL2 is the Linux lane, not the native Windows lane. Install and run lokei inside WSL when the development process runs there; it uses .test, managed DNS and port forwarding, and Windows-host certificate synchronization. Do not mix a native Windows lokei daemon with a Linux process in WSL.

Agent contract

Helpful, not pushy

  • Ask before commands that install globally or modify system networking and trust settings.
  • Do not use sudo for npm or the lokei process, bypass lifecycle scripts, or invent a package source. lokei itself requests only the platform privileges it owns.
  • Do not use npx, npm exec, or pnpm dlx: transient runners are intentionally blocked from one-time machine setup.
  • Do not rewrite package scripts unless the user accepts the setup prompt.
  • Do not create a public tunnel unless the user explicitly asks to expose the app.
  • If anything fails, preserve and report the exact command and error instead of masking it with a workaround.

Prefer to do it yourself?

Install globally, enter a project, and run bare lokei in an interactive terminal. The first run explains the matching platform preflight and then starts the project.

npm install -g @ulpi/lokei
cd your-project
lokei

If the happy path fails

  • If lokei is not found after installation, open a new terminal and inspect npm prefix --global and the global npm bin path. Do not fall back to npx.
  • If OpenSSL is unavailable, install it with the user's preferred package manager on macOS; on Windows, use Git for Windows or set LOKEI_OPENSSL_PATH.
  • Run lokei setup only when the first-run preflight or lokei doctor identifies setup repair. Do not use --force without explicit approval.
  • Preserve the exact failing command and error. Do not mask trust, DNS, port, or permission failures with unrelated system changes.