Machine-readable resources
The addresses and formats an agent can read AllyHub from without a browser: llms.txt, every page as Markdown, the CLI's JSON help, the data tools' catalog and the registry.
llms.txt
Section titled “llms.txt”https://allyhub.com/llms.txt is the index of the site for agents (llmstxt.org): a summary, how an agent should use AllyHub, then every docs page by section, each linked to its Markdown with its one-line description.
Every page as Markdown
Section titled “Every page as Markdown”Every page of the site has a Markdown twin at its address plus .md: https://allyhub.com/docs/start/your-agent.md for https://allyhub.com/docs/start/your-agent. A request for the page itself with Accept: text/markdown gets the twin too.
curl -H "Accept: text/markdown" https://allyhub.com/docs/start/your-agentA twin starts with the page’s title, its description, its address, the date of its last change (or the AllyHub version a reference page describes) and a link to /llms.txt; its links are absolute and point to other twins. Twins are not indexed by search engines (X-Robots-Tag: noindex); the HTML page is the one to cite.
The CLI’s help, as JSON
Section titled “The CLI’s help, as JSON”npx -y allyhub@latest help --jsonprints the version, the works with their commands in the order they are used, and every command’s spec: its summary, its positional arguments, its input and output as JSON Schemas, and its examples. allyhub help <command> --json prints one command’s spec. Inside a project, npx allyhub help --json describes the version the project installed and gives the path of its SDK’s docs.
The data tools’ catalog
Section titled “The data tools’ catalog”GET https://app.allyhub.com/api/catalog returns AllyHub’s cloud tools, open to anyone: each tool’s name, its work, its title, its description (which ends with how its credits are counted), its input and output as JSON Schemas, and whether it is a long tool that is read again until it is done. The CLI makes its data tool commands from it: allyhub help <work> lists a work’s tools and allyhub <work> <tool> --help describes one.
The registry
Section titled “The registry”GET https://allyhub.com/r/registry.json lists what allyhub add can add to a project: starter components, 3D models and sceneries, work skills and templates, each with its name, type, title and description.
The skill
Section titled “The skill”The allyhub skill is in the public repository allyhub-ai/allyhub, as an Agent Skill: skills/allyhub/SKILL.md and its references.