Skip to content

kindgi init

View as Markdown

Synopsis

Terminal window
kindgi init [<pack-name>] [--template=minimal|sample|woocommerce|drupal|python|java|scala] [--path=<dir>] [--force] [--link-local] [--new-repo]
Signature

Scaffold a new Kindgi pack repo, or add Kindgi to an existing app: a Node.js, Python, Maven or sbt project, auto-detected from its package.json, pyproject.toml, pom.xml or build.sbt when no pack-name is given.

Options

Option Default Description
--force off Write into a non-empty directory; in an existing app, overwrite the Kindgi config and files already there instead of refusing or skipping them.
--link-local off Node packs: link @kindgi/* from the Kindgi checkout the CLI runs from, even inside its workspace. No effect for an installed CLI.
--new-repo off In an existing app, scaffold a separate pack instead of adding Kindgi to the app. Requires <pack-name>.
--pack-id <value> derived from the existing app's name Adding Kindgi to an existing app: the pack id, instead of the one derived from the app's name. Needed when that name makes no valid id.
--path <value> <pack-name> (its last dot segment) under the current directory; in an existing app, the current directory Where to scaffold. Default: <pack-name> (its last dot segment) under the current directory; in an existing app, the current directory.
--template <value> minimal The starter: minimal (default; empty primitive folders), sample (tools, a guardrail, an agent and a flow), woocommerce (agents for a WooCommerce store, with approvals), drupal (agents for a Drupal site through its MCP Server, with approvals), python (a Python pack), java (a Java pack, built with Maven; preview) or scala (a Scala pack, built with sbt; preview).

Every command also takes the global flags.

Examples

From Self-host Kindgi:

Terminal window
npx --yes @kindgi/cli@0.1 init acme-pack --template=sample

From Organize work by org and project:

Terminal window
npx --yes @kindgi/cli@0.1 init acme-shop --template=woocommerce

See also