doxx How to Use the build Command

Syntax

$ doxx build <key file path>

Description

The build command compiles projects according to specifications in the template and key files.

The build command is executed on a local key file. This key file includes paths to the template or project archive files that are used to complete the project build, as well as any text replacement strings that you would like to perform at corresponding, available replacement sites in the project templates. Review the key documentation for more details.

By default, the local project key file is called key.yaml. doxx automatically builds from this file in the current working directory without an explicit argument. To build with a key that has a different file name/file path, include the key as an argument to the doxx build command.

Usage

Confirm that your key file includes the required template or project archive build specification definitions in the header section. Then enter any desired text replacement strings in the body of your key file. This information is entered using YAML syntax.

Place your key.yaml file in a clean project directory where you would like to perform the build, make the new project directory your current working directory, and then execute the command:

Default Build with key.yaml

$ doxx build

If you use a different key file name or you are running the command from a directory outside of the one that contains your key file, use the key file path as an argument to the build command:

Build with Alternate Key File Path

$ doxx build <key file path>

Beware

File builds resolve to paths that are relative to the root directory where the key file is executed, not relative to the directory that contains the template file(s).

By default, the file write from a template takes place in the current working directory. A sub-directory path for a template file write is specified with an optional template destination_directory meta data field. If a file already exists on the template write path, it will be replaced with the new file.

Project developers have the option to include verbatim file writes (i.e. no text replacements) and binary files (e.g. images) in new project builds that occur with this command.

More Information

For more information on template file specifications, please see the template documentation. The project archive documentation includes details on how tar.gz and zip archives can be used to include complex directory structures, verbatim text file writes, and binary files in project builds.


just blimpin doxx documentation is licensed under the CC-4.0-Attribution LicenseImprove this page