hof - the higher order framework
Hof is a tool that weaves together data models, code generation, and task engine with CUE.
Automate repetitive setup, code, changes, and workflows using your tools. Hof is technology agnostic.
| Core Features | |
|---|---|
| code generation | data + template = _ (anything) ...any file, technology agnostic |
| app blueprints | consistently bootstrap apps, code, config, and other files |
| data model | define and manage data models, evolve code with them |
| task engine | extensible task and workflow DAG engine |
| modules | composable dependencies for blueprints, models, and generators |
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
Main Commands
hof
hof - the higher order framework
Learn more at https://docs.hofstadter.io
Usage:
hof [flags] [command] [args]
Main commands:
chat co-create with AI (alpha)
create starter kits or blueprints from any git repo
datamodel manage, diff, and migrate your data models
def print consolidated CUE definitions
eval evaluate and print CUE configuration
export output data in a standard format
flow run workflows and tasks powered by CUE
fmt format any code and manage the formatters
gen CUE powered code generation
mod CUE module dependency management
vet validate data with CUE
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:
-E, --all-errors print all available errors
-h, --help help for hof
-i, --ignore-errors turn off output and assume defaults at prompts
-D, --include-data auto include all data files found with cue files
-V, --inject-env inject all ENV VARs as default tag vars
-p, --package string the Cue package context to use during execution
-l, --path stringArray CUE expression for single path component when placing data files
-q, --quiet turn off output and assume defaults at prompts
-d, --schema stringArray expression to select schema to apply to data files
--stats print generator statistics
-t, --tags stringArray @tags() to be injected into CUE code
-v, --verbosity int set the verbosity of output
--with-context add extra context for data files, usable in the -l/path flag
Use "hof [command] --help / -h" for more information about a command.