Skip to content

Commit

Permalink
Update moderne-cli reference to v3.18.8
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 27, 2024
1 parent 6d0078e commit e1fc964
Show file tree
Hide file tree
Showing 7 changed files with 203 additions and 24 deletions.
2 changes: 1 addition & 1 deletion releases/cli-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
| Component | Current version |
| --------------------- | --------------- |
| CLI version (Stable) | 3.17.2 |
| CLI version (Staging) | 3.18.7 |
| CLI version (Staging) | 3.18.8 |

* [Moderne CLI reference docs](../user-documentation/moderne-cli/cli-reference.md)
179 changes: 179 additions & 0 deletions user-documentation/moderne-cli/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,19 @@
* [**mod config recipes artifacts maven edit**](#mod-config-recipes-artifacts-maven-edit)
* [**mod config recipes artifacts maven delete**](#mod-config-recipes-artifacts-maven-delete)
* [**mod config recipes artifacts maven show**](#mod-config-recipes-artifacts-maven-show)
* [**mod config recipes artifacts nuget**](#mod-config-recipes-artifacts-nuget)
* [**mod config recipes artifacts nuget edit**](#mod-config-recipes-artifacts-nuget-edit)
* [**mod config recipes artifacts nuget delete**](#mod-config-recipes-artifacts-nuget-delete)
* [**mod config recipes artifacts nuget show**](#mod-config-recipes-artifacts-nuget-show)
* [**mod config recipes export**](#mod-config-recipes-export)
* [**mod config recipes export json**](#mod-config-recipes-export-json)
* [**mod config recipes export csv**](#mod-config-recipes-export-csv)
* [**mod config recipes jar**](#mod-config-recipes-jar)
* [**mod config recipes jar install**](#mod-config-recipes-jar-install)
* [**mod config recipes jar delete**](#mod-config-recipes-jar-delete)
* [**mod config recipes nupkg**](#mod-config-recipes-nupkg)
* [**mod config recipes nupkg install**](#mod-config-recipes-nupkg-install)
* [**mod config recipes nupkg delete**](#mod-config-recipes-nupkg-delete)
* [**mod config recipes moderne**](#mod-config-recipes-moderne)
* [**mod config recipes moderne install**](#mod-config-recipes-moderne-install)
* [**mod config recipes moderne push**](#mod-config-recipes-moderne-push)
Expand Down Expand Up @@ -3025,6 +3032,7 @@ mod config recipes moderne sync
* `artifacts`: Configures artifact repositories to resolve recipes from.
* `export`: Export the recipe catalog for study by different tools.
* `jar`: Adds or updates an artifact that contains recipes that should be added to the recipe marketplace in the CLI.
* `nupkg`: Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI.
* `moderne`: Configures which Moderne recipes should be installed and used in the local CLI marketplace.
* `delete`: Clear the whole recipe marketplace.
* `list`: List the artifacts that are contributing recipes to the marketplace.
Expand All @@ -3051,6 +3059,7 @@ mod config recipes artifacts [subcommands]
* `show`: Displays the recipe artifacts repository configuration.
* `default-repositories`: (INCUBATING) Configure the availability of default repositories.
* `maven`: Configures a Maven-formatted artifact repository that recipes will be resolved from.
* `nuget`: Configures a Nuget-formatted artifact repository that recipes will be resolved from.

## mod config recipes artifacts artifactory

Expand Down Expand Up @@ -3297,6 +3306,91 @@ mod config recipes artifacts maven show



## mod config recipes artifacts nuget

Configures a Nuget-formatted artifact repository that recipes will be resolved from.


All subsequent recipe installation commands will use this Nuget repository.

### Usage

```
mod config recipes artifacts nuget [subcommands]
```


### Subcommands

* `edit`: Configures the repository that recipes will be resolved from.
* `delete`: Removes the Nuget artifact repository repository configuration.
* `show`: Displays the Nuget artifact repository repository configuration.

## mod config recipes artifacts nuget edit

Configures the repository that recipes will be resolved from.


All subsequent recipe installation commands will use this artifact repository.

### Usage

```
mod config recipes artifacts nuget edit [parameters]
```

### Examples

```
mod config recipes nuget edit <artifact-repository-url> --user <user> --password <password>
```

### Parameters

| Name | Description |
| ---- | ----------- |
| url | The URL of the artifact repository that recipes will be resolved from. |

### Options

| Name | Description | Example |
| ---- | ----------- | ---------- |
| --authorization | The authorization header value to use. | `Bearer XXXXX` |
| --password | The password to authenticate with. | |
| --skip-ssl | If this parameter is included, SSL verification will be skipped. | |
| --user | The user to authenticate with. | |


## mod config recipes artifacts nuget delete

Removes the Nuget artifact repository repository configuration.




### Usage

```
mod config recipes artifacts nuget delete
```



## mod config recipes artifacts nuget show

Displays the Nuget artifact repository repository configuration.




### Usage

```
mod config recipes artifacts nuget show
```



## mod config recipes export

Export the recipe catalog for study by different tools.
Expand Down Expand Up @@ -3443,6 +3537,91 @@ mod config recipes jar delete rewrite-java



## mod config recipes nupkg

Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI.


The recipes defined by this package will then be available to run.

### Usage

```
mod config recipes nupkg [subcommands]
```

### Examples

```
mod config recipes nupkg install rewrite.java:LATEST
```


### Subcommands

* `install`: Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI.
* `delete`: Removes a package supplying recipes to the marketplace.

## mod config recipes nupkg install

Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI.


The recipes defined by this package will then be available to run.

### Usage

```
mod config recipes nupkg install [parameters]
```

### Examples

```
mod config recipes nupkg install rewrite.java:LATEST
```

### Parameters

| Name | Description |
| ---- | ----------- |
| PIV | The package id, and version of the package to install in the format packageId:version. The version may be a fixed version, LATEST, or RELEASE.
The dependency will be resolved from the package source defined in **mod config lsts artifacts** |

### Options

| Name | Description |
| ---- | ----------- |
| --repository-url, --repository | The repository URL that the package will be resolved from. |


## mod config recipes nupkg delete

Removes a package supplying recipes to the marketplace.


The recipes defined by this package will then no longer be available to run.

### Usage

```
mod config recipes nupkg delete [parameters]
```

### Examples

```
mod config recipes nupkg delete rewrite.java
```

### Parameters

| Name | Description |
| ---- | ----------- |
| artifact | An package id. |



## mod config recipes moderne

Configures which Moderne recipes should be installed and used in the local CLI marketplace.
Expand Down
14 changes: 7 additions & 7 deletions user-documentation/moderne-cli/getting-started/cli-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ If everything was configured correctly, you should be able to type `mod` into yo
```bash
➜ mod

Moderne CLI 3.18.7
Moderne CLI 3.18.8

Usage:

Expand Down Expand Up @@ -255,7 +255,7 @@ cd $HOME/workshop
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Listing repositories from Moderne

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

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

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

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

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

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

Found recipe run 20240716083055-NH4Xb

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

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

Expand Down Expand Up @@ -784,7 +784,7 @@ mod git checkout . -b workshop-changes --last-recipe-run
<summary>You should see output similar to the following.</summary>

```bash
Moderne CLI 3.18.7
Moderne CLI 3.18.8

Found recipe run 20240717084152-vY22R

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ If everything was configured correctly, you should be able to type `mod` into yo
```bash
➜ mod

Moderne CLI 3.18.7
Moderne CLI 3.18.8

Usage:

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

Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Listing available JDKs

Expand Down
10 changes: 5 additions & 5 deletions user-documentation/workshops/air-gapped-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Here is what the results look like if everything ran correctly:
```bash
➜ mod git clone csv ./spring-data repos.csv --filter=tree:0

Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Reading CSV file

Expand Down Expand Up @@ -200,7 +200,7 @@ Notice that you didn't need to configure Maven or Gradle, select Java versions,
```bash
➜ mod build ./spring-data

Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

Expand Down Expand Up @@ -255,7 +255,7 @@ To view the diff, you can command + click on the file (or ctrl + click if on Win
```bash
➜ mod run ./spring-data --recipe CommonStaticAnalysis

Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

Expand Down Expand Up @@ -329,7 +329,7 @@ MOD SUCCEEDED in (2m 6s)
```bash
➜ mod run ./spring-data --recipe UpgradeToJava17

Moderne CLI 3.18.7
Moderne CLI 3.18.8

> Selecting repositories

Expand Down Expand Up @@ -422,7 +422,7 @@ You should see:
```bash
➜ mod study ./spring-data --last-recipe-run --data-table SourcesFileResults

Moderne CLI 3.18.7
Moderne CLI 3.18.8

Found recipe run 20240430092847-434iK

Expand Down
Loading

0 comments on commit e1fc964

Please sign in to comment.