CLI, API, and agent documentation

Honest UI Developer Resources

Use this index to choose the Honest UI integration surface that matches your task: copy component source with the CLI, import maintained collections from npm, or inspect public registry data through the versioned read-only API.

Use the Honest UI CLI for copied source

Run npx honestui@latest init to configure a supported React project, then run npx honestui@latest add button to inspect and copy a component. Use --dry-run before writing files when you need to review the planned dependencies and targets. The Honest UI installation guide documents prerequisites, prompts, overwrite behavior, verification, and the collections that use package imports instead.

The official honestui package on npm publishes the honestui executable. The same package provides documented imports for charts, icons, logos, vectors, and shaders.

Use REST API v1 for registry discovery

The Honest UI REST API v1 index links to the public registry catalog, registry item index, individual items, base colors, and initialization presets. The API is read-only and accepts requests without an account, key, token, cookie, or other credential. New HTTP integrations should use the versioned /api/v1 paths rather than the compatibility URLs used by existing CLI consumers.

Read the Honest UI OpenAPI 3.1 specification for operation IDs, parameters, response schemas, problem details, and lifecycle headers. The complete API guide explains stable error codes, versioning, compatibility, and the deprecation policy.

Use agent-readable documentation for automated work

Start with llms.txt when an agent needs to find the relevant Markdown guide. Use the Honest UI agent skill when the task involves installing, adding, customizing, or debugging Honest UI in a React project. Use the OpenAPI document when code needs to call a registry endpoint or generate a typed client. The full Markdown snapshot is available when a tool benefits from one consolidated documentation file.

Connect an MCP client to https://www.honestui.com/mcp over Streamable HTTP when the agent needs to discover exact registry item names and retrieve component source through typed, read-only tools. No credential is required. Call list_registry_items first when the item name is unknown, then pass an exact returned name to get_registry_item.

Report a developer-resource problem

If a command, schema, example, or endpoint contradicts deployed behavior, use the Honest UI contact guide to file a reproducible issue. Do not put credentials, private source, personal data, or suspected vulnerability details in a public report.