@foundrykit/cli

The FoundryKit CLI initializes projects and installs components from the FoundryKit registry.

Commands

init

Creates foundrykit.config.json, installs the utility helper, prepares target directories, and updates package scripts for a Next.js project.

foundrykit init

list

Lists available registry components.

foundrykit list
foundrykit list -c primitives
foundrykit list -s button

add

Fetches a component from the registry, installs its files, installs any missing package dependencies, and prints a usage hint.

foundrykit add hero-minimal
foundrykit add button -o

update

Reinstalls a component with overwrite semantics using the same registry-backed installation flow as add.

foundrykit update hero-minimal

doctor

Validates that:

• package.json exists
• Next.js is detected
• foundrykit.config.json exists and has the expected shape
• the configured registry URL is reachable

foundrykit doctor

Registry Contract

The CLI uses the registry configured in foundrykit.config.json.

Canonical endpoints:

• GET {registry}/registry
• GET {registry}/registry/{id}

Legacy /api/components endpoints may still exist on the host for compatibility, but the CLI should be considered a /registry consumer.

Notes

• The CLI currently targets Next.js projects.
• test runs in non-watch mode by default for CI friendliness.
• Installation paths are controlled by foundrykit.config.json.