Agent guide
For AI coding agents. How to set up, upgrade or answer questions about any Axonpack package from these docs. Read it before changing an app.
This page is for an AI coding agent working in someone's app, and it applies to every Axonpack package. What belongs to one package is on that package's pages. The docs describe the latest release of each package, so take every fact from a page, never from memory.
Where to look
<name> is the package's name without the scope, such as expo-devtools for
@axonpack/expo-devtools, and <page> is a page's path inside its section.
| You need | Where |
|---|---|
| The list of packages | The Packages section of https://axonpack.dev/llms.txt, or the docs home, https://axonpack.dev/docs/ |
| Every page | https://axonpack.dev/llms.txt, each with a one-line description and a link to its markdown copy |
| One page | https://axonpack.dev/docs/<name>/<page>/, or as markdown, https://axonpack.dev/llms.mdx/docs/<name>/<page>/content.md |
| A package's overview | https://axonpack.dev/docs/<name>/, or as markdown, https://axonpack.dev/llms.mdx/docs/<name>/content.md |
| Every page in one file | https://axonpack.dev/llms-full.txt. Search it for a word. |
| Setting a package up | The package's installation page, then quick-start, and compatibility where it has one |
| A problem with a package | The package's troubleshooting page where it has one |
| What changed in a release | The package's changelog page, node_modules/@axonpack/<name>/CHANGELOG.md in the app, or https://github.com/axonpack/axonpack/releases |
| The latest version | npm view @axonpack/<name> version. npm view @axonpack/<name> versions lists every one. |
| What a running app did | @axonpack/expo-devtools: its ai-agents page, its reference/cli page, and devtools --help through the project's runner |
| What an agent asked the app | devtools ai-usage, and the reference/ai-usage-tab page of @axonpack/expo-devtools |
| The agent skill | Agent skill |
| Blog posts | https://axonpack.dev/blog/, also listed at the end of llms.txt |
| Example apps and source | https://github.com/axonpack/axonpack/tree/main/packages/@axonpack/<name>. The example apps are its folders whose names start with example. |
| Known bugs | https://github.com/axonpack/axonpack/issues |
Setting a package up
Do these in order, and finish each one before the next.
- Find the package manager from the lockfile in the app's folder, or in the nearest parent folder
that has one:
package-lock.jsonis npm,yarn.lockis yarn,pnpm-lock.yamlis pnpm, andbun.lockorbun.lockbis bun. With no lockfile, ask the user. Never add a second lockfile. The docs writenpxandnpm install, so use the project's own runner (npx,yarn,pnpm execorbunx) and its own add command. Under bun,npxcan't see what bun installed. In an Expo app, add packages with<runner> expo install, which picks versions that match the SDK. - Check the version.
npm view @axonpack/<name> versionprints the latest release, which is what the docs describe. If the app already has the package at another version (seenode_modules/@axonpack/<name>/package.json), read the changelog page for what changed in between, and the upgrading page if the package has one. Ask the user before upgrading. - Check the requirements. Read the installation page, and the compatibility page if there is one.
Compare each requirement with the app's
package.jsonand app config before you install anything. If the app falls short, tell the user and ask before upgrading anything. - Install the package and wire it up. Follow the installation page, then the quick start or the page it sends you to next, in the app's own files. Keep what is already in them. Ask the user for anything only they can decide or hold, such as keys, a bucket, or a choice the page leaves open. Never invent a key, and never put a secret in the app's bundle or in git.
- Native build. When the pages say the package has native code or a config plugin, the app needs a new native build, and reloading the JS won't pick the change up. Tell the user.
- Verify. Run every check the pages give. Then run the project's typecheck and build the bundle:
in an Expo app,
<runner> expo export --platform ios --output-dir <scratch folder>, deleting the folder after, and on the web, the app's own build. Ask the user to run whatever needs a device, a simulator or their eyes.
For several packages in one app, read Several packages in one app first. Then set each package up in turn, and verify it before you start the next.
While you work
- When the app misbehaves and it has
@axonpack/expo-devtools, read what the app recorded before you guess. Use with AI agents has the commands. - Ask the user before you run anything that changes the app's data or sends a request that could change data on a server.
- Remove whatever you added only to test, such as a fake release or a test preview, the way its page describes.
Answering questions
Find the page in llms.txt that covers the question, read its markdown copy, and answer from it
with a link to the page. If no title fits, search llms-full.txt. When the docs don't cover
something, say so instead of guessing.