### Create Nx Ktor Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-ktor/README.md

Command to initialize a new Nx workspace with Ktor support. It guides the user through the setup process.

```bash
npx create-nx-ktor your-workspace-name
```

--------------------------------

### Nx Workspace Setup

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Instructions for setting up a new Nx workspace if you haven't already.

```bash
# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace
```

--------------------------------

### Create Nx Spring Boot Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-spring-boot/README.md

Command to initiate the creation of a new Nx workspace with Spring Boot support. The CLI guides the user through the setup process.

```shell
npx create-nx-spring-boot your-workspace-name
```

--------------------------------

### Melos Configuration Example

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

A basic example of a melos.yaml configuration file, typically generated by the nx-melos:init command.

```yaml
# Example melos.yaml content (structure may vary)
name: nxrocks-monorepo

packages:
  - "packages/*"
  - "apps/*"

sdkPath: "/usr/local/bin/dart"

```

--------------------------------

### Install Project Artifacts

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Installs the project's artifacts to the local Maven repository using the `install` executor.

```bash
nx install bootapp
```

--------------------------------

### Install Project Artifacts to Local Maven Repository

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Installs the project's artifacts into the local Maven repository (`~/.m2/repository`) using the `install` executor.

```bash
nx install your-micronaut-app
```

--------------------------------

### Create Nx Flutter Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-flutter/README.md

Execute the create-nx-flutter CLI to initiate the creation of a new Nx workspace with Flutter support. The command guides the user through the setup process.

```bash
npx create-nx-flutter your-workspace-name
```

--------------------------------

### Nx Workspace Setup

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Instructions for creating a new Nx workspace using the standard Nx CLI with either npm or yarn.

```bash
# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace
```

--------------------------------

### Flutter Pub Get Executor

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-flutter/README.md

Fetches and installs dependencies listed in the 'pubspec.yaml' file. Corresponds to 'flutter pub get'.

```bash
$ nx pub-get your-flutterapp
```

--------------------------------

### Installing Quarkus Project Artifacts

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Command to install a Quarkus project's artifacts into the local Maven repository using the 'install' executor.

```bash
nx install your-quarkus-app
```

--------------------------------

### Create Nx Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Creates a new Nx workspace using the Nx CLI, which is a prerequisite for installing and using the nx-ktor plugin.

```bash
# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace
```

--------------------------------

### Running Micronaut Project in Dev Mode

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Shows how to execute the 'run', 'dev', or 'serve' executors to start the Micronaut application in development mode.

```bash
nx run your-micronaut-app:run

// or
nx serve your-micronaut-app
```

--------------------------------

### Install Ktor Project Artifacts

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for installing the project's artifacts to the local Maven repository (`~/.m2/repository`). The plugin automatically adds a task dependency to dependent library projects' `install` executor.

```bash
nx install your-ktor-app
```

--------------------------------

### Create Nx Workspace with nx-quarkus CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Uses a custom CLI to create a new Nx workspace with the nx-quarkus plugin pre-installed, simplifying the setup process.

```bash
# npm
npx create-nx-quarkus@latest

# yarn
yarn create nx-quarkus
```

--------------------------------

### Install nx-ktor Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Installs the nx-ktor Nx plugin into your Nx workspace using either npm or yarn package managers.

```bash
# npm
npm install @nxrocks/nx-ktor --save-dev

# yarn
yarn add @nxrocks/nx-ktor --dev
```

--------------------------------

### Create Nx Micronaut Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-micronaut/README.md

Command to execute the create-nx-micronaut CLI to generate a new Nx workspace with Micronaut support. The CLI guides the user through the creation process.

```bash
npx create-nx-micronaut your-workspace-name
```

--------------------------------

### Initialize Melos in Nx Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

Initializes Melos support in your Nx workspace by running the nx generate command. This command installs melos globally, creates a melos.yaml configuration file, and adds root-level NPM scripts for Melos commands.

```bash
nx g @nxrocks/nx-melos:init
```

--------------------------------

### Install nx-spring-boot Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Installs the nx-spring-boot plugin into your Nx workspace using either npm or yarn package managers.

```bash
# npm
npm install @nxrocks/nx-spring-boot --save-dev

# yarn
yarn add @nxrocks/nx-spring-boot --dev
```

--------------------------------

### Install nx-micronaut Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Installs the nx-micronaut plugin as a development dependency in your Nx workspace using either npm or yarn.

```bash
# npm
npm install @nxrocks/nx-micronaut --save-dev

# yarn
yarn add @nxrocks/nx-micronaut --dev
```

--------------------------------

### List Extensions in Quarkus Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Lists the available or installed extensions for the Quarkus project.

```shell
nx list-extensions your-quarkus-app
```

--------------------------------

### Configure Build Image Arguments

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Example configuration in `workspace.json` to pass custom arguments to the `build-image` executor.

```json
{
  "version": 1,
  "projects": {
    "bootapp": {
      "projectType": "application",
      "root": "path/to/bootapp",
      "sourceRoot": "path/to/bootapp/src",
      "targets": {
        "build-image": {
          "executor": "@nxrocks/nx-spring-boot:build-image",
          "options": {
            "root": "path/to/bootapp",
            "args": [
              "--executor=gcr.io/paketo-buildpacks/executor:base-platform-api-0.3",
              "--runImage=my-image"
            ]
          }
        }
      }
    }
  },
  "cli": {
    "defaultCollection": "@nx/workspace"
  }
}
```

--------------------------------

### Running Quarkus Project in Dev Mode

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Examples of how to run a Quarkus project in development mode using the 'serve' or 'dev' executors.

```bash
nx serve your-quarkus-app

// or

nx dev your-quarkus-app
```

--------------------------------

### Display create-nx-ktor Help

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-ktor/README.md

Command to view all available options and usage information for the create-nx-ktor CLI.

```bash
npx create-nx-ktor --help
```

--------------------------------

### Display create-nx-micronaut Help

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-micronaut/README.md

Command to display the available options and usage information for the create-nx-micronaut CLI.

```bash
npx create-nx-micronaut --help
```

--------------------------------

### Display create-nx-flutter Help Information

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-flutter/README.md

Run this command to view all available options and usage instructions for the create-nx-flutter CLI.

```bash
npx create-nx-flutter --help
```

--------------------------------

### Display Help for create-nx-spring-boot

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-spring-boot/README.md

Command to view all available options and usage information for the create-nx-spring-boot CLI.

```shell
npx create-nx-spring-boot --help
```

--------------------------------

### View create-nx-quarkus Help Options

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-quarkus/README.md

Display available command-line options for the create-nx-quarkus CLI to customize workspace creation.

```bash
npx create-nx-quarkus --help
```

--------------------------------

### Create Nx Spring Boot Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/images/create-pkg-full.txt

Initializes a new Nx workspace with Spring Boot capabilities. Prompts the user for workspace name, Nx Wrapper usage, and Nx Cloud integration.

```bash
npx --yes create-nx-spring-boot

# Prompts:
# What is the name of your workspace (e.g. org name)? myorg
# Would you like to use Nx Wrapper? Yes
# Would you like to use Nx Cloud? Yes

# Output:
# Successfully created the workspace: myorg
# Your workspace in /workspaces/nxrocks/myorg is all set 🎉. Let's goooooo! 🚀

# Next steps:
# - Go to [ @nxrocks/nx-spring-boot ] to get started with Nx and Spring Boot plugin.
# - Run   [ ./nx g @nxrocks/nx-spring-boot:project ] to add more projects.
# - Go to [ Nx Wrapper ] to get started with Nx Wrapper.
# - Go to [ Nx.dev ] to get started with Nx.
```

--------------------------------

### Create Nx Ktor Workspace CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Uses the custom create-nx-ktor CLI to quickly set up a new Nx workspace with the nx-ktor plugin pre-installed.

```bash
# npm
npx create-nx-ktor@latest
# or
# yarn
yarn create nx-ktor
```

--------------------------------

### Install nx-melos Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

Installs the nx-melos plugin as a development dependency in your Nx workspace using either npm or yarn.

```bash
# npm
npm install @nxrocks/nx-melos --save-dev

# yarn
yarn add @nxrocks/nx-melos --dev
```

--------------------------------

### Build Ktor Application

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for building a Ktor application. This command compiles the project and prepares it for deployment.

```bash
nx build your-ktor-app
```

--------------------------------

### Install nx-quarkus Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Installs the nx-quarkus plugin as a development dependency in your Nx workspace using either npm or yarn.

```bash
# npm
npm install @nxrocks/nx-quarkus --save-dev

# yarn
yarn add @nxrocks/nx-quarkus --dev
```

--------------------------------

### Building a Spring Boot Project with Nx

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Shows how to use the `build` executor to package a Spring Boot project into an executable Jar or War file using the Nx CLI.

```bash
nx build bootapp
```

--------------------------------

### Install nx-flutter Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-flutter/README.md

Installs the nx-flutter plugin as a development dependency in your Nx workspace using either npm or yarn.

```bash
# npm
npm install @nxrocks/nx-flutter --save-dev

# yarn
yarn add @nxrocks/nx-flutter --dev
```

--------------------------------

### Building Micronaut Application

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Demonstrates how to use the 'build' executor to package the Micronaut application.

```bash
nx build your-micronaut-app
```

--------------------------------

### Running a Spring Boot Project with Nx

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Demonstrates how to execute the `run` or `serve` executor for a Spring Boot application using the Nx CLI. It also shows the configuration in `workspace.json` to pass custom arguments.

```bash
nx run bootapp:run

// or its shorter alias

nx serve bootapp
```

```json
{
  "version": 1,
  "projects": {
    "bootapp": {
      "projectType": "application",
      "root": "path/to/bootapp",
      "sourceRoot": "path/to/bootapp/src",
      "targets": {
        "run": { 
          "executor": "@nxrocks/nx-spring-boot:run",
          "options": {
            "root": "path/to/bootapp",
            "args": ["arg1", "arg2"]
          }
        }
      }
    }},
  "cli": {
    "defaultCollection": "@nx/workspace"
  }
}
```

--------------------------------

### Build Quarkus Application

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Builds the Quarkus application. The plugin automatically adds a task dependency to the `install` executor for dependent library projects, ensuring they are installed in the local Maven repository before building.

```shell
nx build your-quarkus-app
```

--------------------------------

### Create Nx Ktor CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

CLI to create Nx workspaces with built-in support for Ktor projects.

```en
create-nx-ktor
```

--------------------------------

### Nx Ktor Link Generator Arguments

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Explains the command-line arguments for the Nx Ktor `link` generator, specifying the source and target project names for linking.

```bash
<sourceProjectName> // The name of the source(Ktor) project to link from. Can also be provided as option --sourceProjectName
<targetProjectName> // The name of the target project to link to. Can also be provided as option --targetProjectName
```

--------------------------------

### Nx Ktor Link Generator CLI Commands

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Demonstrates how to use the Nx Ktor `link` generator via the command line, including basic usage, aliased commands, and passing options directly.

```bash
nx g @nxrocks/nx-ktor:link
nx g @nxrocks/nx-ktor:link-project
```

```bash
nx g @nxrocks/nx-ktor:link --sourceProjectName <your-ktor-app> --targetProjectName <your-other-app>
```

```bash
nx g @nxrocks/nx-ktor:link  <your-ktor-app>  <your-other-app>
```

--------------------------------

### Create Nx Workspace with nx-micronaut

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Creates a new Nx workspace with the nx-micronaut plugin pre-installed using a custom CLI.

```bash
# npm
npx create-nx-micronaut@latest
# or
# yarn
yarn create nx-micronaut
```

--------------------------------

### Build Docker Image for Ktor Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for building a Docker image for the Ktor project. This prepares the application for containerization.

```bash
nx build-image your-ktor-app
```

--------------------------------

### Create Nx Spring Boot Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/images/create-pkg.txt

This snippet demonstrates the interactive process of creating a new Nx workspace configured for Spring Boot. It prompts the user for workspace name and choices regarding Nx Wrapper and Nx Cloud.

```bash
$ npx create-nx-spring-boot

┌  create-nx-spring-boot
│
◇  What is the name of your workspace (e.g. org name)?
│  myorg
│
◇  Would you like to use Nx Wrapper? [ Nx Wrapper ]
│  Yes
│
◇  Would you like to use Nx Cloud? [ Nx Cloud ]
│  Yes
│
(#########⠂⠂⠂⠂⠂⠂⠂⠂⠂) ⠏ Installing dependencies
```

--------------------------------

### Format Ktor Project Code

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executors for formatting the Ktor project's code. Use `nx run your-ktor-app:format` or `nx apply-format your-ktor-app`. Note: `nx format your-ktor-app` is not supported due to conflict with Nx CLI's native format command.

```bash
nx run your-ktor-app:format

// or simply

nx apply-format your-ktor-app
```

--------------------------------

### NxRocks Project Generation Options

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Defines the available options for generating new projects with NxRocks. These options control various aspects of the project setup, including its type, build system, language, and organizational details.

```APIDOC
Arguments:
  <directory>: The directory of the new project.

Options:
  projectType: Type of project to generate (application | library)
  buildSystem: Build system to use (maven-project | gradle-project)
  packaging: Packaging format (jar | war)
  javaVersion: Java version to use (8 | 11 | 15)
  language: Programming language (java | groovy | kotlin)
  groupId: GroupId of the project (string)
  artifactId: ArtifactId of the project (string)
  packageName: Main package name (string)
  description: Description of the project (string)
  skipFormat: Boolean to skip code formatting (using Spotless plugin)
  dependencies: Comma-separated list of dependencies (refer to recipes for details)
  transformIntoMultiModule: Boolean to transform into a multi-module project (refer to recipes for details)
  addToExistingParentModule: Boolean to add to an existing parent module (refer to recipes for details)
  parentModuleName: Name of the parent module (refer to recipes for details)
  keepProjectLevelWrapper: Boolean to keep wrapper files in child projects (refer to recipes for details)
```

--------------------------------

### NxRocks Melos Plugin Nx Compatibility

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

Provides a compatibility matrix between different versions of the NxRocks Melos plugin and Nx Workspace versions. This helps users determine the correct plugin version for their Nx setup.

```APIDOC
Plugin Version | Nx Workspace version
-------------- | --------------------
>=v3.x.x     | >=v17.x.x
>=v2.x.x     | >=v16.x.x
>=v1.x.x     | >=v15.3.x
```

--------------------------------

### Nx Micronaut Link Generator Usage

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Demonstrates how to use the Nx Micronaut link generator to link projects. It shows the basic command, aliases, and how to pass options directly or via arguments.

```bash
nx g @nxrocks/nx-micronaut:link
nx g @nxrocks/nx-micronaut:link-project
nx g @nxrocks/nx-micronaut:link --sourceProjectName <your-micronaut-app> --targetProjectName <your-other-app>
nx g @nxrocks/nx-micronaut:link <your-micronaut-app> <your-other-app>
```

--------------------------------

### Nx Quarkus Compatibility Matrix

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-quarkus/README.md

Compatibility table showing which versions of create-nx-quarkus work with specific Nx Workspace versions.

```json
{
  "Package Version": "Nx Workspace version",
  ">=v4.0.0": ">=v20.0.0",
  ">=v3.0.0": ">=v17.3.0",
  "<v3.0.0": "<17.3.0"
}
```

--------------------------------

### Executing Melos Command with Nx

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

Demonstrates how to execute a `melos` command, specifically `bootstrap --since=main`, using Nx commands via `npx` or `yarn`.

```bash
$ melos bootstrap --since=main

becomes 👉🏾

$ npx nx melos-bootstrap --since=main
// or
$ yarn nx melos-bootstrap --since=main
```

--------------------------------

### Format Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Formats the project using the `format` executor or `apply-format` command. Note: `nx format bootapp` is not supported due to conflict with Nx CLI's native command.

```bash
nx run bootapp:format

// or simply

nx apply-format bootapp
```

--------------------------------

### Format Quarkus Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Formats the Quarkus project code. This can be done using the `format` executor or its alias `apply-format`. Note that `nx format your-boot-app` syntax is not supported due to potential conflicts with Nx CLI's native `format` command.

```shell
nx run your-quarkus-app:format
```

```shell
nx apply-format your-quarkus-app
```

--------------------------------

### Create Nx Quarkus CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

CLI to create Nx workspaces with built-in support for Quarkus projects.

```en
create-nx-quarkus
```

--------------------------------

### Run Ktor Project in Dev Mode

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executors for running a Ktor project in development mode. Use `nx run your-ktor-app:run` or `nx serve your-ktor-app`.

```bash
nx run your-ktor-app:run

// or
nx serve your-ktor-app
```

--------------------------------

### NxRocks Project Generation Options

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Defines the available arguments and options for generating new projects with NxRocks. This includes project structure, build system, Ktor version, and feature enablement.

```APIDOC
Arguments:
  <directory>: The directory of the new project.

Options:
  buildSystem: Build system (MAVEN | GRADLE | GRADLE_KTS)
  groupId: Group Id of the project (string)
  artifactId: Artifact Id of the project (string)
  kotlinVersion: Kotlin version to use (string)
  engine: Engine to use to serve the application (NETTY | JETTY | CIO | TOMCAT)
  configurationLocation: Configuratin Location to use (YAML | HOCON | CODE)
  skipFormat: Do not add the ability to format code (using Spotless plugin) (boolean)
  skipCodeSamples: Do not generate code samples (boolean)
  features: List of features to use (comma-separated). Go to recipes for more information (string)
  transformIntoMultiModule: Transform the project into a multi-module project. Go to recipes for more information (boolean)
  addToExistingParentModule: Add the project into an existing parent module project. Go to recipes for more information (boolean)
  parentModuleName: Name of the parent module to create or to add child project into. Go to recipes for more information (string)
  keepProjectLevelWrapper: Keep the Maven or Gradle wrapper files from child project (when generating a multi-module project). Go to recipes for more information (boolean)
  ktorVersion: Ktor version to use (string)
  ktorInitializrUrl: URL to the Ktor Start instance to use (https://start.ktor.io)
```

--------------------------------

### Create Nx Quarkus Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/create-nx-quarkus/README.md

Execute the create-nx-quarkus CLI to generate a new Nx workspace with Quarkus support. This command initiates an interactive process to set up your project.

```bash
npx create-nx-quarkus your-workspace-name
```

--------------------------------

### Nx Spring Boot Configuration Options

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Lists configuration options for the Nx Spring Boot project, including Spring Initializer URL, proxy settings, Boot version, tags, and directory.

```json
{
  "springInitializerUrl": "https://start.spring.io",
  "proxyUrl": "string",
  "bootVersion": "string",
  "tags": "string",
  "directory": "string"
}
```

--------------------------------

### Create Nx Flutter Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-flutter/README.md

Creates a new Nx workspace with the nx-flutter plugin pre-installed using a custom CLI.

```bash
# npm
npx create-nx-flutter@latest
# or
# yarn
yarn create nx-flutter
```

--------------------------------

### Test Ktor Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for running tests for the Ktor project. This command executes the project's test suite.

```bash
nx test your-ktor-app
```

--------------------------------

### Create Nx Spring Boot CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

CLI to create Nx workspaces with built-in support for Spring Boot projects.

```en
create-nx-spring-boot
```

--------------------------------

### Nx Ktor Executors Overview

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Provides a summary of available Nx Ktor executors and their functionalities. Each executor can optionally take arguments to customize its behavior, such as ignoring the wrapper or passing arguments to the underlying build tools.

```APIDOC
Executor: run | serve
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Runs the project in dev mode using either ./mvnw|mvn exec:java or ./gradlew|gradle runFatJar

Executor: build
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Packages the project using either ./mvnw|mvn package or ./gradlew|gradle buildFatJar

Executor: install
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Installs the project's artifacts to local Maven repository (in ~/.m2/repository) using either ./mvnw|mvn install or ./gradlew|gradle publishToMavenLocal

Executor: test
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Tests the project using either ./mvnw|mvn test or ./gradlew|gradle test

Executor: clean
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Cleans the project using either ./mvnw|mvn clean or ./gradlew|gradle clean

Executor: format
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Format the project using Spotless plugin for Maven or Gradle

Executor: build-image
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Generates an OCI Image using either ./mvnw|mvn docker:build or ./gradlew|gradle buildImage

Executor: publish-image
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Builds the project into a Docker image and publishes it to an external registry using either ./mvnw|mvn docker:push or ./gradlew|gradle publishImage

Executor: publish-image-locally
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Builds the project into a Docker image and publishes it to local registry using either ./mvnw|mvn docker:push or ./gradlew|gradle publishImageToLocalRegistry

Executor: run-docker
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Builds the project into a Docker image and runs it using either ./mvnw|mvn docker:run or ./gradlew|gradle rundDocker
```

--------------------------------

### Publish Docker Image for Ktor Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for publishing the Docker image. The plugin automatically adds a dependency to the `build-image` executor.

```bash
nx publish-image your-ktor-app
```

--------------------------------

### Passing Arguments to Nx Ktor Executors

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Demonstrates how to pass additional arguments to the underlying Maven or Gradle commands executed by Nx Ktor. Arguments can be passed temporarily via the command line or permanently by configuring the `workspace.json` file.

```bash
nx run your-ktor-app --args="-Dpackaging=docker-native"
```

```json
{
  "version": 1,
  "projects": {
    "your-ktor-app": {
      "projectType": "application",
      "root": "apps/your-ktor-app",
      "sourceRoot": "apps/your-ktor-app/src",
      "targets": {
        "dockerfile": {
          "executor": "@nxrocks/nx-ktor:run-docker",
          "options": {
            "root": "apps/your-ktor-app",
            "args": ["-Dpackaging=docker-native"]// your additional args here
          }
        }
      }
    }}
  },
  "cli": {
    "defaultCollection": "@nx/workspace"
  }
}
```

--------------------------------

### Nx Ktor Link Generator Configuration Options

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Details the configuration options available for the Nx Ktor `link` generator, including proxy settings, tags for linting, and project directory.

```typescript
proxyUrl: string // The URL of the (corporate) proxy server to use to access Ktor Launch
tags: string // Tags to use for linting (comma-separated)
directory: string // Directory where the project is placed
```

--------------------------------

### Run Ktor Application from Docker Image

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for running the application from its Docker image. The plugin automatically adds a dependency to the `build-image` executor.

```bash
nx rund-docker your-ktor-app
```

--------------------------------

### Create Nx Spring Boot Workspace CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Uses a custom CLI to create a new Nx workspace with the nx-spring-boot plugin pre-installed.

```bash
# npm
npx create-nx-spring-boot@latest
# or
# yarn
yarn create nx-spring-boot
```

--------------------------------

### Generate Sample AOT Config File

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Generates a sample Ahead-Of-Time (AOT) configuration file for the Micronaut application using the `aot-sample-config` executor.

```bash
nx aot-sample-config your-micronaut-app
```

--------------------------------

### Melos Workspace Commands

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-melos/README.md

Lists the `melos` commands available as NPM scripts in the root `package.json` for managing packages. These commands facilitate workspace initialization, cleaning, execution of arbitrary commands, listing package information, publishing, running scripts, and versioning.

```bash
melos-bootstrap
melos-clean
melos-exec
melos-list
melos-publish
melos-run
melos-version
```

--------------------------------

### Create Nx Micronaut CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

CLI to create Nx workspaces with built-in support for Micronaut projects.

```en
create-nx-micronaut
```

--------------------------------

### Publish Docker Image Locally

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Executor for publishing the Docker image locally. The plugin automatically adds a dependency to the `build-image` executor.

```bash
nx publish-image-locally your-ktor-app
```

--------------------------------

### Create Nx Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-flutter/README.md

Creates a new Nx workspace using the standard Nx CLI.

```bash
# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace@latest
```

--------------------------------

### Nx Micronaut Executors Overview

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Lists the available executors for managing Micronaut applications within an Nx workspace, including their arguments and descriptions.

```APIDOC
Executor: run | dev | serve
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Runs the project in dev mode using either './mvnw|mvn micronaut:dev' or './gradlew|gradle micronautDev'.

Executor: dockerfile
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Generates a Dockerfile based on packaging and Micronaut runtime properties using './mvnw|mvn micronaut:dockerfile' or './gradlew|gradle dockerfile'.

Executor: build
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Packages the project using './mvnw|mvn package' or './gradlew|gradle build'.

Executor: install
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Installs the project's artifacts to the local Maven repository using './mvnw|mvn install' or './gradlew|gradle publishToMavenLocal'.

Executor: test
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Tests the project using './mvnw|mvn test' or './gradlew|gradle test'.

Executor: clean
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Cleans the project using './mvnw|mvn clean' or './gradlew|gradle clean'.

Executor: format
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Formats the project using the Spotless plugin for Maven or Gradle.

Executor: aotConfigSample
  Arguments: ignoreWrapper:boolean, runFromParentModule:boolean, args: string[]
  Description: Generates a sample aot.properties file using './mvnw|mvn package' or './gradlew|gradle package'.
```

--------------------------------

### Passing Arguments to Executors

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-quarkus/README.md

Demonstrates how to pass additional arguments to Maven or Gradle commands via the '--args' option or by configuring the workspace.json file.

```bash
nx remote-dev your-quarkus-app --args="-Dquarkus.live-reload.url=http://my-remote-host:8080"
```

```json
{
  "version": 1,
  "projects": {
    "your-quarkus-app": {
      "projectType": "application",
      "root": "apps/your-quarkus-app",
      "sourceRoot": "apps/your-quarkus-app/src",
      "targets": {
        "remote-dev": {
          "executor": "@nxrocks/nx-quarkus:remote-dev",
          "options": {
            "root": "apps/your-quarkus-app",
            "args": ["-Dquarkus.live-reload.url=http://my-remote-host:8080"]// your additional args here
          }
        }
      }
    }},
  "cli": {
    "defaultCollection": "@nx/workspace"
  }
}
```

--------------------------------

### Create Nx Workspace

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Creates a new Nx workspace using either npm or yarn.

```bash
# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace
```

--------------------------------

### Nx Ktor Plugin

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

Nx plugin for generating, running, packaging, and building Ktor projects within an Nx workspace.

```en
nx-ktor
```

--------------------------------

### Test Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-spring-boot/README.md

Runs tests for the project using the `test` executor.

```bash
nx test bootapp
```

--------------------------------

### Create Multi-Module Ktor Projects

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/recipes/README.md

Since v8.1.0, the NxRocks Ktor plugin supports creating multi-module projects with Maven or Gradle. You can either transform the current project into a multi-module one or add it to an existing multi-module project by setting specific options.

```markdown
To transform the current project into a multi-module project:
Set `transformIntoMultiModule` to `true`.
Provide the parent module name using `parentModuleName`.

To add the current project to an existing multi-module project:
Set `addToExistingParentModule` to `true`.
Provide the parent module name using `parentModuleName`.
```

--------------------------------

### Create Nx Flutter CLI

Source: https://github.com/tinesoft/nxrocks/blob/develop/README.md

CLI to create Nx workspaces with built-in support for Flutter projects.

```en
create-nx-flutter
```

--------------------------------

### Build Common Library

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/common/README.md

Builds the common library using the Nx build command.

```bash
nx build common
```

--------------------------------

### Test Project

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-micronaut/README.md

Executes tests for the specified Micronaut application using the `test` executor.

```bash
nx test your-micronaut-app
```

--------------------------------

### Nx Plugin Compatibility Matrix

Source: https://github.com/tinesoft/nxrocks/blob/develop/packages/nx-ktor/README.md

Compatibility matrix showing the relationship between Nx Rocks plugin versions and Nx Workspace versions.

```json
{
  ">=v5.x.x": ">=v20.x.x",
  ">=v4.x.x": ">=v18.x.x",
  ">=v3.x.x": ">=v17.x.x",
  ">=v2.x.x": ">=v16.x.x",
  ">=v1.x.x": ">=v15.8.x"
}
```