kindgi build
kindgi build
Section titled “kindgi build”Synopsis
kindgi build [--local [--push [<repository>]] [--platform <os/arch>]] [--hosted [--project <id>]] [--target <t>] [--endpoint <url>] [--env <name>] [--out <dir>] [--artifact-version <v>] [--published-at <iso>] [--tenant <id>] [--signing-key <path>] [--registry-push-creds <ref>] [--skip-integrity-gate] [--skip-image-pull] [--skip-sign] [--path <dir>]Signature
Bundle + build + sign a pack image. Emits deploy-envelope.json for kindgi deploy. --local builds the image with this machine's Docker instead: no build service, no signing; with --push, it pushes the image, signs it, and writes the envelope.
Options
| Option | Default | Description |
|---|---|---|
--artifact-version <value> |
the build time, as YYYYMMDD.HHMMSS (UTC) |
The artifact version, in the image and its signature. Default: the build time as YYYYMMDD.HHMMSS (UTC). For a reproducible build, pass --artifact-version and --published-at. |
--endpoint <value> |
the env block's build; required when there is none (not used with --local or --hosted, which builds at the CLI's API URL under /cloud) |
The build server. Default: the env block's build. Not used with --local or --hosted. |
--env <value> |
staging |
The environment block in kindgi.config.ts to build for. Default: staging. |
--hosted |
off | Build on Kindgi hosted's build service, at the API's address under /cloud, with your API key; the image goes to your workspace's own repository. Same as the env block's build: 'hosted'. |
--local |
off | Build with this machine's Docker instead of a build server: no signing and no envelope unless --push. |
--out <value> |
.kindgi/build under the pack root |
Where the build output and deploy-envelope.json go. Default: .kindgi/build under the pack root. |
--path <value> |
the current directory (the pack root is resolved from it) | The pack root. Default: the current directory. |
--platform <value> |
with --local: linux/amd64 when pushing, else this machine's |
With --local: the image's platform. Default: linux/amd64 when pushing, else this machine's. |
--project <value> |
none: the build carries no project label (with --hosted only) |
With --hosted: the project the build is for, by id, kept as a label on the build. |
--published-at <value> |
the build time | The publish time (an ISO 8601 time with a zone, or a date: its start, UTC), in the image and its signature. Default: the build time. For a reproducible build, pass --artifact-version and --published-at. |
--push <value> |
none; a bare --push uses the env block's registry + /<packId> |
With --local: push the image, sign it and write the envelope. Default repository: the env block's registry + /<packId>. |
--registry-push-creds <value> |
none | A reference to the registry push credentials for the build server to use, passed through as is. |
--signer-key-id <value> |
the env block's signerKeyId, else the key file's name |
The key id the signature names. Default: the env block's signerKeyId, else the key file's name. |
--signing-key <value> |
the env block's signingKey; required to sign (unless --skip-sign) |
The Ed25519 private key (PEM) to sign with. Default: the env block's signingKey. |
--skip-image-pull |
off | Check the image's index by hash only, without pulling the image. Build-server builds only. |
--skip-integrity-gate |
off | Sign without checking the image's index against the local one. Prints a warning. Build-server builds only. |
--skip-sign |
off | Write an unsigned envelope (for CI that signs elsewhere); kindgi deploy refuses it. |
--target <value> |
the env block's buildTarget, else the env name |
The build target, set in the image build and sent to the build server. Default: the env block's buildTarget, else the env name. |
--tenant <value> |
the env block's tenantId, else KINDGI_TENANT_ID, else with --hosted the API key's own tenant; required unless --local without --push |
The tenant the signature names. Default: the env block's tenantId, else KINDGI_TENANT_ID, else with --hosted your key's own tenant. |
Every command also takes the global flags.
Examples
From Deploy on Azure Container Apps:
pnpm exec kindgi build --local --push --env devFrom Deploy on Google Cloud Run:
pnpm exec kindgi build --local --push --env prodSee also