Skip to content

Commit

Permalink
Update moderne-cli reference to v3.31.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 24, 2025
1 parent 7ab7256 commit 5fee279
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/releases/cli-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
| Component | Current version |
| --------------------- | --------------- |
| CLI version (Stable) | 3.26.2 |
| CLI version (Staging) | 3.30.0 |
| CLI version (Staging) | 3.31.0 |

* [How to update to the latest version of the CLI](../user-documentation/moderne-cli/how-to-guides/cli-upgrade.md)
* [Moderne CLI reference docs](../user-documentation/moderne-cli/cli-reference.md)
98 changes: 97 additions & 1 deletion docs/user-documentation/moderne-cli/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@
* [**mod config moderne show**](#mod-config-moderne-show)
* [**mod config moderne organizations**](#mod-config-moderne-organizations)
* [**mod config moderne organizations show**](#mod-config-moderne-organizations-show)
* [**mod config node**](#mod-config-node)
* [**mod config node installation**](#mod-config-node-installation)
* [**mod config node installation edit**](#mod-config-node-installation-edit)
* [**mod config node installation delete**](#mod-config-node-installation-delete)
* [**mod config node installation list**](#mod-config-node-installation-list)
* [**mod config recipes**](#mod-config-recipes)
* [**mod config recipes artifacts**](#mod-config-recipes-artifacts)
* [**mod config recipes artifacts artifactory**](#mod-config-recipes-artifacts-artifactory)
Expand Down Expand Up @@ -592,6 +597,7 @@ mod config moderne edit --api <tenant-api-gateway> --token <token>
* `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.
* `node`: Configures Node options used for building LSTs and running 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.
Expand Down Expand Up @@ -3058,6 +3064,96 @@ mod config moderne organizations show
| --json | |


## mod config node

Configures Node options used for building LSTs and running recipes.


Must be configured before you can run the commands that involve non-standard Node configurations.

### Usage

```
mod config node [subcommands]
```


### Subcommands

* `installation`: Configures locations of Node that can be used by build tools.

## mod config node installation

Configures locations of Node that can be used by build tools.


Must be configured before you can run the build command if Node is installed in non-standard locations.

### Usage

```
mod config node installation [subcommands]
```


### Subcommands

* `edit`: Configures locations of Node that can be used by build tools.
* `delete`: Removes the configured Node installations. The CLI will revert to using only detectable Node installations.
* `list`: Displays the detected and configured Node installations in the order in which they will be selected, constrained by versions detected from a particular repository.

## mod config node installation edit

Configures locations of Node that can be used by build tools.


Must be configured before you can run the build command if Node is installed in non-standard locations.

### Usage

```
mod config node installation edit [parameters]
```

### Parameters

| Name | Description |
| ---- | ----------- |
| nodeInstallations | The paths on disk where Node installations can be found. |



## mod config node installation delete

Removes the configured Node installations. The CLI will revert to using only detectable Node installations.


### Usage

```
mod config node installation delete
```



## mod config node installation list

Displays the detected and configured Node installations in the order in which they will be selected, constrained by versions detected from a particular repository.


### Usage

```
mod config node installation list
```

### Options

| Name | Description |
| ---- | ----------- |
| --named | Filter the list of Node installations to . |


## mod config recipes

Configures the recipe marketplace available to the CLI. Must be configured before you can run recipes.
Expand Down Expand Up @@ -4937,7 +5033,7 @@ mod git push /path/to/project -u origin feature-branch
| --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.<br/><br/>Supports partial matches (e.g., if the origin is *[email protected]: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.<br/><br/>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` |
| --u, --set-upstream | For every branch that is up to date or successfully pushed, add upstream (tracking) reference. | |
| -u, --set-upstream | For every branch that is up to date or successfully pushed, add upstream (tracking) reference. | |


## mod git reset
Expand Down
14 changes: 7 additions & 7 deletions docs/user-documentation/moderne-cli/getting-started/cli-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If everything was configured correctly, you should be able to type `mod` into yo
```bash
➜ mod

Moderne CLI 3.30.0
Moderne CLI 3.31.0

Usage:

Expand Down Expand Up @@ -168,7 +168,7 @@ If you need to enter an SSH passphrase to clone repositories, please see our [SS
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0

> Cloning organization from Moderne

Expand Down Expand Up @@ -245,7 +245,7 @@ mod build . --download-only
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0

> Selecting repositories

Expand Down Expand Up @@ -441,7 +441,7 @@ mod run . --recipe DependencyVulnerabilityCheck --parallel 0
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0

> Selecting repositories

Expand Down Expand Up @@ -559,7 +559,7 @@ mod study . --last-recipe-run --data-table VulnerabilityReport
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0

Found recipe run 20250114092524-RN2dY

Expand Down Expand Up @@ -660,7 +660,7 @@ mod run . --recipe CommonStaticAnalysis --parallel 0
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0

> Selecting repositories

Expand Down Expand Up @@ -742,7 +742,7 @@ mod git checkout . -b workshop-changes --last-recipe-run
<summary>You should see output similar to the following.</summary>
```bash
Moderne CLI 3.30.0
Moderne CLI 3.31.0
Found recipe run 20250114093829-TkzAc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If everything was configured correctly, you should be able to type `mod` into yo
```bash
➜ mod

Moderne CLI 3.30.0
Moderne CLI 3.31.0

Usage:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ mod config java jdk list
```bash
➜ moderne-cli git:(main) ✗ mod config java jdk list

Moderne CLI 3.30.0
Moderne CLI 3.31.0

> Listing available JDKs

Expand Down

0 comments on commit 5fee279

Please sign in to comment.