Documentation menu

commands

Synthesizing a project

This command is used to validate the structure and logic of your resources. There are multiple layers of validation that is done by the framework to reduce potential deployment errors.

The JSON schema provides the user with a simple LSP implementation for catching type errors. We provide regex matches for multiple fields as well as static analysis for edge cases and name bindings (a resource that references another).

Run this command to see the full api: hulk synth --help

hulk-synth
Synthesize the project

USAGE:
    hulk synth [OPTIONS] --env <ENV> <SRC_FILE>

ARGS:
    <SRC_FILE>    The path to the file to read the schema from

OPTIONS:
    -e, --env <ENV>    The target environment to synthesize for
    -h, --help         Print help information
    -q, --quiet        Suppress all warnings from the output

Arguments

Key Value Description
SRC_FILE (required) filesystem path The path to your main.json to validate

Options

Name Value Description
-e, --env (required) string The target environment to synthesize for
-h, --help bool Print help information
-q, --quiet bool Supress all warnings from the output