hof

README

hof - the high code framework

hof is a tool that weaves together data models, code generation, and task engine with CUE. Enhance your workflow and automate repetitive development. Language and technology agnostic.

1. data model - define & manage data models - the source of truth
2. code generation - data + template = _ (anything) - technology agnostic
3. app blueprints - bootstrap config and other files - consistent skaffolding
4. task engine - composable, extendable tasks and workflows - a DAG engine
5. modules - composable data models & generators - an ecosystem

hof is a CLI tool you will add to your workflows. It is technology agnostic, captures common patterns and boilerplate, has modules that span technologies, and continues to work as your application evolves.

• data model management so you can checkpoint, diff, and calculate migrations
• code generation to scaffold consistent code and boilerplate across the stack
• diff3 to support custom code, data model updates, and code regeneration
• modular and composable code generators with dependency management

hof uses CUE extensively to power the DX and implementation.

Learn more about CUE: cuelang.org | cuetorials.com

Documentation

Please see docs.hofstadter.io to learn more.

The getting-started section will take you on a tour of hof. The first-example section shows you how to build and use a generator.

Join us on Slack! https://hofstadter-io.slack.com We are more than happy to answer your questions.

Install or try hof on github

Download hof just once. After that hof will prompt you to update and install new releases as they become available.

You can always find the latest version on our GitHub releases page or use hof to install a specific version of itself with hof update --version vX.Y.Z.

# Homebrew
brew install hofstadter-io/tap/hof

# Latest Release
go install github.com/hofstadter-io/hof/cmd/hof@latest

# Latest Commit
go install github.com/hofstadter-io/hof/cmd/hof@_dev

# Shell Completions (bash, zsh, fish, power-shell)
echo ". <(hof completion bash)" >> $HOME/.profile
source $HOME/.profile

# Show the help text
hof --help

Contributing & Community

Interested in helping out or hanging out? The best ways to get started are

1. The Contributing Guild
2. Joining the Community

Main Commands

hof

hof - the high code framework

  Learn more at https://docs.hofstadter.io

Usage:
  hof [flags] [command] [args]

Main commands:
  create                dynamic blueprints from any git repo
  datamodel             manage, diff, and migrate your data models
  gen                   modular and composable code gen: CUE & data + templates = _
  flow                  run CUE pipelines with the hof/flow DAG engine
  fmt                   format any code and manage the formatters
  mod                   CUE dependency management based on Go mods

Additional commands:
  help                  help about any command
  update                check for new versions and run self-updates
  version               print detailed version information
  completion            generate completion helpers for your terminal
  feedback              open an issue or discussion on GitHub

Flags:
  -h, --help             help for hof
      --inject-env       inject all ENV VARs as default tag vars
  -p, --package string   the Cue package context to use during execution
  -q, --quiet            turn off output and assume defaults at prompts
  -t, --tags strings     @tags() to be injected into CUE code
  -v, --verbosity int    set the verbosity of output

Use "hof [command] --help / -h" for more information about a command.