Expand description
Constants
Constants§
- The “bare” key in a tree block defines a bare repository.
- The “branch” key in a tree block defines the branch to checkout on clone.
- The “branches” section in a tree block maps local to remote branches.
- The “commands” section in a configuration block defines custom commands.
- The “config” key in a graft definition defines the path to a garden config file.
- The “cmd” debug level for “garden cmd”.
- The “config” debug level for configuration reading.
- The “exec” debug level for “garden exec”.
- The “list” debug level for “garden ls”.
- The “default-remote” key in a tree block defines the default remote.
- The “depth” key in a tree block defines the git clone depth.
- The “description” key in a tree block describes the tree.
- The “environment” section of a garden, template or tree block defines environment variables that are set in command environments.
- The “extend” key in a tree or template block is used to extends an existing tree or template block.
- The “garden” section of the configuration defines global settings.
- The “gardens” section of the configuration defines named “gardens” that are used to aggregate trees, define expression variables and export environment variables for commands.
- The default “garden.yaml” configuration file.
- Builtin variable for the “garden.yaml” configuration directory.
- Variable expression for the “garden.yaml” configuration directory.
- Builtin variable for the “garden.root” location where trees are grown.
- The “gitconfig” section in a tree block defines local “.git/config” settings that are applied when a tree is grown.
- The “grafts” section of the “garden” block is used to graft entities from other garden files into the configuration under a custom namespace.
- The “groups” section of the configuration defines named groups of trees.
- The “includes” key in the garden block reads additional configuration files directly into the configuration.
- The “links” key in a tree block defines URLs displayed by “garden ls”.
- The “path” key in a tree block defines the location for a tree. A directory relative to “garden.root” named after the tree is used as the tree’s path by default.
- The “remotes” key in a tree block defines the Git remotes to configure when a tree is grown.
- The “replace” key in a tree block is used to completely replace a tree when the tree was already loaded via an “includes” entry. The default behavior is to merge and override settings when the same-named tree entries is encountered.
- The “root” key in the garden block defines where trees are located and grown.
- The “shell” key in the garden block defines the shell to use for commands.
- The “shell-errexit” key in the garden block disables the “exit on error” shell option.
- The “single-branch” key in a tree block is used to make “garden grow” track only a single branch. Tracking branches for all remote branches are cloned and fetched by default.
- The “symlink” key in a tree block creates a symlink.
- The “templates” section defines tree templates that can be used when defining tree entries.
- The “trees” section of the configuration defines trees that can be cloned into existence using “garden grow” and operated upon with custom commands.
- The “tree-branches” key in the garden block can disable the current branch indicator when trees are displayed.
- Builtin variable for tree names.
- Builtin variable for tree paths.
- The “url” key in a tree block defines the “git clone” URL to clone.
- The “variables” section in a configuration block defines expression variables that can be references using “${variable}” expressions in “environment”, “commands” and “variables” blocks. Variables can use “$ exec” expressions to capture stdout from a command.
- The “worktree” key in a tree block is used to refer to a parent tree that will be used to grow the tree using “git worktree add”.