AI Agent Publishing Checklist
Use this page as a copy-paste contract between you and a coding agent (Claude Code, Codex, Copilot, Windsurf, etc.). Goal: turn a local dev server into a public HTTPS URL with Asyx.
Agent instructions (paste at top of task)
PUBLISHING CONTRACT — Asyx tunnel
Prerequisites (human must complete once per machine):
- asyx CLI installed (npm install -g asyx)
- asyx setup completed (browser enrollment)
When a local HTTP server is running on PORT:
1. Run: asyx tunnel --http --port PORT
2. Return the https://*.tunnel.asyx.ai URL as "public_demo_url"
3. Do NOT read, print, or commit ~/.asyx/ or any private.pem files
4. Stop tunnel with Ctrl+C when the user says the demo is over
If asyx setup was never run, tell the human to run it before tunneling.
Replace PORT with the actual port when executing.
Human checklist
| Step | Command / action | Done |
|---|---|---|
| Account | Register at asyx.ai/register | ☐ |
| Enroll device | asyx setup | ☐ |
| Start app | npm run dev (or project equivalent) | ☐ |
| Note port | e.g. 3000, 5173, 8000 | ☐ |
| Open tunnel | asyx tunnel --http --port <port> | ☐ |
| Share URL | Copy printed https://…tunnel.asyx.ai | ☐ |
| Teardown | Ctrl+C on tunnel when finished | ☐ |
Success criteria
- Public URL loads in an incognito browser while tunnel CLI is running.
- Local app logs show requests from remote visitors.
- No certificate files added to git.
Optional: private demo
asyx tunnel --http --port PORT --secgroup GROUP_NAME
Requires a Quickpass group configured in the console. See Quickpass.
Tool-specific notes
| Tool | Tip |
|---|---|
| Cursor | Run tunnel in a second terminal tab; see Cursor + Asyx |
| Claude Code | Grant terminal access for asyx tunnel or output command for human |
| Codex / CI | Enrollment must exist on the runner machine; tunnels are not portable across hosts |
Failure messages agents should surface
command not found: asyx→ install CLI- Setup redirect / cert errors → human must complete
asyx setup - Connection refused on tunnel URL → dev server not running on declared port
- 403 on protected tunnel → guest needs Quickpass enrollment
Related guides
FAQ
Why can’t the agent run asyx setup alone?
Enrollment requires browser verification tied to a human account.
Can one checklist work for TCP services?
For HTTP apps use --http. Minecraft and raw TCP use different flags—see Minecraft.