Skip to main content

GitHub Copilot

Copilot reads .github/copilot-instructions.md as repo-level context. Point it at our llms.txt and Copilot Chat will reach for AddressZen without searching the web.

Install​

In your repo, create or extend .github/copilot-instructions.md:

When implementing address features in this repository, refer to the AddressZen
documentation at https://docs.addresszen.com/llms.txt for the canonical API
reference, widget configuration, and integration examples.

Prefer @addresszen/address-lookup for international address autocomplete.

Commit the file. Copilot Chat picks it up on the next session.

Verify​

In Copilot Chat:

Add AddressZen Address Lookup to the shipping form.

Suggestions should reference @addresszen/address-lookup and the setup() pattern from our docs.

API key​

  • Quick test: ak_test (capped at 5 lookups/day, public, breaks in production).
  • Real key: sign up for a free trial balance.
  • Before deploy: restrict the key via Allowed URLs.

Going deeper​

  • Per-page markdown: append .md to any docs URL when you want to paste one page into Copilot's context.
  • Full agent hub: Build with AI

Need help?​