Hammerkit

hammerkit files

Type object
File match .hammerkit.yaml .hammerkit.yml *.hammerkit.yaml *.hammerkit.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/hammerkit/latest.json
Source https://www.schemastore.org/hammerkit.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Build tool with support for containerization https://no0dles.gitbook.io/hammerkit/build-file

Properties

envs Record<string, string>

Environment values for the current build task https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

tasks Record<string, containerTask | localTask>

Task for the current build file https://no0dles.gitbook.io/hammerkit/task

services Record<string, containerService | kubernetesService>

Services for the current build file https://no0dles.gitbook.io/hammerkit/service

includes Record<string, path>

Includes to other build files https://no0dles.gitbook.io/hammerkit/build-file/includes

references Record<string, path>

References to other build files https://no0dles.gitbook.io/hammerkit/build-file/references

Definitions

buildFileEnvs Record<string, string>

Environment values for the current build task https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

buildFileTasks Record<string, containerTask | localTask>

Task for the current build file https://no0dles.gitbook.io/hammerkit/task

buildFileServices Record<string, containerService | kubernetesService>

Services for the current build file https://no0dles.gitbook.io/hammerkit/service

buildFileIncludes Record<string, path>

Includes to other build files https://no0dles.gitbook.io/hammerkit/build-file/includes

buildFileReferences Record<string, path>

References to other build files https://no0dles.gitbook.io/hammerkit/build-file/references

task containerTask | localTask

Task for the current build file https://no0dles.gitbook.io/hammerkit/task

localTask object

Task that gets executed in the local shell in the current directory

cmds taskCommand[] required

Commands for the current task

description string | object
labels Record<string, string>

A map of label values for the current task https://no0dles.gitbook.io/hammerkit/labels

extend string

Extension task as a base template https://no0dles.gitbook.io/hammerkit/task/extending

cache string

compare type for detecting changes in source files https://no0dles.gitbook.io/hammerkit/task/caching

Values: "checksum" "modify-date" "none"
continuous boolean

The task runs continuous and does not end without cancellation https://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks

envs Record<string, string>

Environment values for the current build file https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

needs string[]

Service needs that need to get ready before the current task https://no0dles.gitbook.io/hammerkit/task/needs

uniqueItems=true
deps string[]

Task dependencies that get executed before the current task https://no0dles.gitbook.io/hammerkit/task/dependencies

uniqueItems=true
src path[]

Source files and folders for the current task https://no0dles.gitbook.io/hammerkit/task#source

uniqueItems=true
generates path[]

Generated files and folders for the current task

https://no0dles.gitbook.io/hammerkit/task#generate

uniqueItems=true
containerTask object

Container task for the current build file https://no0dles.gitbook.io/hammerkit/task/container

cmds taskCommand[] required

Commands for the current task

image string required

Container image for the current task to run commands in

description string | object
extend string

Extension task as a base template https://no0dles.gitbook.io/hammerkit/task/extending

labels Record<string, string>

A map of label values for the current task https://no0dles.gitbook.io/hammerkit/labels

cache string

compare type for detecting changes in source files https://no0dles.gitbook.io/hammerkit/task/caching

Values: "checksum" "modify-date" "none"
continuous boolean

The task runs continuous and does not end without cancellation https://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks

envs Record<string, string>

Environment values for the current build file https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

needs string[]

Service needs that need to get ready before the current task https://no0dles.gitbook.io/hammerkit/task/needs

uniqueItems=true
deps string[]

Task dependencies that get executed before the current task https://no0dles.gitbook.io/hammerkit/task/dependencies

uniqueItems=true
src path[]

Source files and folders for the current task https://no0dles.gitbook.io/hammerkit/task#source

uniqueItems=true
generates path[]

Generated files and folders for the current task

https://no0dles.gitbook.io/hammerkit/task#generate

uniqueItems=true
shell string

Define which shell is used to execute the commands

ports string[]

A list of ports that get exposed on the host from the container :

uniqueItems=true
mounts string[]

File paths that get mounted into the container https://no0dles.gitbook.io/hammerkit/task/container#adding-mounts

uniqueItems=true
taskCommand string | object
taskDescription string

Description for the current task

taskExtend string

Extension task as a base template https://no0dles.gitbook.io/hammerkit/task/extending

taskCache string

compare type for detecting changes in source files https://no0dles.gitbook.io/hammerkit/task/caching

taskContinuous boolean

The task runs continuous and does not end without cancellation https://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks

taskLabels Record<string, string>

A map of label values for the current task https://no0dles.gitbook.io/hammerkit/labels

taskEnvs Record<string, string>

Environment values for the current build file https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

taskNeeds string[]

Service needs that need to get ready before the current task https://no0dles.gitbook.io/hammerkit/task/needs

taskDeps string[]

Task dependencies that get executed before the current task https://no0dles.gitbook.io/hammerkit/task/dependencies

taskSrc path[]

Source files and folders for the current task https://no0dles.gitbook.io/hammerkit/task#source

taskGenerates path[]

Generated files and folders for the current task

https://no0dles.gitbook.io/hammerkit/task#generate

service containerService | kubernetesService

A daemon in the background

kubernetesService object

Kubernetes service for the current build file https://no0dles.gitbook.io/hammerkit/service/kubernetes

context string required

Kubernetes context for the current service https://no0dles.gitbook.io/hammerkit/service/kubernetes#config

ports string[] required

A list of ports that get exposed on the host from the service :

uniqueItems=true
selector object required

Selector to specify which resource gets forwarded to https://no0dles.gitbook.io/hammerkit/service/kubernetes

2 nested properties
type string required

resource type for the current service

Values: "deployment" "service" "pod"
name string required

resource name for the kubernetes resource

kubeconfig string

Kube config for the current service https://no0dles.gitbook.io/hammerkit/service/kubernetes#config

containerService object

Container service for the current build file https://no0dles.gitbook.io/hammerkit/service/kubernetes

image string required

Container image for the current service to run commands in

labels Record<string, string>

A map of label values for the current service https://no0dles.gitbook.io/hammerkit/labels

envs Record<string, string>

Environment values for the current service https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

healthcheck object

Check to detect if the service is started and ready https://no0dles.gitbook.io/hammerkit/service/container#healthcheck

1 nested properties
cmd string required

task to check if the service is healthy

ports string[]

A list of ports that get exposed on the host from the container : https://no0dles.gitbook.io/hammerkit/service/container#mounts

uniqueItems=true
volumes string[]

A list of volumes that get attached to the container : https://no0dles.gitbook.io/hammerkit/service/container#mounts

uniqueItems=true
mounts string[]

File paths that get mounted into the container : https://no0dles.gitbook.io/hammerkit/service/container#mounts

uniqueItems=true