Skip to main content

Command reference

    Command overview

    CommandAliasDescription
    action createa,actions cGenerate a custom workflow action.
    analyzeanAnalyze app to check for valid app configurations, security issues and bundle statistics.
    buildbBuild the app and analyzes the bundle.
    createcCreate new Dynatrace app.
    defaultOutput basic information about the App Toolkit.
    deploydeDeploy the app to the selected environment or the 'dev' channel of linked project.
    devdStart the development server.
    function createf,functions cCreate an app function.
    generate actiong aGenerate a custom workflow action.
    generate functiong fGenerate an app function.
    infoiOutput detailed information about the App Toolkit and the environment.
    uninstallunUninstall the app from the specified environment.
    updateuUpdate @dynatrace-scoped packages and the App Toolkit to the latest version and apply automatic migrations.
    versionvPrint the version of the App Toolkit.
    helpDisplay a set of dt-app commands with a description.

    dt-app action create

    Generate a custom workflow action.

    Arguments

    ArgumentDescription
    [name]The name of the action.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not write any changes to the file system.
    --skip-testsDo not generate test files.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app analyze

    Analyze app to check for valid app configurations, security issues and bundle statistics.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app build

    Build the app and analyzes the bundle.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --no-prodBuild in development mode.
    --no-sdk-injectionDisable the automatic injection of the Dynatrace SDK.
    --no-type-checkSkip type checking.
    --prodBuild in production mode. Per default the build always gets executed in production mode.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app create

    Create new Dynatrace app.

    Arguments

    ArgumentDescription
    [name]The name of the app.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not write any changes to the file system.
    --environment-url <name>Specify your environment.
    --no-embedded-templatesSpecify whether the templates embedded with the CLI or the ones downloaded from an external source should be used.
    --no-gitDo not initialize a git repository.
    --oauth-client-id <id>Specify the single sign-on client ID.
    --package-manager [name]Specify your package manager.
    --skip-installDo not install dependencies after initialization.
    --skip-repository-checkSkip the safety check whether the project is generated inside an existing repository for headless execution.
    --template [name]Choose the template to generate the app from.
    --template-dir <dir>Specify the directory that contains the template your app should be created from.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app default

    Output basic information about the App Toolkit.

    Options

    OptionDescription
    -v, --versionPrint the version of the App Toolkit.

    dt-app deploy

    Deploy the app to the selected environment or the 'dev' channel of linked project.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not actually deploy the app only perform a dry run.
    --environment-url [url]The environment that should be used.
    --no-type-checkSkip type checking.
    --sign-archiveSign the archive that will be deployed. If you need to specify a different signing endpoint, set the appropriate environment variables. For more details, refer to the Environment Variables section.
    --skip-buildSkip the build before deploying.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%".

    dt-app dev

    Start the development server.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --environment-url [url]The environment that should be used.
    --host [name]The host IP to bind the dev server on.
    --no-live-reloadDisable file watching and browser live reloading
    --no-openDo not open the browser with the dev server.
    --no-sdk-injectionDisable automatic injection of the Dynatrace SDK.
    --no-type-checkSkip type checking.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"
    -o, --openOpen the browser with the dev server.
    -p, --port <number>The port where the files should be served.
    -w, --show-warningsDisplay build warnings.

    dt-app function create

    Create an app function.

    Arguments

    ArgumentDescription
    [name]The name of the function.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not write any changes to the file system.
    --generate-testsGenerate test files for functions without tests.
    --skip-testsDo not generate test files.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app generate action

    Generate a custom workflow action.

    Arguments

    ArgumentDescription
    [name]The name of the action.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not write any changes to the file system.
    --skip-testsDo not generate test files.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app generate function

    Generate an app function.

    Arguments

    ArgumentDescription
    [name]The name of the function.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not write any changes to the file system.
    --generate-testsGenerate test files for functions without tests.
    --skip-testsDo not generate test files.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app info

    Output detailed information about the App Toolkit and the environment.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app uninstall

    Uninstall the app from the specified environment.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --dry-runDo not actually remove the app only perform a dry run.
    --environment-url [url]The environment that should be used.
    --globalRemove the app in the global context.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"

    dt-app update

    Update @dynatrace-scoped packages and the App Toolkit to the latest version and apply automatic migrations.

    Arguments

    ArgumentDescription
    [packages...]The packages that should be updated.

    Options

    OptionDescription
    --cwd [dir]The current working directory where it should run.
    --skip-installDo not install dependencies after migrations.
    --verbose [context]Output additional debug logs. Add optional context to filter. % at the end as wildcard possible. Example: "--verbose cli-%"
    --yesUpdate all outdated packages without prompt for confirmation.
    -i, --interactiveChoose the packages you want to update manually.

    dt-app version

    Print the version of the App Toolkit.

    dt-app help

    Display a set of dt-app commands with a description.

    Still have questions?
    Find answers in the Dynatrace Community