Arconia CLI

Welcome to Arconia CLI! This documentation will help you get started with the tool and explore its features.

What is Arconia CLI?

Arconia CLI is the companion command-line tool for the Spring Boot and Arconia Framework projects. It provides intuitive commands that streamline the entire development lifecycle: running applications in development mode with automatic service provisioning, building and testing, packaging as container images, and upgrading to newer versions of Spring Boot, Spring AI, and the Arconia Framework.

The Arconia CLI is currently in active development. We’re working hard to improve it and appreciate your patience as we continue to refine the tool. Feel free to try it out and share your feedback!

Quick Start

Install the Arconia CLI using one of the methods described in Installation.

To get started, view the available commands and options by running:

arconia help

You’ll see a summary of the main commands and options available in the CLI.

Usage: arconia [-hV] [COMMAND]
Options:
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.

Commands:
  dev, run         Run the application in development mode.
  build            Build the current project.
  test             Run tests for the current project.
  image            Build and manage container images.
  update, upgrade  Update project dependencies and build tool versions.
  rewrite          Run an OpenRewrite recipe to migrate or refactor your project.
  help             Display help information about the specified command.
  version          Display version information about the Arconia CLI.

Commands

Development

These commands wrap your build tool (Maven or Gradle) to provide a consistent, tool-agnostic developer experience:

arconia dev — Runs your application in development mode, activating the Arconia Framework’s dev Spring profile and automatically starting any declared Arconia Dev Services (databases, message brokers, AI inference servers, etc.) as containers. No boilerplate code required.
arconia build — Compiles, tests, and packages your application as a JAR or a GraalVM native executable.
arconia test — Runs your test suite, with Arconia Dev Services automatically provisioned for integration tests.

Container Images

arconia image build buildpacks — Builds a container image using Cloud Native Buildpacks and Paketo, without needing a Dockerfile.
arconia image build dockerfile — Builds a container image using a Dockerfile.

Updates

These commands use OpenRewrite recipes to automatically migrate your project with a single command:

arconia update spring-boot — Upgrades to a newer Spring Boot version.
arconia update spring-ai — Upgrades to a newer Spring AI version.
arconia update framework — Upgrades to a newer Arconia Framework version.
arconia update gradle — Upgrades the Gradle wrapper.
arconia update maven — Upgrades the Maven wrapper.

Migration

arconia rewrite — Runs any OpenRewrite recipe for custom migration or refactoring tasks beyond the built-in update commands.

Authors

The Arconia CLI is maintained by Thomas Vitale.