03 - CLI Reference

CLI Reference #

dryad #

$ dryad --help
dryad [--help]

Description:
    dryad package manager 0.14.4,-X=main.Fingerprint=dyd-v1-e9da59671dc9a12572695af457f0690f,-s,-w

Options:
    --help          display help text for this command

Sub-commands:
    dryad garden    commands to work with a dryad garden
    dryad root      commands to work with a dryad root
    dryad roots     commands to work with dryad roots
    dryad run       alias for `dryad script run`
    dryad scope     commands to work with a single scope
    dryad scopes    commands to work with scopes
    dryad script    commands to work with a scoped script
    dryad scripts   commands to work with scoped scripts
    dryad sprout    commands to work with a single dryad sprout
    dryad sprouts   commands to work with dryad sprouts
    dryad stem      commands to work with a single dryad stem
    dryad stems     commands to work with dryad stems
    dryad system    maintenance and utility commands for dryad
    dryad version   print out detailed version info

dryad garden #

$ dryad garden --help
dryad garden [--help]

Description:
    commands to work with a dryad garden

Options:
    --help                display help text for this command

Sub-commands:
    dryad garden build    build selected roots in a garden. alias for `dryad roots build`
    dryad garden create   create a garden
    dryad garden pack     pack the current garden into an archive 
    dryad garden path     return the base path for a garden
    dryad garden prune    clear all build artifacts out of the garden not actively linked to a sprout or a root
    dryad garden wipe     clear all build artifacts out of the garden

dryad garden build #

$ dryad garden build --help
dryad garden build [--help] [--path=string] [--include=multi-string] [--exclude=multi-string] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    build selected roots in a garden. alias for `dryad roots build`

Options:
    --help         display help text for this command
    --path         the target path for the garden to build
    --include      choose which roots are included in the build
    --exclude      choose which roots are excluded from the build
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad garden create #

$ dryad garden create --help
dryad garden create [--help] [--log-level=string] [--log-format=string] [path]

Description:
    create a garden

Arguments:
    path           the target path at which to create the garden, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad garden pack #

$ dryad garden pack --help
dryad garden pack [--help] [--log-level=string] [--log-format=string] [gardenPath] [targetPath]

Description:
    pack the current garden into an archive 

Arguments:
    gardenPath     the path to the garden to pack, optional
    targetPath     the path (including name) to output the archive to, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad garden path #

$ dryad garden path --help
dryad garden path [--help] [--log-level=string] [--log-format=string] [path]

Description:
    return the base path for a garden

Arguments:
    path           the target path at which to start for the base garden path, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad garden prune #

$ dryad garden prune --help
dryad garden prune [--help] [--log-level=string] [--log-format=string]

Description:
    clear all build artifacts out of the garden not actively linked to a sprout or a root

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad garden wipe #

$ dryad garden wipe --help
dryad garden wipe [--help] [--log-level=string] [--log-format=string]

Description:
    clear all build artifacts out of the garden

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root #

$ dryad root --help
dryad root [--help]

Description:
    commands to work with a dryad root

Options:
    --help                    display help text for this command

Sub-commands:
    dryad root ancestors      list all roots the selected root depends on (directly and indirectly)
    dryad root build          build a specified root
    dryad root copy           make a copy of the specified root at a new location
    dryad root create         create a new root at the target path
    dryad root descendants    list all roots that depend on the selected root (directly and indirectly)
    dryad root develop        create a temporary development environment for a root
    dryad root move           move a root to a new location and correct all references
    dryad root path           return the base path of the current root
    dryad root replace        replace all references to one root with references to another
    dryad root requirements   commands to work with the requirements of a root
    dryad root secrets        commands to work with dryad secrets

dryad root ancestors #

$ dryad root ancestors --help
dryad root ancestors [--help] [--relative=boolean] [--log-level=string] [--log-format=string] [root_path]

Description:
    list all roots the selected root depends on (directly and indirectly)

Arguments:
    root_path      path to the root, optional

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root build #

$ dryad root build --help
dryad root build [--help] [--log-level=string] [--log-format=string] [path]

Description:
    build a specified root

Arguments:
    path           path to the root to build, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root copy #

$ dryad root copy --help
dryad root copy [--help] [--log-level=string] [--log-format=string] <source> <destination>

Description:
    make a copy of the specified root at a new location

Arguments:
    source         path to the source root
    destination    destination path for the root copy

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root create #

$ dryad root create --help
dryad root create [--help] [--log-level=string] [--log-format=string] <path>

Description:
    create a new root at the target path

Arguments:
    path           the path to create the new root at

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root descendants #

$ dryad root descendants --help
dryad root descendants [--help] [--relative=boolean] [--log-level=string] [--log-format=string] [root_path]

Description:
    list all roots that depend on the selected root (directly and indirectly)

Arguments:
    root_path      path to the root, optional

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root develop #

$ dryad root develop --help
dryad root develop [--help] [--editor=string] [--arg=multi-string] [--inherit=boolean] [--scope=string] [--log-level=string] [--log-format=string] [path]

Description:
    create a temporary development environment for a root

Arguments:
    path           path to the root to develop, optional

Options:
    --help         display help text for this command
    --editor       choose the editor to run in the root development environment
    --arg          argument to pass to the editor
    --inherit      inherit env variables from the host environment
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root move #

$ dryad root move --help
dryad root move [--help] [--log-level=string] [--log-format=string] <source> <destination>

Description:
    move a root to a new location and correct all references

Arguments:
    source         path to the source root
    destination    destination path for the root

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root path #

$ dryad root path --help
dryad root path [--help] [--log-level=string] [--log-format=string] [path]

Description:
    return the base path of the current root

Arguments:
    path           the path to start searching for a root at. defaults to current directory, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root replace #

$ dryad root replace --help
dryad root replace [--help] [--log-level=string] [--log-format=string] <source> <replacement>

Description:
    replace all references to one root with references to another

Arguments:
    source         path to the source root
    replacement    path to the replacement root

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root requirements #

$ dryad root requirements --help
dryad root requirements [--help]

Description:
    commands to work with the requirements of a root

Options:
    --help                           display help text for this command

Sub-commands:
    dryad root requirements add      add a root as a dependency of the current root
    dryad root requirements list     list all requirements of this root
    dryad root requirements remove   remove a requirement from the current root

dryad root requirements add #

$ dryad root requirements add --help
dryad root requirements add [--help] [--log-level=string] [--log-format=string] <path> [alias]

Description:
    add a root as a dependency of the current root

Arguments:
    path           path to the root you want to add as a dependency
    alias          the alias to add the root under. if not specified, this defaults to the basename of the linked root, optional

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root requirements list #

$ dryad root requirements list --help
dryad root requirements list [--help] [--relative=boolean] [--log-level=string] [--log-format=string] [root_path]

Description:
    list all requirements of this root

Arguments:
    root_path      path to the root, optional

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root requirements remove #

$ dryad root requirements remove --help
dryad root requirements remove [--help] [--log-level=string] [--log-format=string] <path>

Description:
    remove a requirement from the current root

Arguments:
    path           path to the dependency to remove

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root secrets #

$ dryad root secrets --help
dryad root secrets [--help]

Description:
    commands to work with dryad secrets

Options:
    --help                           display help text for this command

Sub-commands:
    dryad root secrets fingerprint   calculate the fingerprint for the secrets in a stem/root
    dryad root secrets list          list the secret files in a stem/root
    dryad root secrets path          print the path to the secrets for the current package, if it exists

dryad root secrets fingerprint #

$ dryad root secrets fingerprint --help
dryad root secrets fingerprint [--help] [--log-level=string] [--log-format=string] <path>

Description:
    calculate the fingerprint for the secrets in a stem/root

Arguments:
    path           path to the stem base dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root secrets list #

$ dryad root secrets list --help
dryad root secrets list [--help] [--log-level=string] [--log-format=string] <path>

Description:
    list the secret files in a stem/root

Arguments:
    path           path to the stem base dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad root secrets path #

$ dryad root secrets path --help
dryad root secrets path [--help] [--log-level=string] [--log-format=string] <path>

Description:
    print the path to the secrets for the current package, if it exists

Arguments:
    path           path to the stem base dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots #

$ dryad roots --help
dryad roots [--help]

Description:
    commands to work with dryad roots

Options:
    --help                 display help text for this command

Sub-commands:
    dryad roots affected   take a list of files from stdin, and print a list of roots that may depend on those files
    dryad roots build      build selected roots in a garden
    dryad roots graph      print the local dependency graph of all roots in the garden
    dryad roots list       list all roots that are dependencies for the current root (or roots of the current garden, if the path is not a root)
    dryad roots owning     list all roots that are owners of the provided files. The files to check should be provided as relative or absolute paths through stdin.
    dryad roots path       return the path of the roots dir

dryad roots affected #

$ dryad roots affected --help
dryad roots affected [--help] [--relative=boolean] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    take a list of files from stdin, and print a list of roots that may depend on those files

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots build #

$ dryad roots build --help
dryad roots build [--help] [--path=string] [--include=multi-string] [--exclude=multi-string] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    build selected roots in a garden

Options:
    --help         display help text for this command
    --path         the target path for the garden to build
    --include      choose which roots are included in the build
    --exclude      choose which roots are excluded from the build
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots graph #

$ dryad roots graph --help
dryad roots graph [--help] [--transpose=boolean] [--relative=boolean] [--format=string] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    print the local dependency graph of all roots in the garden

Options:
    --help         display help text for this command
    --transpose    transpose the dependency graph before printing
    --relative     print roots relative to the base garden path. default true
    --format       change the output format of the graph. can be one of (yaml, json, json-compact). defaults to yaml
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots list #

$ dryad roots list --help
dryad roots list [--help] [--relative=boolean] [--include=multi-string] [--exclude=multi-string] [--scope=string] [--log-level=string] [--log-format=string] [path]

Description:
    list all roots that are dependencies for the current root (or roots of the current garden, if the path is not a root)

Arguments:
    path           path to the base root (or garden) to list roots in, optional

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --include      choose which roots are included in the list
    --exclude      choose which roots are excluded from the list
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots owning #

$ dryad roots owning --help
dryad roots owning [--help] [--relative=boolean] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    list all roots that are owners of the provided files. The files to check should be provided as relative or absolute paths through stdin.

Options:
    --help         display help text for this command
    --relative     print roots relative to the base garden path. default true
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad roots path #

$ dryad roots path --help
dryad roots path [--help] [--log-level=string] [--log-format=string]

Description:
    return the path of the roots dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad run #

$ dryad run --help
dryad run [--help] [--scope=string] [--inherit=boolean] [--log-level=string] [--log-format=string] <command> [-- args]

Description:
    alias for `dryad script run`

Arguments:
    command        alias command
    -- args        args to pass to the command, optional

Options:
    --help         display help text for this command
    --scope        set the scope for the command
    --inherit      pass all environment variables from the parent environment to the alias to exec
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope #

$ dryad scope --help
dryad scope [--help]

Description:
    commands to work with a single scope

Options:
    --help                display help text for this command

Sub-commands:
    dryad scope active    return the name of the active scope, if set. alias for `dryad scopes default get`
    dryad scope create    create a new scope directory for the garden
    dryad scope delete    remove an existing scope directory from the garden
    dryad scope use       set a scope to be active. alias for `dryad scopes default set`
    dryad scope setting   commands to work with scope settings

dryad scope active #

$ dryad scope active --help
dryad scope active [--help] [--oneline=boolean] [--log-level=string] [--log-format=string]

Description:
    return the name of the active scope, if set. alias for `dryad scopes default get`

Options:
    --help         display help text for this command
    --oneline      enable/disable printing one-line scope descriptions
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope create #

$ dryad scope create --help
dryad scope create [--help] [--log-level=string] [--log-format=string] <name>

Description:
    create a new scope directory for the garden

Arguments:
    name           the name of the new scope

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope delete #

$ dryad scope delete --help
dryad scope delete [--help] [--log-level=string] [--log-format=string] <name>

Description:
    remove an existing scope directory from the garden

Arguments:
    name           the name of the scope to delete

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope use #

$ dryad scope use --help
dryad scope use [--help] [--log-level=string] [--log-format=string] <name>

Description:
    set a scope to be active. alias for `dryad scopes default set`

Arguments:
    name           the name of the scope to set as active. use 'none' to unset the active scope

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope setting #

$ dryad scope setting --help
dryad scope setting [--help]

Description:
    commands to work with scope settings

Options:
    --help                      display help text for this command

Sub-commands:
    dryad scope setting get     print the value of a setting in a scope, if it exists
    dryad scope setting set     set the value of a setting in a scope
    dryad scope setting unset   remove a setting from a scope

dryad scope setting get #

$ dryad scope setting get --help
dryad scope setting get [--help] [--log-level=string] [--log-format=string] <scope> <setting>

Description:
    print the value of a setting in a scope, if it exists

Arguments:
    scope          the name of the scope
    setting        the name of the setting

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope setting set #

$ dryad scope setting set --help
dryad scope setting set [--help] [--log-level=string] [--log-format=string] <scope> <setting> <value>

Description:
    set the value of a setting in a scope

Arguments:
    scope          the name of the scope
    setting        the name of the setting
    value          the new value for the setting

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scope setting unset #

$ dryad scope setting unset --help
dryad scope setting unset [--help] [--log-level=string] [--log-format=string] <scope> <setting>

Description:
    remove a setting from a scope

Arguments:
    scope          the name of the scope
    setting        the name of the setting

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scopes #

$ dryad scopes --help
dryad scopes [--help]

Description:
    commands to work with scopes

Options:
    --help                 display help text for this command

Sub-commands:
    dryad scopes default   work with the default scope
    dryad scopes list      list all scopes in the current garden
    dryad scopes path      return the path of the scopes dir

dryad scopes default #

$ dryad scopes default --help
dryad scopes default [--help]

Description:
    work with the default scope

Options:
    --help                       display help text for this command

Sub-commands:
    dryad scopes default get     return the name of the default scope, if set
    dryad scopes default set     set a scope to be the default
    dryad scopes default unset   remove the default scope setting

dryad scopes default get #

$ dryad scopes default get --help
dryad scopes default get [--help] [--log-level=string] [--log-format=string]

Description:
    return the name of the default scope, if set

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scopes default set #

$ dryad scopes default set --help
dryad scopes default set [--help] [--log-level=string] [--log-format=string] <name>

Description:
    set a scope to be the default

Arguments:
    name           the name of the scope to set as default

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scopes default unset #

$ dryad scopes default unset --help
dryad scopes default unset [--help] [--log-level=string] [--log-format=string]

Description:
    remove the default scope setting

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scopes list #

$ dryad scopes list --help
dryad scopes list [--help] [--oneline=boolean] [--log-level=string] [--log-format=string]

Description:
    list all scopes in the current garden

Options:
    --help         display help text for this command
    --oneline      enable/disable printing one-line scope descriptions
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scopes path #

$ dryad scopes path --help
dryad scopes path [--help] [--log-level=string] [--log-format=string]

Description:
    return the path of the scopes dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad script #

$ dryad script --help
dryad script [--help]

Description:
    commands to work with a scoped script

Options:
    --help                display help text for this command

Sub-commands:
    dryad script create   create and edit a script
    dryad script edit     edit a script
    dryad script get      print the contents of a script
    dryad script path     print the path to a script
    dryad script run      run a script in the current scope

dryad script create #

$ dryad script create --help
dryad script create [--help] [--editor=string] [--scope=string] [--log-level=string] [--log-format=string] <command>

Description:
    create and edit a script

Arguments:
    command        the script name

Options:
    --help         display help text for this command
    --editor       set the editor to use
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad script edit #

$ dryad script edit --help
dryad script edit [--help] [--editor=string] [--scope=string] [--log-level=string] [--log-format=string] <command>

Description:
    edit a script

Arguments:
    command        the script name

Options:
    --help         display help text for this command
    --editor       set the editor to use
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad script get #

$ dryad script get --help
dryad script get [--help] [--scope=string] [--log-level=string] [--log-format=string] <command>

Description:
    print the contents of a script

Arguments:
    command        the script name

Options:
    --help         display help text for this command
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad script path #

$ dryad script path --help
dryad script path [--help] [--scope=string] [--log-level=string] [--log-format=string] <command>

Description:
    print the path to a script

Arguments:
    command        the script name

Options:
    --help         display help text for this command
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad script run #

$ dryad script run --help
dryad script run [--help] [--inherit=boolean] [--scope=string] [--log-level=string] [--log-format=string] <command> [-- args]

Description:
    run a script in the current scope

Arguments:
    command        the script name
    -- args        args to pass to the script, optional

Options:
    --help         display help text for this command
    --inherit      pass all environment variables from the parent environment to the alias to exec
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad scripts #

$ dryad scripts --help
dryad scripts [--help]

Description:
    commands to work with scoped scripts

Options:
    --help               display help text for this command

Sub-commands:
    dryad scripts list   list all available scripts in the current scope

dryad scripts list #

$ dryad scripts list --help
dryad scripts list [--help] [--path=boolean] [--oneline=boolean] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    list all available scripts in the current scope

Options:
    --help         display help text for this command
    --path         print the path to the scripts instead of the script run command
    --oneline      print the oneline decription of each command
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad sprout #

$ dryad sprout --help
dryad sprout [--help]

Description:
    commands to work with a single dryad sprout

Options:
    --help             display help text for this command

Sub-commands:
    dryad sprout run   execute the main for a sprout

dryad sprout run #

$ dryad sprout run --help
dryad sprout run [--help] [--context=string] [--inherit=boolean] [--override=string] [--confirm=string] [--log-level=string] [--log-format=string] <path> [-- args]

Description:
    execute the main for a sprout

Arguments:
    path           path to the sprout
    -- args        args to pass to the stem, optional

Options:
    --help         display help text for this command
    --context      name of the execution context. the HOME env var is set to the path for this context
    --inherit      pass all environment variables from the parent environment to the stem
    --override     run this executable in the stem run envinronment instead of the main
    --confirm      ask for a confirmation string to be entered to execute this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad sprouts #

$ dryad sprouts --help
dryad sprouts [--help]

Description:
    commands to work with dryad sprouts

Options:
    --help                display help text for this command

Sub-commands:
    dryad sprouts list    list all sprouts of the current garden
    dryad sprouts path    return the path of the sprouts dir
    dryad sprouts prune   synchronize the sprouts dir structure with the roots dir
    dryad sprouts run     run each sprout in the current garden

dryad sprouts list #

$ dryad sprouts list --help
dryad sprouts list [--help] [--include=multi-string] [--exclude=multi-string] [--scope=string] [--log-level=string] [--log-format=string]

Description:
    list all sprouts of the current garden

Options:
    --help         display help text for this command
    --include      choose which sprouts are included in the list
    --exclude      choose which sprouts are excluded from the list
    --scope        set the scope for the command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad sprouts path #

$ dryad sprouts path --help
dryad sprouts path [--help] [--log-level=string] [--log-format=string]

Description:
    return the path of the sprouts dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad sprouts prune #

$ dryad sprouts prune --help
dryad sprouts prune [--help] [--log-level=string] [--log-format=string]

Description:
    synchronize the sprouts dir structure with the roots dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad sprouts run #

$ dryad sprouts run --help
dryad sprouts run [--help] [--include=multi-string] [--exclude=multi-string] [--context=string] [--inherit=boolean] [--confirm=string] [--ignore-errors=boolean] [--scope=string] [--log-level=string] [--log-format=string] [-- args]

Description:
    run each sprout in the current garden

Arguments:
    -- args           args to pass to each sprout on execution, optional

Options:
    --help            display help text for this command
    --include         choose which sprouts are included
    --exclude         choose which sprouts are excluded
    --context         name of the execution context. the HOME env var is set to the path for this context
    --inherit         pass all environment variables from the parent environment to the stem
    --confirm         ask for a confirmation string to be entered to execute this command
    --ignore-errors   continue running even if a sprout returns an error
    --scope           set the scope for the command
    --log-level       set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format      set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem #

$ dryad stem --help
dryad stem [--help]

Description:
    commands to work with a single dryad stem

Options:
    --help                   display help text for this command

Sub-commands:
    dryad stem ancestors     list all direct and indirect dependencies of a stem
    dryad stem fingerprint   calculate the fingerprint for a stem dir
    dryad stem files         list the files in a stem
    dryad stem pack          export the stem at the target path into a new folder or archive
    dryad stem path          return the base path of the current root
    dryad stem run           execute the main for a stem
    dryad stem unpack        unpack a stem archive at the target path and import it into the current garden

dryad stem ancestors #

$ dryad stem ancestors --help
dryad stem ancestors [--help] [--relative=boolean] [--self=boolean] [--log-level=string] [--log-format=string] [path]

Description:
    list all direct and indirect dependencies of a stem

Arguments:
    path           path to the stem base dir, optional

Options:
    --help         display help text for this command
    --relative     print stems relative to the base garden path. default true
    --self         include the base stem itself. default false
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem fingerprint #

$ dryad stem fingerprint --help
dryad stem fingerprint [--help] [--exclude=string] [--log-level=string] [--log-format=string] [path]

Description:
    calculate the fingerprint for a stem dir

Arguments:
    path           path to the stem base dir, optional

Options:
    --help         display help text for this command
    --exclude      a regular expression to exclude files from the fingerprint calculation. the regexp matches against the file path relative to the stem base directory
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem files #

$ dryad stem files --help
dryad stem files [--help] [--exclude=string] [--log-level=string] [--log-format=string] [path]

Description:
    list the files in a stem

Arguments:
    path           path to the stem base dir, optional

Options:
    --help         display help text for this command
    --exclude      a regular expression to exclude files from the list. the regexp matches against the file path relative to the stem base directory
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem pack #

$ dryad stem pack --help
dryad stem pack [--help] [--format=string] [--log-level=string] [--log-format=string] <stemPath> <targetPath>

Description:
    export the stem at the target path into a new folder or archive

Arguments:
    stemPath       the path to the stem to pack
    targetPath     the path (including name) to output the archive to

Options:
    --help         display help text for this command
    --format       export format. can be one of 'dir', 'tar', or 'tar.gz'. defaults to 'tar.gz'
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem path #

$ dryad stem path --help
dryad stem path [--help] [--log-level=string] [--log-format=string]

Description:
    return the base path of the current root

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem run #

$ dryad stem run --help
dryad stem run [--help] [--context=string] [--inherit=boolean] [--override=string] [--confirm=string] [--log-level=string] [--log-format=string] <path> [-- args]

Description:
    execute the main for a stem

Arguments:
    path           path to the stem base dir
    -- args        args to pass to the stem, optional

Options:
    --help         display help text for this command
    --context      name of the execution context. the HOME env var is set to the path for this context
    --inherit      pass all environment variables from the parent environment to the stem
    --override     run this executable in the stem run envinronment instead of the main
    --confirm      ask for a confirmation string to be entered to execute this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stem unpack #

$ dryad stem unpack --help
dryad stem unpack [--help] [--log-level=string] [--log-format=string] <archive>

Description:
    unpack a stem archive at the target path and import it into the current garden

Arguments:
    archive        the path to the archive to unpack

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stems #

$ dryad stems --help
dryad stems [--help]

Description:
    commands to work with dryad stems

Options:
    --help             display help text for this command

Sub-commands:
    dryad stems list   list all stems that are dependencies for the current root
    dryad stems path   return the path of the stems dir

dryad stems list #

$ dryad stems list --help
dryad stems list [--help] [--log-level=string] [--log-format=string]

Description:
    list all stems that are dependencies for the current root

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad stems path #

$ dryad stems path --help
dryad stems path [--help] [--log-level=string] [--log-format=string]

Description:
    return the path of the stems dir

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad system #

$ dryad system --help
dryad system [--help]

Description:
    maintenance and utility commands for dryad

Options:
    --help                      display help text for this command

Sub-commands:
    dryad system autocomplete   print out autocomplete options based on a partial command
    dryad system commands       print out a list of all dryad commands

dryad system autocomplete #

$ dryad system autocomplete --help
dryad system autocomplete [--help] [--separator=string] [--log-level=string] [--log-format=string] [-- args]

Description:
    print out autocomplete options based on a partial command

Arguments:
    -- args        args to pass to the command, optional

Options:
    --help         display help text for this command
    --separator    separator string to use between tokens.
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad system commands #

$ dryad system commands --help
dryad system commands [--help] [--log-level=string] [--log-format=string]

Description:
    print out a list of all dryad commands

Options:
    --help         display help text for this command
    --log-level    set the logging level. can be one of 'panic', 'fatal', 'error', 'warn', 'info', 'debug', or 'trace'.  defaults to 'info'
    --log-format   set the logging format. can be one of 'console' or 'json'.  defaults to 'console'

dryad version #

$ dryad version --help
dryad version [--help]

Description:
    print out detailed version info

Options:
    --help   display help text for this command