Moderne CLI reference
Table of contents
- mod
- mod afterburner
- mod audit
- mod audit builds
- mod audit builds list
- mod audit runs
- mod audit runs list
- mod build
- mod clean
- mod clean builds
- mod clean runs
- mod config
- mod config build
- mod config build active-styles
- mod config build active-styles delete
- mod config build active-styles edit
- mod config build active-styles show
- mod config build bazel
- mod config build bazel arguments
- mod config build bazel arguments delete
- mod config build bazel arguments edit
- mod config build bazel arguments show
- mod config build bazel executable
- mod config build bazel executable delete
- mod config build bazel executable edit
- mod config build bazel executable show
- mod config build bazel timeout
- mod config build bazel timeout delete
- mod config build bazel timeout edit
- mod config build bazel timeout show
- mod config build dotnet
- mod config build dotnet timeout
- mod config build dotnet timeout delete
- mod config build dotnet timeout edit
- mod config build dotnet timeout show
- mod config build gradle
- mod config build gradle arguments
- mod config build gradle arguments delete
- mod config build gradle arguments edit
- mod config build gradle arguments show
mod config build gradle root(deprecated)mod config build gradle root delete(deprecated)mod config build gradle root edit(deprecated)mod config build gradle root show(deprecated)- mod config build gradle timeout
- mod config build gradle timeout delete
- mod config build gradle timeout edit
- mod config build gradle timeout show
- mod config build maven
- mod config build maven arguments
- mod config build maven arguments delete
- mod config build maven arguments edit
- mod config build maven arguments show
- mod config build maven settings
- mod config build maven settings delete
- mod config build maven settings edit
- mod config build maven settings show
- mod config build maven timeout
- mod config build maven timeout delete
- mod config build maven timeout edit
- mod config build maven timeout show
- mod config clone
- mod config clone protocol
- mod config clone protocol delete
- mod config clone protocol edit
- mod config clone protocol show
- mod config dotnet
- mod config dotnet installation
- mod config dotnet installation edit
- mod config dotnet installation delete
- mod config dotnet installation list
- mod config environment
- mod config environment show
- mod config features
- mod config features index-recipes
- mod config features no-maven-central
- mod config features no-nuget-org
- mod config http
- mod config http proxy
- mod config http proxy delete
- mod config http proxy edit
- mod config http proxy show
- mod config http trust-store
- mod config http trust-store delete
- mod config http trust-store edit
- mod config http trust-store edit system
- mod config http trust-store edit file
- mod config http trust-store edit java-home
- mod config http trust-store show
- mod config java
- mod config java jdk
- mod config java jdk edit
- mod config java jdk delete
- mod config java jdk list
- mod config java options
- mod config java options edit
- mod config java options delete
- mod config java options show
- mod config java version
- mod config java version edit
- mod config java version delete
- mod config java version show
- mod config license
- mod config license delete
- mod config license edit
- mod config license show
- mod config license moderne
- mod config license moderne sync
- mod config lsts
- mod config lsts artifacts
- mod config lsts artifacts artifactory
- mod config lsts artifacts artifactory edit
- mod config lsts artifacts artifactory delete
- mod config lsts artifacts artifactory show
- mod config lsts artifacts show
- mod config lsts artifacts maven
- mod config lsts artifacts maven edit
- mod config lsts artifacts maven delete
- mod config lsts artifacts maven show
- mod config moderne
- mod config moderne delete
- mod config moderne edit
- mod config moderne local
- mod config moderne show
- mod config moderne organizations
- mod config moderne organizations show
- mod config recipes
- mod config recipes artifacts
- mod config recipes artifacts artifactory
- mod config recipes artifacts artifactory edit
- mod config recipes artifacts artifactory delete
- mod config recipes artifacts artifactory show
- mod config recipes artifacts show
- mod config recipes artifacts default-repositories
- mod config recipes artifacts default-repositories enable
- mod config recipes artifacts default-repositories disable
- mod config recipes artifacts default-repositories show
- mod config recipes artifacts maven
- mod config recipes artifacts maven edit
- mod config recipes artifacts maven delete
- mod config recipes artifacts maven show
- mod config recipes artifacts nuget
- mod config recipes artifacts nuget edit
- mod config recipes artifacts nuget delete
- mod config recipes artifacts nuget show
- mod config recipes export
- mod config recipes export json
- mod config recipes export csv
- mod config recipes jar
- mod config recipes jar install
- mod config recipes jar delete
- mod config recipes nupkg
- mod config recipes nupkg install
- mod config recipes nupkg delete
- mod config recipes moderne
- mod config recipes moderne install
- mod config recipes moderne push
- mod config recipes moderne sync
- mod config recipes delete
- mod config recipes list
- mod config recipes search
- mod config recipes yaml
- mod config recipes yaml install
- mod config recipes yaml delete
- mod config run
- mod config run timeout
- mod config run timeout delete
- mod config run timeout edit
- mod config run timeout show
- mod config scm
- mod config scm gitlab
mod config scm gitlab base-url(deprecated)mod config scm gitlab base-url delete(deprecated)mod config scm gitlab base-url edit(deprecated)mod config scm gitlab base-url show(deprecated)- mod config scm gitlab base-urls
- mod config scm gitlab base-urls delete
- mod config scm gitlab base-urls edit
- mod config scm gitlab base-urls show
- mod config scm bitbucket
- mod config scm bitbucket base-urls
- mod config scm bitbucket base-urls delete
- mod config scm bitbucket base-urls edit
- mod config scm bitbucket base-urls show
- mod config scm moderne
- mod config scm moderne sync
- mod config scm add
- mod config scm remove
- mod config scm show
- mod config user
- mod config user delete
- mod config user edit
- mod config user show
- mod devcenter
- mod devcenter run
- mod exec
- mod git
- mod git add
- mod git apply
- mod git checkout
- mod git clone
- mod git clone csv
- mod git clone json
- mod git clone moderne
- mod git commit
- mod git pull
- mod git push
- mod git reset
- mod git rev-parse
- mod git stashset
- mod git stashset apply
- mod git stashset push
- mod git stashset
- mod git stashset apply
- mod git stashset push
- mod git sync
- mod git sync moderne
- mod git status
- mod log
- mod log builds
- mod log builds add
- mod log runs
- mod log runs add
- mod list
- mod monitor
- mod publish
- mod run
- mod run-history
- mod study
- mod generate-completion
mod
Automated code remediation.
Usage
mod [subcommands]
Options
Name | Description |
---|---|
--version | Display version info. |
Subcommands
afterburner
: (INCUBATING) Indexes built LSTs to accelerate recipe execution.audit
: (INCUBATING) Perform an audit of recent activity.build
: Generates LST artifacts for one or more repositories.clean
: Clean build and run artifacts produced by the CLI.config
: Global configuration options that are required by some CLI commands.devcenter
: DevCenter operations.exec
: Execute an arbitrary shell command recursively on selected repository roots.git
: Multi-repository git operations.log
: Manages a log aggregate.list
: Lists the repositories that can be built and published.monitor
: (INCUBATING) Launches an HTTP server used to monitor the CLI.publish
: Publishes the LST artifacts for one or more projects.run
: Runs an OpenRewrite recipe locally on pre-built LSTS.run-history
: Get information about the most recent recipe runs. This will be transitioning to mod audit runs list eventually. A deprecation notice will be added here when we suggest adopting the alternative.study
: Produces studies from OpenRewrite recipe data tables locally.generate-completion
mod afterburner
(INCUBATING) Indexes built LSTs to accelerate recipe execution.
The intent of this command is to allow future recipe runs to avoid the cost of interacting with LSTs that could provably never return a result. Not every recipe is possible to optimize in this way, but some common ones are, and especially those recipes that are used as common actions in IDE integrations. The contents of these indexes is not guaranteed to be stable between versions of the CLI, and they are intended to only be used by the CLI itself in subsequent run commands.
Usage
mod afterburner [parameters]
Examples
mod afterburner /path/to/project
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
mod audit
(INCUBATING) Perform an audit of recent activity.
Sources information from the activity log kept locally to provide reports in various forms.
Usage
mod audit [subcommands]
Subcommands
builds
: (INCUBATING) Perform an audit of recent build activity.runs
: (INCUBATING) Perform an audit of recent recipe running activity.
mod audit builds
(INCUBATING) Perform an audit of recent build activity.
Sources information from the activity log kept locally to provide reports on LST building activity.
Usage
mod audit builds [subcommands]
Subcommands
list
: (INCUBATING) Prints build activity to standard output.
mod audit builds list
(INCUBATING) Prints build activity to standard output.
Provides a form of build activity that can be directly consumed by reading standard output.
Usage
mod audit builds list [parameters]
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--streaming | (INCUBATING) Stream results from the audit to the console as they are produced. This is intended to be machine readable for the creation of incremental experiences like usage search in the IDE. |
mod audit runs
(INCUBATING) Perform an audit of recent recipe running activity.
Sources information from the activity log kept locally to provide reports on recipe running activity.
Usage
mod audit runs [subcommands]
Subcommands
list
: (INCUBATING) Prints recipe run activity to standard output.
mod audit runs list
(INCUBATING) Prints recipe run activity to standard output.
Provides a form of recipe run activity that can be directly consumed by reading standard output.
Usage
mod audit runs list [parameters]
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--streaming | (INCUBATING) Stream results from the audit to the console as they are produced. This is intended to be machine readable for the creation of incremental experiences like usage search in the IDE. |
mod build
Generates LST artifacts for one or more repositories.
Once generated, the artifacts can be uploaded to your artifact management tool so that Moderne can ingest them or they can be used to run recipes locally.
While it is possible to manually build and publish your artifacts, we strongly recommend automating this. Please see the moderneinc/mass-ingest-example repository on GitHub for an idea of how to do that.
If the path itself is not a Git repository, then this command will recursively look through the directories to find Git repositories that match the repository-* options.
If this command executes successfully, the LST artifact for each project will be stored in a .moderne/build directory inside of each repository that is built.
If you've set up a connection with Moderne (by running the mod config moderne command), this command will attempt to download LST artifacts from Moderne instead of building them locally. This will allow you to quickly run recipes and make changes. If you do not want this command to look for LST artifacts in Moderne, you can add the --no-download flag.
Usage
mod build [parameters]
Examples
mod build /path/to/project
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--download-only | Only download LSTs from Moderne. If no download is available, do not build the LST from source. | |
--dry-run | Do not actually build the LST(s), but list the steps that would be required to do so. | |
--no-download | Do not attempt to download LSTs from Moderne. | |
--offline | When an underlying build tool has an offline mode, enable it. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--streaming | (INCUBATING) Stream results from the build to the console as they are produced. This is intended to be machine readable for the creation of incremental experiences like in the IDE. |
mod clean
Clean build and run artifacts produced by the CLI.
Can be filtered to only clean certain artifacts.
Usage
mod clean [subcommands]
Examples
mod clean builds /path/to/project --keep 1
Subcommands
builds
: Clean build artifacts produced by the CLI.runs
: Clean run artifacts produced by the CLI.
mod clean builds
Clean build artifacts produced by the CLI.
Can be filtered to only clean certain artifacts.
Usage
mod clean builds [parameters]
Examples
mod clean builds /path/to/project --keep 1
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--keep | Keep this many run artifacts and clean all others. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
mod clean runs
Clean run artifacts produced by the CLI.
Can be filtered to only clean certain artifacts.
Usage
mod clean runs [parameters]
Examples
mod clean runs /path/to/project --keep 1
Parameters
Name | Description |
---|---|
path | The absolute or relative path on disk to a directory containing one or more checked-out Git repositories that you want to operate on. This typically takes the form of targeting a single, checked-out copy of a Git repository or it can be a folder containing a collection of Git repositories that will be discovered by recursively scanning the initial provided directory. |
Options
Name | Description | Example |
---|---|---|
--keep | Keep this many run artifacts and clean all others. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
mod config
Global configuration options that are required by some CLI commands.
Configuration set here is used as needed in all subsequent commands.
Usage
mod config [subcommands]
Examples
mod config moderne edit --api <tenant-api-gateway> --token <token>
Subcommands
build
: Configures build tools used to produce LSTs.clone
: Configures cloning behavior.dotnet
: Configures DotNet options used for building LSTs and running recipes.environment
: The build environment that the CLI is running in.features
: Configures experimental features.http
: Configures HTTP options that will be used throughout the CLI.java
: Configures Java options used for building LSTs and running recipes.license
: Configure a license key.lsts
: Configures LSTs production and publishing.moderne
: Configures the connection to Moderne. Must be configured before you can install and run recipes.recipes
: Configures the recipe marketplace available to the CLI. Must be configured before you can run recipes.run
: Configures recipe run behavior.scm
: Configures source code management.user
: Configure the active user.
mod config build
Configures build tools used to produce LSTs.
Usage
mod config build [subcommands]
Subcommands
active-styles
: Configure the active styles to use when building LSTs.bazel
: Configures Bazel as it is used for LST production.dotnet
: Configures dotnet as it is used for LST production.gradle
: Configures Gradle as it is used to resolve recipe dependencies and when running recipes.maven
: Configures Maven as it is used for LST production, resolving recipe dependencies, and when running recipes.
mod config build active-styles
Configure the active styles to use when building LSTs.
Overriding active styles circumvents auto-detection of styles in the production of LSTs.
Usage
mod config build active-styles [subcommands]
Subcommands
delete
: Removes overriding active styles.edit
: Configure the active styles to use when building LSTs.show
: Displays the configured overriding active styles.
mod config build active-styles delete
Removes overriding active styles.
Usage
mod config build active-styles delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build active-styles edit
Configure the active styles to use when building LSTs.
Overriding active styles circumvents auto-detection of styles in the production of LSTs.
Usage
mod config build active-styles edit [parameters]
Parameters
Name | Description |
---|---|
activeStyles | Additional build arguments that are added to the end of the Gradle command line. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build active-styles show
Displays the configured overriding active styles.
Usage
mod config build active-styles show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel
Configures Bazel as it is used for LST production.
Usage
mod config build bazel [subcommands]
Subcommands
arguments
: Configure Bazel build arguments.executable
: Configure Bazel executable.timeout
: Configure the build timeout.
mod config build bazel arguments
Configure Bazel build arguments.
Build arguments are added to the end of the Bazel command line when building LSTs.
Usage
mod config build bazel arguments [subcommands]
Subcommands
delete
: Removes additional build arguments for Bazel.edit
: Configure Bazel build arguments.show
: Displays the configured Bazel additional build arguments.
mod config build bazel arguments delete
Removes additional build arguments for Bazel.
Usage
mod config build bazel arguments delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel arguments edit
Configure Bazel build arguments.
Build arguments are added to the end of the Bazel command line when building LSTs.
Usage
mod config build bazel arguments edit
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel arguments show
Displays the configured Bazel additional build arguments.
Usage
mod config build bazel arguments show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel executable
Configure Bazel executable.
Allows you to specify the location of a Bazel settings.xml file that should be used when Bazel is being used to resolve recipe dependencies or run recipes. You can also use an environment variable that points to location of the file with ${ENV_VAR}
syntax.
Usage
mod config build bazel executable [subcommands]
Subcommands
delete
: Removes the configured Bazel executable.edit
: Configure the Bazel executable.show
: Displays the configured Bazel executable.
mod config build bazel executable delete
Removes the configured Bazel executable.
The CLI will revert to its default mode of detecting the Bazel executable.
Usage
mod config build bazel executable delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel executable edit
Configure the Bazel executable.
Determines whether bazelisk or bazel will be used.
Usage
mod config build bazel executable edit [parameters]
Parameters
Name | Description |
---|---|
executable | The bazel executable to use. This can be just bazelisk or bazel if either is on PATH or a fully qualified executable name if not. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel executable show
Displays the configured Bazel executable.
Usage
mod config build bazel executable show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel timeout
Configure the build timeout.
Limits the amount of time the CLI will wait for a single execution of the build tool.
Usage
mod config build bazel timeout [subcommands]
Subcommands
delete
: Removes the configured build timeout.edit
: Configure the timeout for build operations.show
: Displays the configured build timeout.
mod config build bazel timeout delete
Removes the configured build timeout.
Usage
mod config build bazel timeout delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel timeout edit
Configure the timeout for build operations.
Limits the amount of time the CLI will wait for a single execution of the build tool. Setting this to too high of a value may cause mass ingestion to hang or appear to hang.
Usage
mod config build bazel timeout edit [parameters]
Parameters
Name | Description |
---|---|
duration | The duration of the timeout expressed as an ISO-8601 duration. For example: 'PT1H' for one hour, 'PT30M' for 30 minutes, 'PT1H30M' for one hour and 30 minutes. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build bazel timeout show
Displays the configured build timeout.
Usage
mod config build bazel timeout show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build dotnet
Configures dotnet as it is used for LST production.
Usage
mod config build dotnet [subcommands]
Subcommands
timeout
: Configure the build timeout.
mod config build dotnet timeout
Configure the build timeout.
Limits the amount of time the CLI will wait for a single execution of the build tool.
Usage
mod config build dotnet timeout [subcommands]
Subcommands
delete
: Removes the configured build timeout.edit
: Configure the timeout for build operations.show
: Displays the configured build timeout.
mod config build dotnet timeout delete
Removes the configured build timeout.
Usage
mod config build dotnet timeout delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build dotnet timeout edit
Configure the timeout for build operations.
Limits the amount of time the CLI will wait for a single execution of the build tool. Setting this to too high of a value may cause mass ingestion to hang or appear to hang.
Usage
mod config build dotnet timeout edit [parameters]
Parameters
Name | Description |
---|---|
duration | The duration of the timeout expressed as an ISO-8601 duration. For example: 'PT1H' for one hour, 'PT30M' for 30 minutes, 'PT1H30M' for one hour and 30 minutes. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build dotnet timeout show
Displays the configured build timeout.
Usage
mod config build dotnet timeout show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle
Configures Gradle as it is used to resolve recipe dependencies and when running recipes.
Usage
mod config build gradle [subcommands]
Examples
mod config build gradle arguments edit --refresh-dependencies
Subcommands
arguments
: Configure Gradle build arguments.root
: (DEPRECATED) Configure the directory containing the Gradle root build. This could be.
to force the CLI to use the root directory of the repository as the Gradle build and look no deeper.timeout
: Configure the build timeout.
mod config build gradle arguments
Configure Gradle build arguments.
Build arguments are added to the end of the Gradle command line when building LSTs.
Usage
mod config build gradle arguments [subcommands]
Subcommands
delete
: Removes additional build arguments for Gradle.edit
: Configure Gradle build arguments.show
: Displays the configured Gradle additional build arguments.
mod config build gradle arguments delete
Removes additional build arguments for Gradle.
Usage
mod config build gradle arguments delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle arguments edit
Configure Gradle build arguments.
Build arguments are added to the end of the Gradle command line when building LSTs.
Usage
mod config build gradle arguments edit
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle arguments show
Displays the configured Gradle additional build arguments.
Usage
mod config build gradle arguments show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle root (deprecated)
(DEPRECATED) Configure the directory containing the Gradle root build. This could be .
to force the CLI to use the root directory of the repository as the Gradle build and look no deeper.
Use builds steps configuration instead. When this is set, the CLI does not attempt to find root Gradle builds in subdirectories or siblings recursively.
Usage
mod config build gradle root [subcommands]
Subcommands
delete
: (DEPRECATED) Removes the configured directory containing the Gradle root build.edit
: (DEPRECATED) Configure the directory containing the Gradle root build.show
: (DEPRECATED) Displays the configured directory containing the Gradle root build.
mod config build gradle root delete (deprecated)
(DEPRECATED) Removes the configured directory containing the Gradle root build.
(DEPRECATED) Use builds steps configuration instead.
Usage
mod config build gradle root delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle root edit (deprecated)
(DEPRECATED) Configure the directory containing the Gradle root build.
Use builds steps configuration instead. When this is set, the CLI does not attempt to find root Gradle builds in subdirectories or siblings recursively.
Usage
mod config build gradle root edit [parameters]
Parameters
Name | Description |
---|---|
root | The directory containing the Gradle root build. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle root show (deprecated)
(DEPRECATED) Displays the configured directory containing the Gradle root build.
Use build steps configuration instead.
Usage
mod config build gradle root show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle timeout
Configure the build timeout.
Limits the amount of time the CLI will wait for a single execution of the build tool.
Usage
mod config build gradle timeout [subcommands]
Subcommands
delete
: Removes the configured build timeout.edit
: Configure the timeout for build operations.show
: Displays the configured build timeout.
mod config build gradle timeout delete
Removes the configured build timeout.
Usage
mod config build gradle timeout delete
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle timeout edit
Configure the timeout for build operations.
Limits the amount of time the CLI will wait for a single execution of the build tool. Setting this to too high of a value may cause mass ingestion to hang or appear to hang.
Usage
mod config build gradle timeout edit [parameters]
Parameters
Name | Description |
---|---|
duration | The duration of the timeout expressed as an ISO-8601 duration. For example: 'PT1H' for one hour, 'PT30M' for 30 minutes, 'PT1H30M' for one hour and 30 minutes. |
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build gradle timeout show
Displays the configured build timeout.
Usage
mod config build gradle timeout show
Options
Name | Description | Example |
---|---|---|
--local | Configuration relevant to a specific group of repositories. | |
--repository-branch | Restricts the command to only run against repositories that are currently on this branch. | main |
--repository-origin | Restricts the command to only run against repositories that have an origin that matches this. Supports partial matches (e.g., if the origin is git@github.com:foo/bar - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | github.com |
--repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this. Supports partial matches (e.g., if the repository is in the foo organization and is called bar - all of the following would match this: foo/bar, foo/.*, foo, and bar). | openrewrite/rewrite |
--save | When applied to a group of repositories, indicates that the configuration should be placed in a .modernecfg which can be committed to source control. When applied to global configuration, this option has no effect. |
mod config build maven
Configures Maven as it is used for LST production, resolving recipe dependencies, and when running recipes.
Usage
mod config build maven [subcommands]
Examples
mod config build maven settings edit <path-to-settings.xml>