Skip to main content
Docs

Getting Started with the Asyx CLI

Secure tunnels in one command. This guide mirrors the npm README so you can go from zero to a live HTTPS link in minutes.

Get started

Create a free account at asyx.ai/register — email only, no invite code.

Requirements

  • Node.js 18.17+
  • macOS, Windows, or Linux shell with access to your web browser

Install or Run On-Demand

Install globally for everyday use:

npm install -g asyx

Prefer not to install? Use npx:

npx asyx@latest --help

To upgrade later:

npm update -g asyx

Step 1 — Authorize the Client

asyx setup

What happens:

  • Opens your browser to complete passwordless login.
  • Reserves a personal https://<name>.tunnel.asyx.ai address.
  • Provisions device-bound certificates under ~/.asyx/certs/<clientId>/.
  • Stores a hashed hardware fingerprint locally—raw device data never leaves your machine.

Re-run asyx setup on each device you want to trust; certificates are single-device.

Step 2 — Open a Tunnel

asyx tunnel --http --port 3000
  • Publishes the service running on localhost:3000.
  • Keeps JWTs fresh in-band so the session stays up without restarts.
  • Prints your stable public URL, for example https://sample.tunnel.asyx.ai.

Need to run a different port? Change --port—your URL stays the same.

Optional: restrict who can open the link (Quickpass)

By default, anyone with the URL can visit your tunnel. To share with specific people only — client previews, private demos, invite-only file shares — use Quickpass:

asyx tunnel --http --port 3000 --secgroup reviewers

Create the reviewers group and add member emails in Console → Quickpass. No changes to your application code.

Step 3 — Share or Test

  • Send the URL to teammates or stakeholders.
  • Use it for webhooks, mobile testing, or demo links—TLS is handled automatically.
  • When you’re done, Ctrl+C ends the tunnel.

Optional Cleanup

Delete local enrollment material (you’ll have to run setup again).

rm -rf ~/.asyx/certs/<clientId>

Useful Commands

asyx help                   # CLI overview
asyx tunnel --http --port <n>  # Publish a local HTTP service
ASYX_LOG_LEVEL=debug asyx tunnel --http --port 3000  # Verbose logging

Environment toggles:

  • ASYX_LOG_LEVEL → error | warn | info | debug (default info)
  • ASYX_DEBUG=1 → include heartbeat and reconnect traces

Troubleshooting

  • Browser did not open: Copy the printed URL into a browser manually.
  • Need an account: Sign up at asyx.ai/register before running asyx setup.
  • Reinstalling: Run npm uninstall -g asyx followed by a fresh install.

Need help? Email support@asyx.ai or mention us in the Asyx community.

More guides