New — Iris AI drafts your firewall, routing & rate-limit rules. Explore AI features →
Changelog
CLI & MCP

ngris 0.5.0: update every machine, and give app commands an API key

ngris 0.5.0 is out. Update every machine that runs ngris: older versions will stop connecting. App commands now run with an API key or an account key.

ngris 0.5.0: update every machine, and give app commands an API key

ngris 0.5.0 brings the whole ngris API to your terminal, plus deploy hooks and Git settings from the CLI, key login for tunnels, and a local page that looks like your dashboard. A few changes need a minute on each machine before you update.

Above, Maya has updated her laptop. Her tunnels log in with her auth token as before; her app commands ask for an API key once. She pipes it in, so it stays out of her shell history.

Before you update

  • Update every machine that runs ngris. ngris will require version 0.5.0 for every agent, tunnels included, and older versions will stop connecting. Update each computer, server, container and CI job.
  • App commands need an API key or an account key. ngris deploy, apps, apps cron, apps hooks, env, promote, rollback and client-cert no longer work with your auth token alone. Save a key once on each machine with ngris auth --api-key: your own API key, or an account key for CI. Your auth token keeps logging in your tunnels.
  • CI jobs that run ngris deploy with an auth token switch to an account key in the NGRIS_API_KEY secret. A job that already passes an API key or account key changes nothing.
  • macOS 13 Ventura or later. ngris 0.5.0 doesn't run on macOS 12 or older.
  • No config.yaml from the folder you run ngris in. The CLI uses your personal config, or the file you pass with --config. Services and containers that keep their config in the working folder add --config <path>.
  • --basic-auth on an endpoint that asks its users for a second step is refused, and the endpoint stays closed. Add those users in the dashboard, and give scripts an access token.
  • ngris env list prints a table. Scripts that need .env format use ngris env pull.
  • ngris tcp and ngris udp refuse client certificate and sign-in options. They work on HTTP(S) endpoints only.

Also in 0.5.0

Get started

  1. Update ngris: run the install command from ngris.com/install again, or brew upgrade ngris / winget upgrade Ngris if you installed that way. The container image is ghcr.io/ngris-edge/ngris:0.5.0.
  2. Create a key: your API key under User settings → API keys, or an account key under Account → Account keys for CI.
  3. Run ngris auth --api-key once on each machine that runs app commands, or set NGRIS_API_KEY from your CI's secret store.
  4. Read the docs: Updating the agent and Account keys.

Read the docs

Ask an AI to summarise this page
Deploy
App hosting Edge functions Domains & certificates
Connect
Secure tunnels API gateway Multi-region edge
Protect
Bot protection & challenge WAF & firewall Edge login
Observe & AI
Monitoring Inspector & replay Iris AI MCP server AI Gateway
Developers
Developer tools Docs ngrok policy converter Blog Changelog
Compare
Ngris vs ngrok Ngris vs Cloudflare Tunnel Ngris vs Vercel Ngris vs Netlify Expose localhost guide
More
Solutions Pricing Enterprise Sign in Get Started Free